{"id":13450884,"url":"https://github.com/octet-stream/use-suspender","last_synced_at":"2026-03-06T08:32:47.209Z","repository":{"id":37481460,"uuid":"238912147","full_name":"octet-stream/use-suspender","owner":"octet-stream","description":"Wraps asynchronous function allowing to use it with React.Suspense","archived":false,"fork":false,"pushed_at":"2024-09-18T12:14:49.000Z","size":944,"stargazers_count":17,"open_issues_count":2,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-07-03T01:37:39.565Z","etag":null,"topics":["async","javascript","javascript-library","preact","promise","react","react-hooks","react-suspense"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/use-suspender","language":"TypeScript","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/octet-stream.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-02-07T12:03:22.000Z","updated_at":"2024-09-18T12:14:53.000Z","dependencies_parsed_at":"2024-10-28T21:49:28.667Z","dependency_job_id":null,"html_url":"https://github.com/octet-stream/use-suspender","commit_stats":{"total_commits":242,"total_committers":3,"mean_commits":80.66666666666667,"dds":0.02066115702479343,"last_synced_commit":"dc52ae1307d9202704f305d8c00902f386a2f51d"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/octet-stream/use-suspender","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octet-stream%2Fuse-suspender","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octet-stream%2Fuse-suspender/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octet-stream%2Fuse-suspender/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octet-stream%2Fuse-suspender/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/octet-stream","download_url":"https://codeload.github.com/octet-stream/use-suspender/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octet-stream%2Fuse-suspender/sbom","scorecard":{"id":701677,"data":{"date":"2025-08-11","repo":{"name":"github.com/octet-stream/use-suspender","commit":"05fdeb29aa2b4f297ca4bb12d8e6363d3a8dafbd"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.5,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/ci.yml:1","Warn: no topLevel permission defined: .github/workflows/typescript.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Code-Review","score":0,"reason":"Found 0/22 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/octet-stream/use-suspender/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/octet-stream/use-suspender/ci.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/octet-stream/use-suspender/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/octet-stream/use-suspender/ci.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:64: update your workflow using https://app.stepsecurity.io/secureworkflow/octet-stream/use-suspender/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typescript.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/octet-stream/use-suspender/typescript.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typescript.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/octet-stream/use-suspender/typescript.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/typescript.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/octet-stream/use-suspender/typescript.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typescript.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/octet-stream/use-suspender/typescript.yml/main?enable=pin","Info:   0 out of   6 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   3 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: license:0","Info: FSF or OSI recognized license: MIT License: license:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 8 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"16 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6","Warn: Project is vulnerable to: GHSA-67mh-4wv8-2f99","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55","Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j","Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j","Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-3mv9-4h5g-vhg3","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-22T05:21:00.026Z","repository_id":37481460,"created_at":"2025-08-22T05:21:00.027Z","updated_at":"2025-08-22T05:21:00.027Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30167962,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-06T07:56:45.623Z","status":"ssl_error","status_checked_at":"2026-03-06T07:55:55.621Z","response_time":250,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["async","javascript","javascript-library","preact","promise","react","react-hooks","react-suspense"],"created_at":"2024-07-31T07:00:39.774Z","updated_at":"2026-03-06T08:32:47.189Z","avatar_url":"https://github.com/octet-stream.png","language":"TypeScript","funding_links":[],"categories":["Packages","TypeScript"],"sub_categories":[],"readme":"# use-suspender\n\nWraps asynchronous function allowing to use it with [`React.Suspense`](https://react.dev/reference/react/Suspense).\n\n![ESLint](https://github.com/octet-stream/use-suspender/workflows/ESLint/badge.svg)\n![CI](https://github.com/octet-stream/use-suspender/workflows/CI/badge.svg)\n[![Code Coverage](https://codecov.io/github/octet-stream/use-suspender/coverage.svg?branch=master)](https://codecov.io/github/octet-stream/use-suspender?branch=master)\n\n## Installation\n\nUsing pnpm:\n\n```sh\npnpm add use-suspender\n```\n\nor yarn:\n\n```sh\nyarn add use-suspender\n```\n\nOr npm:\n\n```sh\nnpm i use-suspender\n```\n\n## API\n\n### `createSuspender(implementation[, ctx])`\n\nCreates a new `useSuspender` hook for given function.\n\nTakes following argmuents:\n\n| Name           | Type                                                                         | Required | Default     | Description                                         |\n|----------------|:----------------------------------------------------------------------------:|:--------:|:-----------:|-----------------------------------------------------|\n| implementation | [`SuspenderImplementation`](#interface-suspenderimplementationtresult-targs) | Yes      | –           | A function to create `useSuspender` hook for        |\n| ctx            | `unknown`                                                                    | No       | `undefined` | `thisArg` to use with each `useSuspender` hook call |\n\nReturns a function implementing [`SuspenderHook\u003cTResult, TArgs\u003e`](#interface-usesuspenderhooktresult-targs) interface.\n\n### `interface SuspenderImplementation\u003cTResult, TArgs\u003e`\n\nImplements arbitary function. For TypeScript users this will help to narrow types for implementation's result and its arguments.\n\nTakes following type parameters:\n\n| Name    | Extends              | Required | Default  | Description                                       |\n|---------|:--------------------:|:--------:|:--------:|---------------------------------------------------|\n| TResult | –                    | Yes      | –        | The result returned by *suspender implementation* |\n| TArgs   | `readonly unknown[]` | Yes      | –        | A list of implementation's arguments              |\n\nFor example, if you create a function that returns a `User` type, the `useSuspender` hook will expect the same exact arguments your function is taking and return the same type of the result:\n\n```tsx\nimport {createSuspender} from \"use-suspender\"\nimport type {FC} from \"react\"\n\ninterface User {\n  id: string\n  fullName: string\n  role: string\n  age: number\n}\n\nasync function getUserFromSomewhereById(userId: string): Promise\u003cUser\u003e {\n  const response = await fetch(`https://example.com/api/v1/json/users/${userId}`)\n\n  return response.json()\n}\n\n// This will create a function implementing UseSuspenderHook\u003cTResult, TArgs\u003e interface.\nconst useGetUser = createSuspender(getUserFromSomewhereById)\n// =\u003e UseSuspenderHook\u003cUser, [userId: string]\u003e\n\nconst Profile: FC = () =\u003e {\n  // This function will expect the same arguments with the same types as getUserFromSomewhereById\n  // In this example, if you call it with just a number - you will get an error from TypeScript.\n  const user = useGetUser(\"42\")\n\n  return (\n    \u003cdiv\u003e\n      {/* It will also return the same type as getUserFromSomewhereById, so you'll have autocompletions */}\n      Welcome, {user.fullName}!\n    \u003c/div\u003e\n  )\n}\n\nexport default Profile\n```\n\n### `interface UseSuspenderHook\u003cTResult, TArgs\u003e`\n\nImplements suspender hook, returned by `createSuspender` function.\n\nThis interface is a *function* with additional properties.\n\nWhen called, it executes *suspender implementation* with given arguments.\nThis function will throw a Promise to notify `React.Suspense`\nand resolve a result from suspender.\n\nWhen called with the same argments, it will find *pending* operation by comparing cached arguments using [`fast-deep-equal`](https://npmjs.com/package/fast-deep-equal) and re-throw a promise to notify `React.Suspense` if matched any.\n\nTakes following type parameters:\n\n| Name    | Extends              | Required | Default  | Description                                       |\n|---------|:--------------------:|:--------:|:--------:|---------------------------------------------------|\n| TResult | –                    | Yes      | –        | The result returned by *suspender implementation* |\n| TArgs   | `readonly unknown[]` | Yes      | –        | A list of implementation's arguments              |\n\n#### `UseSuspenderHook.useSuspender(...args: TArgs): TResult`\n\nExecutes *suspender implementation* with given arguments.\nThis function will throw a Promise to notify `React.Suspense`\nand resolve a result from suspender.\n\nWhen called with the same argments, it will find *pending* operation by comparing cached arguments using [`fast-deep-equal`](https://npmjs.com/package/fast-deep-equal) and re-throw a promise to notify `React.Suspense` if matched any.\n\nThis function should be called inside of your React function component.\n\n- args – arguments to call the suspender with\n\n#### `UseSuspenderHook.callEarly(...args: TArgs): void`\n\nCalls useSuspense early without throwing a Promise needed to notify `React.Suspense`.\n\n- args – arguments to call the suspender with\n\n## Usage\n\nMinimal example:\n\n```tsx\nimport {createSuspender} from \"use-suspender\"\nimport {createRoot} from \"react-dom/client\"\nimport {Suspense} from \"react\"\n\ntype Nationalities =\n  | \"br\"\n  | \"ca\"\n  | \"ch\"\n  | \"de\"\n  | \"dk\"\n  | \"es\"\n  | \"fi\"\n  | \"fr\"\n  | \"gb\"\n  | \"ie\"\n  | \"in\"\n  | \"ir\"\n  | \"mx\"\n  | \"nl\"\n  | \"no\"\n  | \"nz\"\n  | \"rs\"\n  | \"tr\"\n  | \"ua\"\n  | \"us\"\n\nconst useGetRandomUser = createSuspender((nationality: Nationalities) =\u003e (\n  fetch(`https://randomuser.me/api?results=1\u0026nat=${nationality}`)\n    .then(response =\u003e response.json())\n    .then(([result]) =\u003e result)\n))\n\nfunction User() {\n  const user = useGetRandomUser(\"ua\")\n\n  return (\n    \u003cdiv\u003e\n      \u003cdiv\u003e\n        Name: {user.name.first} {user.name.last}\n      \u003c/div\u003e\n\n      \u003cdiv\u003e\n        Email: {user.email}\n      \u003c/div\u003e\n    \u003c/div\u003e\n  )\n}\n\nconst App = () =\u003e (\n  \u003cSuspense fallback={\u003cdiv\u003eLoading...\u003c/div\u003e}\u003e\n    \u003cUser /\u003e\n  \u003c/Suspense\u003e\n)\n\nconst root = document.querySelector(\"#root\")\n\ncreateRoot(root).render(\u003cApp /\u003e)\n```\n\nThe `useSuspender` hook can take arguments to use in each suspender function call.\nImagine you have some API method, called `getUserByLogin`. It takes a user login\nas the only argument. Here's an example of how you can apply this argument to the method:\n\n```js\nimport {createSuspender} from \"use-suspender\"\nimport {useParams} from \"react-router-dom\"\n\nimport {getUserByLogin} from \"./api/user\"\n\n// Alternative way to get useSuspender hook\nconst {useSuspender: useGetUserByLogin} = createSuspender(getUserByLogin)\n\nfunction User() {\n  const {login} = useParams()\n\n  // Will execute getUserByLogin method with user taken from react-router-dom\n  const user = useGetUserByLogin(login)\n\n  return (\n    \u003cdiv\u003e\n      \u003cdiv\u003e\n        Name: {user.name.first} {user.name.last}\n      \u003c/div\u003e\n\n      \u003cdiv\u003e\n        Email: {user.email}\n      \u003c/div\u003e\n    \u003c/div\u003e\n  )\n}\n\nexport default User\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctet-stream%2Fuse-suspender","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foctet-stream%2Fuse-suspender","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctet-stream%2Fuse-suspender/lists"}