{"id":15601170,"url":"https://github.com/hacknlove/substore","last_synced_at":"2025-02-26T07:29:34.844Z","repository":{"id":35085335,"uuid":"202767426","full_name":"hacknlove/substore","owner":"hacknlove","description":null,"archived":false,"fork":false,"pushed_at":"2023-01-04T07:44:20.000Z","size":868,"stargazers_count":2,"open_issues_count":13,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-27T01:03:42.597Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hacknlove.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-08-16T17:00:27.000Z","updated_at":"2024-04-25T02:51:29.000Z","dependencies_parsed_at":"2023-01-15T13:31:31.850Z","dependency_job_id":null,"html_url":"https://github.com/hacknlove/substore","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hacknlove%2Fsubstore","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hacknlove%2Fsubstore/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hacknlove%2Fsubstore/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hacknlove%2Fsubstore/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hacknlove","download_url":"https://codeload.github.com/hacknlove/substore/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240810812,"owners_count":19861310,"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":[],"created_at":"2024-10-03T02:19:10.959Z","updated_at":"2025-02-26T07:29:34.817Z","avatar_url":"https://github.com/hacknlove.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# substore\n![coverage 100%](https://img.shields.io/badge/coverage-100%25-brightgreen)\n\nDecouple your storage more and better.\n\n## install\n```\nnpm i @hacknlove/substore\n```\n\n## Api\n\nAll `key` can be `'deep.dotted.key'`.\nsee [@hacknlove/deepobject](https://github.com/hacknlove/deepObject)\n\n### `subStore(key)`\n\nReturns the substore at `key`.\n\nIf there is a substore at that `key`, it returns that substore. If not, it creates a new one.\n\nThe substore methods mimic the store methods.\n\n```javascript\nconst store = require('@hacknlove/reduxplus')\nrequire('@hacknlove/substore')\n\nconst MySubStore1 = store.subStore('someKey')\nassert(MySubstore1.i === 1)\n\nconst MySubStore2 = store.subStore('someKey')\nassert(MySubstore1.i === 2)\nassert(MySubStore1 === MySubStore2)\n\nconst MySubStore3 = store.subStore('otherKey')\nassert(MySubStore1 !== MySubStore3)\nassert(MySubstore3.i === 1)\n```\n\n### `substore.getState()`\nReturns the state of the substore\n\n### `substore.setReducer(reducer)`\nSet a reducer to that substore, to process the actions dispatched in the substore.\n\n### `substore.dispatch(action)`\nDispatch an action in the substore, that will be processed by the reducers of the substore.\n\n### `substore.useRedux()`\nReact hook that refresh when the state of the substore changes.\n\n### `substore.useRedux(key)`\nReact hook that refresh when the substore's state's value at `key` changes.\n\n### `substore.hydrate(state, replace = false)\nIt set the store's state.\n\nIf `replace === true`, it replaces the old state with the new one.\nIf `replace !== true`, it replaces the old state with the merge of the new one in the old one.\n\n### `substore.subscribe(callback)`\nReturns a unsubscribe function.\n\nThe callback is called each time the substore's state changes, until unsubscribe funcion is called.\n\n### `substore.subscribeKey(key, callback)`\nReturns a unsubscribe function.\n\nThe callback is called each time the substore's state's value at `key` changes, until unsubscribe funcion is called.\n\n### `substore.clean()`\nIf this is the last substore at its `key`, it removes all subscriptions, all reducers, stop all useRedux hooks and cleans all substore's substores. After that every substore method will throw `new Error('subStore cleaned')`\n\n### `substore.clean(true)`\nIf this is the last substore at its `key`, it all, including the state\n\n### substore.subStore(key)\nit returns a new substore at `${substore.key}.${key}` that will be cleaned when the parent substore is cleaned.\n\n### `substore.setMiddleware` is undefined\nYou cannot set a middleware to a substore.\n\n## redux DevTools\n\nYou will see the subStore actions as `ºkey/type`\n\n```javascript\nconst substore = store.subStore('foo.bar')\n\nsubstore.dispatch({\n  type: 'buz',\n  some: {\n    more: 'things'\n  }\n})\n\n/*\nstore.dispatch({\n  type: 'ºfoo.bar/buz',\n  key: 'foo.bar'\n  subAction: {\n    type: 'buz',\n    some: {\n      more: 'things'\n    }\n  }\n})\n*/\n```\n\n\n\n## asciinema\n[![asciicast](https://asciinema.org/a/265652.svg)](https://asciinema.org/a/265652)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhacknlove%2Fsubstore","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhacknlove%2Fsubstore","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhacknlove%2Fsubstore/lists"}