{"id":13756532,"url":"https://github.com/sergeysova/effector-throttle","last_synced_at":"2025-05-10T03:32:14.434Z","repository":{"id":57219825,"uuid":"241169997","full_name":"sergeysova/effector-throttle","owner":"sergeysova","description":"Simple throttle for effector events","archived":true,"fork":false,"pushed_at":"2020-06-13T14:44:55.000Z","size":214,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-05T18:38:14.060Z","etag":null,"topics":["effector","throttle"],"latest_commit_sha":null,"homepage":"https://npmjs.com/effector-throttle","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/sergeysova.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-02-17T17:41:12.000Z","updated_at":"2023-01-28T14:09:30.000Z","dependencies_parsed_at":"2022-08-28T23:22:59.177Z","dependency_job_id":null,"html_url":"https://github.com/sergeysova/effector-throttle","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":"toastyboost/rollup-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sergeysova%2Feffector-throttle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sergeysova%2Feffector-throttle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sergeysova%2Feffector-throttle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sergeysova%2Feffector-throttle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sergeysova","download_url":"https://codeload.github.com/sergeysova/effector-throttle/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253336798,"owners_count":21892788,"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":["effector","throttle"],"created_at":"2024-08-03T11:00:46.342Z","updated_at":"2025-05-10T03:32:14.083Z","avatar_url":"https://github.com/sergeysova.png","language":"TypeScript","funding_links":[],"categories":["Packages"],"sub_categories":[],"readme":"# Effector Throttle\n\n[![npm bundle size](https://img.shields.io/bundlephobia/min/effector-throttle)](https://bundlephobia.com/result?p=effector-throttle)\n\n\u003e **Deprecated**: use [patronum](https://github.com/sergeysova/patronum) instead\n\nhttps://codesandbox.io/s/effector-throttle-debounce-w32tk\n\n## Installation\n\n```bash\nnpm install --save effector effector-throttle\n\n# or\n\nyarn add effector effector-throttle\n```\n\n## Usage\n\nCreate event that should be throttled:\n\n```ts\nimport { createEvent } from 'effector';\n\nconst someHappened = createEvent\u003cnumber\u003e();\n```\n\nCreate throttled event from it:\n\n```ts\nimport { createThrottle } from 'effector-throttle';\n\nconst THROTTLE_TIMEOUT_IN_MS = 200;\n\nconst throttled = createThrottle(someHappened, THROTTLE_TIMEOUT_IN_MS);\n```\n\nWhen you call `someHappened` it will throttle call to `throttled` event:\n\n```ts\nthrottled.watch((payload) =\u003e {\n  console.info('someHappened now', payload);\n});\n\nsomeHappened(1);\nsomeHappened(2);\nsomeHappened(3);\nsomeHappened(4);\n```\n\nAlso you can use `Effect` and `Store` as trigger. `createThrottle` always returns `Event`:\n\n```ts\nconst event = createEvent\u003cnumber\u003e();\nconst debouncedEvent: Event\u003cnumber\u003e = createThrottle(event, 100);\n\nconst fx = createEffect\u003cnumber, void\u003e();\nconst debouncedEffect: Event\u003cnumber\u003e = createThrottle(fx, 100);\n\nconst $store = createStore\u003cnumber\u003e(0);\nconst debouncedStore: Event\u003cnumber\u003e = createThrottle($store, 100);\n```\n\n### Change name\n\n```ts\nconst trigger = createEvent();\nconst throttled = createThrottle(trigger, 100);\n\n// Now throttled var has `triggerThrottleTick` name\n```\n\nTo change name:\n\n```ts\nconst trigger = createEvent();\nconst throttled = createThrottle(trigger, 100, { name: 'Hello' });\n\n// Now throttled var has `HelloThrottleTick` name\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsergeysova%2Feffector-throttle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsergeysova%2Feffector-throttle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsergeysova%2Feffector-throttle/lists"}