{"id":22986682,"url":"https://github.com/mkg0/promise-effects","last_synced_at":"2025-08-13T20:33:06.889Z","repository":{"id":42868472,"uuid":"139241175","full_name":"mkg0/promise-effects","owner":"mkg0","description":"Promise effects like retry, timeout, observation over promises for advanced use cases or test purposes.","archived":false,"fork":false,"pushed_at":"2023-01-06T04:23:08.000Z","size":1197,"stargazers_count":3,"open_issues_count":10,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-08-09T13:39:24.775Z","etag":null,"topics":["async","cancelablepromise","observe-promise","polling","promise","promise-retry","retry","timeout","wait"],"latest_commit_sha":null,"homepage":"","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/mkg0.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-06-30T10:42:47.000Z","updated_at":"2023-08-19T17:59:36.000Z","dependencies_parsed_at":"2023-02-05T07:16:34.824Z","dependency_job_id":null,"html_url":"https://github.com/mkg0/promise-effects","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/mkg0/promise-effects","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkg0%2Fpromise-effects","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkg0%2Fpromise-effects/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkg0%2Fpromise-effects/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkg0%2Fpromise-effects/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mkg0","download_url":"https://codeload.github.com/mkg0/promise-effects/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkg0%2Fpromise-effects/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270305842,"owners_count":24562109,"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","status":"online","status_checked_at":"2025-08-13T02:00:09.904Z","response_time":66,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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","cancelablepromise","observe-promise","polling","promise","promise-retry","retry","timeout","wait"],"created_at":"2024-12-15T03:51:16.702Z","updated_at":"2025-08-13T20:33:06.615Z","avatar_url":"https://github.com/mkg0.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Promise Effects\n=================================\n\n[![npm](https://img.shields.io/npm/v/promise-effects)](https://www.npmjs.com/package/promise-effects)\n[![npm](https://img.shields.io/npm/l/promise-effects)]()\n\nFully typed promise effects to play with async handlers in a pleasent way.\n\n| Effect                            | Desc                                                  |\n|-----------------------------------|-------------------------------------------------------|\n| [retryPromise](#retryPromise)     | Converts a promise creator to repetitive              |\n| [wait](#wait)                     | Creates a promise to resolve for the given time long. |\n| [observePromise](#observePromise) | Creates observable promises from the given promise    |\n| [timeout](#timeout)               | Timeout example                                       |\n| Polling                           | ⏱ Polling example                                     |\n| Latest                            | ⏱                                                     |\n| CancelablePromise\u003cT\u003e              | ⏱                                                     |\n\n## Usage\n\nInstall package\n```sh\nnpm install promise-effects\n```\n\nImport module\n```js\nimport { retryPromise } from 'promise-effects'\n// or\nimport retryPromise from 'promise-effects/retryPromise'\n```\n\n## Effects\n\n### **RetryPromise**\n\nIt's a high-order function that gives the capabilify of retry to a function that creates promise.\n\n```js\nconst repetitiveFetch = retryPromise(fetch, {\n  retry: 3,\n  onReconnecting: ({ attemptNumber }) =\u003e console.log(`Fetching has failed(${attemptNumber})... Retrying...`),\n})\nrepetitiveFetch('https://www.mocky.io/v2/5185415ba171ea3a00704eed')\n  .then(resp=\u003e resp.json())\n  .then(console.log)\n  .catch(() =\u003e console.log('Failed!'))\n// \u003e Fetching has failed(1)... Retrying...\n// \u003e Fetching has failed(2)... Retrying...\n// \u003e Fetching has failed(3)... Retrying...\n// \u003e Failed!\n```\n\n#### Options\n\n| Option Name    | Type                                                                                        |\n|----------------|---------------------------------------------------------------------------------------------|\n| onReconnecting | `fn:({attemptNumber: number,  remainingTries: number,  error: Error})`                      |\n| delay          | `number`                                                                                    |\n| delay          | `{ delay: number, factor: number, max?: number, min?: number }`                             |\n| delay          | `fn: ({attemptNumber: number,  remainingTries: number,  error: Error}) =\u003e number | Promise` |\n| shouldRetry    | `fn: ({attemptNumber: number,  remainingTries: number,  error: Error}) =\u003e booleaan |Promise\u003cboolean\u003e`         |\n| retry          | `number`                                                                                    |\n\n\n\n### **observePromise**\n\nIt wraps promises to observe the status. You can get if the promise `fulfilled`, `rejected` or `pending`. It's beneficial on test purposes. \n\n```js\nconst observed = observePromise(fetch('http://google.com'))\nconsole.log(observed.isPending()) // \u003e true\nconsole.log(observed.isRejected()) // \u003e false\nconsole.log(observed.isFulfilled()) // \u003e false\nconsole.log(observed.status) // \u003e 'PENDING'\nobserved\n  .then(result=\u003e {\n    console.log(observed.status) // \u003e 'RESOLVED'\n    console.log(observed.isFulfilled()) // \u003e true\n  })\n  .catch(() =\u003e {\n    console.log(observed.status) // \u003e 'REJECTED'\n    console.log(observed.isRejected()) // \u003e true\n  })\n```\n\n### **wait**\n\nCreates a promise to resolve for the given time long.\n\n```js\nconst printMessage = (count=0) =\u003e\n  Promise.resolve()\n    .then(() =\u003e console.log(`You will see this message every second(${count})`))\n    .then(() =\u003e wait(1000).then(() =\u003e printMessage(count + 1)))\n\nprintMessage()\n// \u003e You will see this message every second(0)\n// \u003e You will see this message every second(1)\n// \u003e You will see this message every second(2)\n// \u003e You will see this message every second(3)\n// \u003e ...\n```\n\n\n### **timeout**\n\nYou don't need an exclusive timeout function for timeout. Use `wait` with [ES Promise.race](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/race) instead.\n\n\n```js\n  // fail in 1 sec\n  Promise.race([\n    fetch('https://www.mocky.io/v2/5185415ba171ea3a00704eed?mocky-delay=1200ms').then(res=\u003e resp.json()),\n    wait(1000).then(()=\u003e Promise.reject('Timeout!'))\n  ])\n  // \u003e Uncaught (in promise) Timeout!\n```\n\n```js\n  // will mock response if the first request doesn't resolve in 1 sec\n  const result = await Promise.race([\n    fetch('https://www.mocky.io/v2/5185415ba171ea3a00704eed?mocky-delay=1200ms').then(res=\u003e resp.json()),\n    wait(1000).then(()=\u003e ({ hello: 'mock' }))\n  ])\n  console.log(result)\n  // \u003e { hello: 'mock' }\n```\n\n## Changelog\n\nAll notable changes to this project will be documented in the [changelog file](https://github.com/mkg0/promise-effects/blob/master/CHANGELOG.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkg0%2Fpromise-effects","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmkg0%2Fpromise-effects","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkg0%2Fpromise-effects/lists"}