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

Introduce readonly operator #320

Merged
merged 3 commits into from
Jan 26, 2024
Merged

Introduce readonly operator #320

merged 3 commits into from
Jan 26, 2024

Conversation

chshanovskiy
Copy link
Contributor

Description

See #311 issue.

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

@chshanovskiy chshanovskiy marked this pull request as ready for review January 13, 2024 17:57
@zerobias
Copy link
Member

zerobias commented Jan 15, 2024

Is it necessary to do .map call when unit is already derived? We have is. targetable to detect this case and just return unit as it is

Improved implementation when argument is already derived.
@chshanovskiy
Copy link
Contributor Author

chshanovskiy commented Jan 18, 2024

@zerobias , I've added tests and implementation for derived units in argument

@sergeysova sergeysova added the feature New functionality label Jan 26, 2024
@sergeysova sergeysova merged commit 9dc00f5 into effector:main Jan 26, 2024
4 checks passed
@sergeysova sergeysova changed the title feat(readonly): implement readonly operator Introduce readonly operator Jan 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants