Implement includes operator

[stavrogyn]

Description

includes is implemented according to the issue

The operator checking if a store (containing either a string or an array) includes a specified value.

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

[earthspacon]

a must be either an array or a string, so I would write it like this:

if (typeof a === 'string') {
      return a.includes(b as string);
}

throw new Error('First argument should be a unit of array or string');

I'm not a maintainer, just decided to leave a comment :)

[sergeysova]

Why only string | number?

[sergeysova]

What if:

Suggested change

	export function includes <T extends string>(
	a: Store<T>,
	b: Store<T> | T,
	): Store<boolean>
	export function includes <T extends string | number>(
	a: Store<Array<T>>,
	b: Store<T> | T,
	): Store<boolean>
	export function includes <T extends string>(
	a: Store<T>,
	b: Store<T> | T,
	): Store<boolean>
	export function includes <T>(
	a: Store<Array<T>>,
	b: Store<T> | T,
	): Store<boolean>
	export function includes <T>(
	a: Store<{ ref: Set<T> }>,
	b: Store<T> | T,
	): Store<boolean>

allow to compare with any list of items?

[sergeysova]

Suggested change

	a: Store<T | Array<T>>,
	b: Store<T> | T,
	haystack: Store<T | Array<T>>,
	needle: Store<T> | T,

[sergeysova]

I think a, b is not clearly explains what in what we checking:

includes($email, "@");
includes("@", $email);

it will work by types in both ways, but IDE will suggest a:, b: names which is not self-descriptive, I think

[sergeysova]

I think is better do not recommend using .getState() in documentation.

Suggested change

	console.assert($isInclude.getState() === true);
	$isInclude // => true