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

Use EventCallable for reset operator return type #335

Merged
merged 2 commits into from
Sep 30, 2024

Conversation

domosedov
Copy link
Contributor

Description

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

@sergeysova sergeysova self-assigned this Sep 30, 2024
@YanLobat YanLobat merged commit 587d936 into effector:main Sep 30, 2024
4 checks passed
@sergeysova sergeysova changed the title fix(reset): Event type Use EventCallable for reset operator Oct 9, 2024
@sergeysova sergeysova changed the title Use EventCallable for reset operator Use EventCallable for reset operator return type Oct 9, 2024
@sergeysova sergeysova added the fix PullRequest that fixes something broken label Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fix PullRequest that fixes something broken
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants