{"id":13756531,"url":"https://github.com/sergeysova/effector-debounce","last_synced_at":"2025-05-10T03:32:12.388Z","repository":{"id":57219813,"uuid":"241169528","full_name":"sergeysova/effector-debounce","owner":"sergeysova","description":"Debounce effector units","archived":true,"fork":false,"pushed_at":"2020-06-18T12:56:01.000Z","size":142,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-02-11T15:55:00.851Z","etag":null,"topics":["debounce","effector"],"latest_commit_sha":null,"homepage":"https://npmjs.com/effector-debounce","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:38:55.000Z","updated_at":"2023-01-28T14:04:30.000Z","dependencies_parsed_at":"2022-08-29T00:11:50.947Z","dependency_job_id":null,"html_url":"https://github.com/sergeysova/effector-debounce","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":"sergeysova/webpack-library","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sergeysova%2Feffector-debounce","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sergeysova%2Feffector-debounce/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sergeysova%2Feffector-debounce/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sergeysova%2Feffector-debounce/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sergeysova","download_url":"https://codeload.github.com/sergeysova/effector-debounce/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224911584,"owners_count":17390840,"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":["debounce","effector"],"created_at":"2024-08-03T11:00:46.311Z","updated_at":"2024-11-16T11:31:50.592Z","avatar_url":"https://github.com/sergeysova.png","language":"TypeScript","funding_links":[],"categories":["Packages"],"sub_categories":[],"readme":"# Effector Debounce\n\n[![npm bundle size](https://img.shields.io/bundlephobia/min/effector-debounce)](https://bundlephobia.com/result?p=effector-debounce)\n\n\u003e **Deprecated**: Use [patronum](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-debounce\n\n# or\n\nyarn add effector effector-debounce\n```\n\n## Usage\n\nCreate event that should be debounced:\n\n```ts\nimport { createEvent } from 'effector';\n\nconst someHappened = createEvent\u003cnumber\u003e();\n```\n\nCreate debounced event from it:\n\n```ts\nimport { createDebounce } from 'effector-debounce';\n\nconst DEBOUNCE_TIMEOUT_IN_MS = 200;\n\nconst debounced = createDebounce(someHappened, DEBOUNCE_TIMEOUT_IN_MS);\n```\n\nTo test that original event is correctly debounced you can add watcher:\n\n```ts\ndebounced.watch((payload) =\u003e {\n  console.info('someHappened now', payload);\n});\n\nsomeHappened(1);\nsomeHappened(2);\nsomeHappened(3);\nsomeHappened(4);\n\n// someHappened now 4\n```\n\nAlso you can use `Effect` and `Store` as trigger. `createDebounce` always returns `Event`:\n\n```ts\nconst event = createEvent\u003cnumber\u003e();\nconst debouncedEvent: Event\u003cnumber\u003e = createDebounce(event, 100);\n\nconst fx = createEffect\u003cnumber, void\u003e();\nconst debouncedEffect: Event\u003cnumber\u003e = createDebounce(fx, 100);\n\nconst $store = createStore\u003cnumber\u003e(0);\nconst debouncedStore: Event\u003cnumber\u003e = createDebounce($store, 100);\n```\n\n### Change name\n\n```ts\nconst trigger = createEvent();\nconst debounced = createDebounce(trigger, 100);\n\n// Now debounced var has `triggerDebounceTick` name\n```\n\nTo change name:\n\n```ts\nconst trigger = createEvent();\nconst debounced = createDebounce(trigger, 100, { name: 'Hello' });\n\n// Now debounced var has `HelloDebounceTick` name\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsergeysova%2Feffector-debounce","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsergeysova%2Feffector-debounce","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsergeysova%2Feffector-debounce/lists"}