Skip to content

Introduce xor operator #347

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Rastraponovich
Copy link

@Rastraponovich Rastraponovich commented May 8, 2025

Description

realization xor operator, Combines multiple stores, returning true if exactly one of them is truthy.

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
  • Fill frontmatter in src/method-name/readme.md
    • Add title. Make sure it uses camelCase syntax just like the method itself
    • Add slug. Use param-case to write it. In most cases it will be just like title
    • Add desription with one short sentence describing what method useful for
    • Add group. To categorize method on /operators page. Full list of available groups, you can see in documentation/src/content/config.ts

@sergeysova sergeysova added the RFC Some new feature that should be discussed label May 8, 2025
@sergeysova sergeysova changed the title feat: xor operator Introduce xor operator May 8, 2025
@sergeysova sergeysova added the feature New functionality label May 8, 2025
@sergeysova
Copy link
Member

@Rastraponovich Thank you for new operator.
Please, add type tests.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New functionality RFC Some new feature that should be discussed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants