Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add timers api #312

Closed
wants to merge 6 commits into from
Closed

Add timers api #312

wants to merge 6 commits into from

Conversation

movpushmov
Copy link

@movpushmov movpushmov commented Dec 11, 2023

Description

Closes #310

Checklist for a new method

  • Create a directory for the new method in the src directory in param-case
  • Place the source code to src/method-name/index.ts in ESModules export in camelCase named export
  • Add tests to src/method-name/method-name.test.ts
  • Add fork tests to src/method-name/method-name.fork.test.ts
  • Add type tests to test-typings/method-name.ts
    • Use // @ts-expect-error to mark expected type error
    • import { expectType } from 'tsd' to check expected return type
  • Add documentation in src/method-name/readme.md
    • Add header Patronum/MethodName
    • Add section with overloads, if have
    • Add Motivation, Formulae, Arguments and Return sections for each overload
    • Add useful examples in Example section for each overload
  • Add section to README.md in the repository root
    • Add method to the table of contents into correct category - [MethodName](#methodname) - description.
    • Add section ## MethodName
    • Add [Method documentation & API](/src/method-name) into section
    • Add simple example

Now debounce, throttle, delay, interval use time functions implementations, which can set by user manually. By default in store used time functions from environment.
@movpushmov
Copy link
Author

I think about 2 more features:

  1. Add support for SSR (set $timers value from effector provider, but how?)
  2. Maybe add new function now, which don't accept "getNow" prop and returns "now" from $timers.now

@movpushmov movpushmov closed this Apr 19, 2024
@movpushmov movpushmov deleted the add-timers-api branch April 19, 2024 21:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add API for custom time functions implementation
1 participant