{"id":15357261,"url":"https://github.com/gera2ld/cache-async-fn","last_synced_at":"2025-03-04T19:46:05.538Z","repository":{"id":216765366,"uuid":"742270985","full_name":"gera2ld/cache-async-fn","owner":"gera2ld","description":null,"archived":false,"fork":false,"pushed_at":"2024-03-18T10:14:40.000Z","size":6,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-15T05:52:53.426Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gera2ld.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2024-01-12T05:27:46.000Z","updated_at":"2024-01-12T05:47:25.000Z","dependencies_parsed_at":"2024-01-12T17:49:46.064Z","dependency_job_id":"4306a840-d006-4000-8b2e-b3e104984cda","html_url":"https://github.com/gera2ld/cache-async-fn","commit_stats":{"total_commits":6,"total_committers":1,"mean_commits":6.0,"dds":0.0,"last_synced_commit":"7a0e7aeb199af6756afe28424111ce288d650464"},"previous_names":["gera2ld/cache-async-fn"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gera2ld%2Fcache-async-fn","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gera2ld%2Fcache-async-fn/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gera2ld%2Fcache-async-fn/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gera2ld%2Fcache-async-fn/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gera2ld","download_url":"https://codeload.github.com/gera2ld/cache-async-fn/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241913788,"owners_count":20041459,"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-01T12:34:18.307Z","updated_at":"2025-03-04T19:46:05.511Z","avatar_url":"https://github.com/gera2ld.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cache-async-fn\n\n[![npm version][npm-version-src]][npm-version-href]\n[![npm downloads][npm-downloads-src]][npm-downloads-href]\n[![bundle][bundle-src]][bundle-href]\n[![JSDocs][jsdocs-src]][jsdocs-href]\n\n## Usage\n\n### Initialization\n\nWith MobX:\n\n```ts\nimport { observable } from 'mobx';\nimport { cacheAsyncFactory } from 'cache-async-fn';\n\nfunction createCache\u003cT\u003e() {\n  const target = observable\u003c{ value: Record\u003cstring, T | undefined\u003e }\u003e(\n    { value: {} },\n    {\n      value: observable.ref,\n    },\n  );\n  return {\n    get(cacheKey: string) {\n      return target.value[cacheKey];\n    },\n    set(cacheKey: string, data?: T) {\n      target.value = {\n        ...target.value,\n        [cacheKey]: data,\n      };\n    },\n    clear() {\n      target.value = {};\n    },\n  };\n}\n\nconst { cacheAsync } = cacheAsyncFactory(createCache);\n```\n\nWith Vue:\n\n```ts\nimport { ref } from 'vue';\nimport { cacheAsyncFactory } from 'cache-async-fn';\n\nfunction createCache\u003cT\u003e() {\n  const target = ref\u003cRecord\u003cstring, T | undefined\u003e\u003e({});\n  return {\n    get(cacheKey: string) {\n      return target.value[cacheKey];\n    },\n    set(cacheKey: string, data?: T) {\n      target.value = {\n        ...target.value,\n        [cacheKey]: data,\n      };\n    },\n    clear() {\n      target.value = {};\n    },\n  };\n}\nconst { cacheAsync } = cacheAsyncFactory(createCache);\n```\n\n### Cache APIs\n\n```ts\nconst myApi = cacheAsync(myApiCall, {\n  resolver: (params) =\u003e [groupKey, cacheKey],\n});\n\n// Call from anywhere\nasync function someAction() {\n  const response = await myApi(params);\n}\n\n// Get the current value anytime\nfunction getValueSync() {\n  return myApi.get(params);\n}\n```\n\nEach `groupKey` has its own cache. The cache is invalidated when the `cacheKey` changes.\n\n## Use Cases\n\n### Load once globally\n\nThis is the default behavior.\n\n```ts\nconst loadOnceGlobally = cacheAsync(api);\n// or\nconst loadOnceGlobally = cacheAsync(api, {\n  resolver: () =\u003e '',\n});\n```\n\n### Load on param change\n\n```ts\nconst loadOnParamChange = cacheAsync(api, {\n  resolver: (params) =\u003e ['', JSON.stringify(params)],\n});\n```\n\n### Cache data for multiple tabs\n\nThe data for each tab will be cached in a different group, with the parameters as its cache key.\n\n```ts\nconst loadOnParamChange = cacheAsync(api, {\n  resolver: (params) =\u003e [params.tab, JSON.stringify(params)],\n});\n```\n\n[npm-version-src]: https://img.shields.io/npm/v/cache-async-fn?style=flat\u0026colorA=18181B\u0026colorB=F0DB4F\n[npm-version-href]: https://npmjs.com/package/cache-async-fn\n[npm-downloads-src]: https://img.shields.io/npm/dm/cache-async-fn?style=flat\u0026colorA=18181B\u0026colorB=F0DB4F\n[npm-downloads-href]: https://npmjs.com/package/cache-async-fn\n[bundle-src]: https://img.shields.io/bundlephobia/minzip/cache-async-fn?style=flat\u0026colorA=18181B\u0026colorB=F0DB4F\n[bundle-href]: https://bundlephobia.com/result?p=cache-async-fn\n[jsdocs-src]: https://img.shields.io/badge/jsDocs.io-reference-18181B?style=flat\u0026colorA=18181B\u0026colorB=F0DB4F\n[jsdocs-href]: https://www.jsdocs.io/package/cache-async-fn\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgera2ld%2Fcache-async-fn","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgera2ld%2Fcache-async-fn","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgera2ld%2Fcache-async-fn/lists"}