{"id":15413135,"url":"https://github.com/vesparny/brcast","last_synced_at":"2025-04-13T07:51:00.376Z","repository":{"id":37602513,"uuid":"87541371","full_name":"vesparny/brcast","owner":"vesparny","description":"Tiny data broadcaster with 0 dependencies","archived":false,"fork":false,"pushed_at":"2024-10-23T20:41:57.000Z","size":125,"stargazers_count":47,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-04T05:44:31.738Z","etag":null,"topics":["broadcast","data","emitter","event","pubsub"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vesparny.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-04-07T12:02:09.000Z","updated_at":"2024-08-12T10:51:11.000Z","dependencies_parsed_at":"2024-06-18T15:14:21.590Z","dependency_job_id":"a92a694f-34ad-4221-8685-74020b607d01","html_url":"https://github.com/vesparny/brcast","commit_stats":{"total_commits":39,"total_committers":3,"mean_commits":13.0,"dds":0.05128205128205132,"last_synced_commit":"b8e4726c1330e4db37fed46de53f212a4cfd5159"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vesparny%2Fbrcast","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vesparny%2Fbrcast/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vesparny%2Fbrcast/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vesparny%2Fbrcast/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vesparny","download_url":"https://codeload.github.com/vesparny/brcast/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248681494,"owners_count":21144700,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["broadcast","data","emitter","event","pubsub"],"created_at":"2024-10-01T16:55:36.758Z","updated_at":"2025-04-13T07:51:00.347Z","avatar_url":"https://github.com/vesparny.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Brcast\n\n\u003e Tiny data broadcaster with 0 dependencies\n\n[![Travis](https://img.shields.io/travis/vesparny/brcast.svg)](https://travis-ci.org/vesparny/brcast)\n[![Code Coverage](https://img.shields.io/codecov/c/github/vesparny/brcast.svg?style=flat-square)](https://codecov.io/github/vesparny/brcast)\n[![David](https://img.shields.io/david/vesparny/brcast.svg)](https://david-dm.org/vesparny/brcast)\n[![npm](https://img.shields.io/npm/v/brcast.svg)](https://www.npmjs.com/package/brcast)\n[![npm](https://img.shields.io/npm/dm/brcast.svg)](https://npm-stat.com/charts.html?package=brcast\u0026from=2017-04-01)\n[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)\n[![MIT License](https://img.shields.io/npm/l/brcast.svg?style=flat-square)](https://github.com/vesparny/brcast/blob/master/LICENSE)\n\nThe current size of `brcast/dist/brcast.umd.min.js` is:\n\n[![gzip size](http://img.badgesize.io/https://unpkg.com/brcast/dist/brcast.umd.min.js?compression=gzip\u0026label=gzip%20size\u0026style=flat-square)](https://unpkg.com/brcast/dist/)\n\nIt's like a data store you can subscribe to, with a setter to pump data in.\nFor browsers and node.\n\n## Table of Contents\n\n-   [Install](#install)\n-   [Usage](#usage)\n-   [API](#api)\n-   [Testing](#tests)\n-   [License](#license)\n\n## Install\n\nThis project uses [node](http://nodejs.org) and [npm](https://npmjs.com). Go check them out if you don't have them locally installed.\n\n```sh\n$ npm install --save brcast\n```\n\nThen with a module bundler like [rollup](http://rollupjs.org/) or [webpack](https://webpack.js.org/), use as you would anything else:\n\n```javascript\n// using ES6 modules\nimport brcast from 'brcast'\n\n// using CommonJS modules\nvar brcast = require('brcast')\n```\n\nThe [UMD](https://github.com/umdjs/umd) build is also available on [unpkg](https://unpkg.com):\n\n```html\n\u003cscript src=\"https://unpkg.com/brcast/dist/brcast.umd.js\"\u003e\u003c/script\u003e\n```\n\nYou can find the library on `window.brcast`.\n\n## Usage\n\n```js\nimport brcast from 'brcast'\n\nlet broadcast = brcast()\n\n// subscribe\nconst subscriptionId = broadcast.subscribe(state =\u003e console.log(state))\n\n// setState sets the state and invoke all subscription callbacks passing in the state\nbroadcast.setState(1)\n\n// setState returns the current state\nbroadcast.getState()\n\n// unsubscribe to unbind the handler\nbroadcast.unsubscribe(subscriptionId)\n```\n\n## API\n\n### `brcast([initialState])`\n\nCreates a `broadcast` object.\n\n#### Arguments\n\n1 - [`initialState`] *(any)*: The initial state.\n\n#### Returns\n\n(`broadcast`): An object that holds the state.\n\n### `broadcast.setState(state)`\n\nStore the new state.\n\n#### Arguments\n\n1 - `state` *(any)*: The new state.\n\n#### Returns\n\nNothing.\n\n### `broadcast.getState()`\n\nGet the stored state.\n\n#### Returns\n\n(`Any`): The stored state.\n\n### `broadcast.subscribe(handler)`\n\nSubscribe to state changes.\n\n#### Arguments\n\n1 - `handler` *(Function)*: The callback to be invoked any time the state changes.\n\n#### Returns\n\n(`Number`): The subscription id to be used to unsubscribe.\n\n### `broadcast.unsubscribe(subscriptionId)`\n\nUnsubscribe the change listener.\n\n#### Arguments\n\n1 - `subscriptionId` *(Number)*: The subscription id returned by subscribing.\n\n#### Returns\n\nNothing.\n\n## Tests\n\n```sh\n$ npm run test\n```\n\n\n[MIT License](LICENSE.md) © [Alessandro Arnodo](https://alessandro.arnodo.net/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvesparny%2Fbrcast","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvesparny%2Fbrcast","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvesparny%2Fbrcast/lists"}