{"id":21961826,"url":"https://github.com/trapcodeio/stack-promise","last_synced_at":"2025-03-22T20:27:45.585Z","repository":{"id":57369162,"uuid":"454030358","full_name":"trapcodeio/stack-promise","owner":"trapcodeio","description":"Stack Promises in functions to run later.","archived":false,"fork":false,"pushed_at":"2023-01-10T13:34:59.000Z","size":8,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-20T05:34:54.479Z","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/trapcodeio.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":"2022-01-31T14:07:30.000Z","updated_at":"2022-04-01T15:30:23.000Z","dependencies_parsed_at":"2023-02-08T18:45:15.059Z","dependency_job_id":null,"html_url":"https://github.com/trapcodeio/stack-promise","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trapcodeio%2Fstack-promise","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trapcodeio%2Fstack-promise/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trapcodeio%2Fstack-promise/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trapcodeio%2Fstack-promise/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/trapcodeio","download_url":"https://codeload.github.com/trapcodeio/stack-promise/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245017542,"owners_count":20547831,"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-11-29T10:18:28.223Z","updated_at":"2025-03-22T20:27:45.557Z","avatar_url":"https://github.com/trapcodeio.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Stack JavaScript Promise\n\nThis simple library provides a more semantic version to the code below:\n\n```typescript\nconst tasks = [];\n\n// Stack promises\ntasks.push(() =\u003e Promise.resolve(\"promise1\"))\ntasks.push(() =\u003e Promise.resolve(\"promise2\"))\n\n// Then run the tasks\nawait Promise.all(tasks.map(task =\u003e task()))\n```\n\n\nUsing this library, the code above can be written as:\n```typescript\nimport { StackedPromise } from \"stack-promise\";\n\nconst tasks = StackedPromise();\n\ntasks.push(() =\u003e Promise.resolve(\"promise1\"))\ntasks.push(() =\u003e Promise.resolve(\"promise2\"))\n\n// Then run the tasks\nawait tasks.run()\n```\n\n## Installation\n```shell\nnpm i stacked-promise\n# or\nyarn add stacked-promise\n```\n\n\n## StackPromise Class\n\n| Property/Method | Description                                                             |\n|-----------------|-------------------------------------------------------------------------|\n | `stack`         | The array holding the stack of promises                                 |\n | `push()`        | Push a function that returns a promise                                  |\n | `unstack()`     | Unstack promises by running each function                               |\n| `run()`         | Run the tasks                                                           |\n| `concat()`      | Concatenate two stacks                                                  |\n| `some()`        | Run every task but stop when any passes the validation function passed. |\n| `every()`       | Run every task but stop when any fails the validation function passed.  |\n\n\n### push()\nPush a function that returns a promise\n\n```typescript\nconst tasks = StackedPromise();\n\ntasks.push(() =\u003e Promise.resolve(\"promise1\"))\ntasks.push(() =\u003e Promise.resolve(\"promise2\"))\n\nconsole.log(tasks.stack.length) // 2\n```\n\n### unstack()\nUnstack promises by running each function\n\n```typescript\nconst tasks = StackedPromise();\n\ntasks.push(() =\u003e Promise.resolve(\"promise1\"))\ntasks.push(() =\u003e Promise.resolve(\"promise2\"))\n\ntasks.unstack() // [Promise, Promise]\n```\n\n\n### run()\nRun the tasks\n\n```typescript\nconst tasks = StackedPromise();\n\ntasks.push(() =\u003e Promise.resolve(\"promise1\"))\ntasks.push(() =\u003e Promise.resolve(\"promise2\"))\n\n\nawait tasks.run() // [\"promise1\", \"promise2\"]\n```\n\n### concat()\nConcatenate two stacks\n\n```typescript\nconst tasks = StackedPromise();\ntasks.push(() =\u003e Promise.resolve(\"promise1\"))\n\nconst tasks2 = StackedPromise();\ntasks2.push(() =\u003e Promise.resolve(\"promise2\"))\ntasks2.push(() =\u003e Promise.resolve(\"promise3\"))\n\n\ntasks.concat(tasks2)\n\nconsole.log(tasks.stack.length) // 3\n```\n\n### some()\nRun every task but stop when any passes the validation function passed.\n\n```typescript\nconst tasks = StackedPromise();\n\ntasks.push(() =\u003e Promise.resolve(true))\ntasks.push(() =\u003e Promise.resolve(true))\n\nawait tasks.some((result) =\u003e result === true) // true\nawait tasks.some((result) =\u003e result === false) // false\n```\n\n\n### every()\nRun every task but stop when any fails the validation function passed.\n\n```typescript\nconst tasks = StackedPromise();\n\ntasks.push(() =\u003e Promise.resolve(true))\ntasks.push(() =\u003e Promise.resolve(true))\n\nawait tasks.every((result) =\u003e result === true) // true\nawait tasks.every((result) =\u003e result === false) // false\n```\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrapcodeio%2Fstack-promise","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftrapcodeio%2Fstack-promise","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrapcodeio%2Fstack-promise/lists"}