{"id":21863130,"url":"https://github.com/shfshanyue/promise-utils","last_synced_at":"2025-04-14T19:44:02.015Z","repository":{"id":42888117,"uuid":"254786894","full_name":"shfshanyue/promise-utils","owner":"shfshanyue","description":"Useful utils about promise. (map, filter, retry, sleep","archived":false,"fork":false,"pushed_at":"2023-01-06T09:17:44.000Z","size":966,"stargazers_count":8,"open_issues_count":16,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-28T08:04:43.379Z","etag":null,"topics":["async-await","delay","nodejs","parallel","promise","promise-library","promise-map"],"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/shfshanyue.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}},"created_at":"2020-04-11T03:41:19.000Z","updated_at":"2023-09-02T00:25:06.000Z","dependencies_parsed_at":"2023-02-05T18:40:10.127Z","dependency_job_id":null,"html_url":"https://github.com/shfshanyue/promise-utils","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/shfshanyue%2Fpromise-utils","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shfshanyue%2Fpromise-utils/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shfshanyue%2Fpromise-utils/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shfshanyue%2Fpromise-utils/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shfshanyue","download_url":"https://codeload.github.com/shfshanyue/promise-utils/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248949777,"owners_count":21188148,"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":["async-await","delay","nodejs","parallel","promise","promise-library","promise-map"],"created_at":"2024-11-28T03:20:09.682Z","updated_at":"2025-04-14T19:44:01.993Z","avatar_url":"https://github.com/shfshanyue.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# promise-utils\n\nA few tools about promise, like delay, map, filter and retry.\n\n[![npm version](https://img.shields.io/npm/v/@shanyue/promise-utils.svg?style=flat-square)](https://www.npmjs.org/package/@shanyue/promise-utils)\n![build status](https://img.shields.io/github/workflow/status/shfshanyue/promise-utils/test?style=flat-square)\n[![install size](https://packagephobia.now.sh/badge?p=@shanyue/promise-utils)](https://packagephobia.now.sh/result?p=@shanyue/promise-utils)\n[![npm downloads](https://img.shields.io/npm/dw/@shanyue/promise-utils.svg?style=flat-square)](http://npm-stat.com/charts.html?package=@shanyue/promise-utils)\n\n## Install\n\n``` bash\n$ npm install @shanyue/promise-utils\n```\n\n\u003e Require node \u003e 10.x\n\n## Usage\n\n``` ts\nimport { map, filter, retry, sleep } from '@shanyue/promise-utils'\n\n\n// Output: [2, 3, 4, 5]\nawait map([Promise.resolve(1), 2, 3, 4], (x: number) =\u003e x + 1)\n\n// Output: [1, 3]\nawait filter([Promise.resolve(1), 2, 3, 4], (x: number) =\u003e Boolean(x % 2))\n\nawait sleep(300)\n\nawait retry(() =\u003e Promise.resolve(3), { times: 3 })\n```\n\n## API\n\n### map(input, mapper, [options])\n\n\u003e Map promises concurrently \n\n+ `input`: Promise or any value\n+ `mapper`: Expected to return a Promise or value.\n+ `options.concurrency`: Number of concurrently pending promises.\n\n``` ts\nimport { map } from '@shanyue/promise-utils'\n\n// Output: [2, 3, 4, 5]\nawait map([Promise.resolve(1), 2, 3, 4], (x: number) =\u003e x + 1)\n\n// Output: [2, 3, 4, 5]\nawait map([Promise.resolve(1), 2, 3, 4], (x: number) =\u003e Promise.resolve(x + 1))\n\n// After 4 * 300ms，Output: [2, 3, 4, 5]\nawait map([1, 2, 3, 4], async x =\u003e {\n  await sleep(300)\n  return x + 1\n}, { concurrency: 1 })\n```\n\n### filter(input, filterer, [options])\n\n\u003e Filter promises concurrently\n\n+ `input`: Promise or any value.\n+ `filterer`: Expected to return boolean-like value.\n+ `options.concurrency`: Number of concurrently pending promises.\n\n``` ts\nimport { filter } from '@shanyue/promise-utils'\n\n// Output: [1, 3]\nawait filter([Promise.resolve(1), 2, 3, 4], (x: any) =\u003e Boolean(x % 2))\n\n// Output: [1, 3]\nawait filter([Promise.resolve(1), 2, 3, 4], (x: any) =\u003e Promise.resolve(Boolean(x % 2)))\n```\n\n### retry(input, [options])\n\n\u003e Retry promise\n\n+ `input`: Promise or any value.\n+ `options.times`: Number of concurrently pending promises.\n+ `options.attemptNumber`: Number of concurrently pending promises.\n\n``` ts\nimport { retry, AbortError } from '@shanyue/promise-utils'\n\n// Output: 'ok'\nawait retry(async attemptNumber =\u003e {\n  return attemptNumber === 3 ? 'ok' : Promise.reject(new Error('error'))\n}, {\n  times: 3\n})\n\n// Output: 'ok'\nawait retry(async attemptNumber =\u003e {\n  return attemptNumber === 3 ? 'ok' : Promise.reject(new Error('error'))\n}, {\n  times: 3,\n  onFailedAttempt: async (e) =\u003e {\n    console.log(e)\n    // retry delay 1s\n    await sleep(1000)\n  }\n})\n\n\n// AbortError fail-fast\ntry {\n  await retry(async () =\u003e {\n    const err = new AbortError('hello')\n    return Promise.reject(err)\n  }, {\n    times: 3\n  })\n} catch (e) {\n}\n```\n\n### sleep(ms)\n\n``` js\nimport { retry } from '@shanyue/promise-utils'\n\n// delay 1s\nawait sleep(1000)\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshfshanyue%2Fpromise-utils","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshfshanyue%2Fpromise-utils","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshfshanyue%2Fpromise-utils/lists"}