{"id":13481683,"url":"https://github.com/petergombos/react-pledge","last_synced_at":"2025-03-27T12:31:15.948Z","repository":{"id":57342533,"uuid":"131430630","full_name":"petergombos/react-pledge","owner":"petergombos","description":"Declarative way to track promise lifecycle states using \"render props\" 🕶","archived":false,"fork":false,"pushed_at":"2018-05-07T11:04:53.000Z","size":63,"stargazers_count":141,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-18T13:19:23.433Z","etag":null,"topics":[],"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/petergombos.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":"2018-04-28T17:35:08.000Z","updated_at":"2024-02-23T19:09:52.000Z","dependencies_parsed_at":"2022-09-16T03:02:02.249Z","dependency_job_id":null,"html_url":"https://github.com/petergombos/react-pledge","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/petergombos%2Freact-pledge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/petergombos%2Freact-pledge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/petergombos%2Freact-pledge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/petergombos%2Freact-pledge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/petergombos","download_url":"https://codeload.github.com/petergombos/react-pledge/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245844887,"owners_count":20681795,"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-07-31T17:00:54.198Z","updated_at":"2025-03-27T12:31:15.686Z","avatar_url":"https://github.com/petergombos.png","language":"JavaScript","funding_links":[],"categories":["React","Components"],"sub_categories":["React Components","Misc"],"readme":"# React Pledge\n\nDeclarative way to track promise lifecycle states using \"render props\" 🕶\n\n✅ Zero dependencies\n\n✅ Tiny **896 B gzipped**\n\n## Usage\n\n```js\nimport React from 'react'\nimport Track from 'react-pledge'\n\nconst delay = (ms = 1000) =\u003e\n  new Promise((resolve, reject) =\u003e {\n    setTimeout(() =\u003e resolve(), ms)\n  })\n\nconst submit = async () =\u003e {\n  await delay(2000)\n  if (Math.random() \u003e 0.5) {\n    throw Error('Some error message 🤒')\n  }\n  return '🙌'\n}\n\nconst App = () =\u003e (\n  \u003cTrack promise={submit}\u003e\n    {(handleSubmit, { pending, resolved, value, rejected, error }) =\u003e (\n      \u003cdiv\u003e\n        \u003cdiv\u003e\n          {pending ? (\n            'Loading...'\n          ) : rejected ? (\n            error.message\n          ) : resolved ? (\n            \u003cspan\u003eWoohoo, success!!!\u003c/span\u003e\n          ) : null}\n        \u003c/div\u003e\n        \u003cbutton onClick={handleSubmit} disabled={pending}\u003e\n          {pending ? 'Submitting' : 'Submit'}\n        \u003c/button\u003e\n        {resolved \u0026\u0026 \u003cdiv\u003eThe returned value of the promise is: {value}\u003c/div\u003e}\n      \u003c/div\u003e\n    )}\n  \u003c/Track\u003e\n)\n```\n\n### [Simple Example](https://codesandbox.io/s/2z06vmyv0y)\n\n## Installation\n\n```bash\nnpm install --save react-pledge\n```\n\nor\n\n```bash\nyarn add react-pledge\n```\n\n## Props\n\n### `promise`\n\nA promise you want to track\n\n### `children` or `render`\n\nA render function that will be called with the following arguments:\n\n* `invoke function` to trigger the given promise\n* `state object` with the current state of the promise\n\nThe state will contain the following:\n\n* `pending`: boolean\n* `resolved`: boolean\n* `value`: the returned value of the promise | null,\n* `rejected`: boolean,\n* `error`: the returned error during the rejection of the promise | null\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpetergombos%2Freact-pledge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpetergombos%2Freact-pledge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpetergombos%2Freact-pledge/lists"}