Sha256: d82c245bfb76da44dd573948eca299ff75759b9714f8410468d2d055145a4b64

Contents?: true

Size: 561 Bytes

Versions: 28

Compression:

Stored size: 561 Bytes

Contents

import type {IsEqual} from './is-equal';

/**
Returns a boolean for whether the given array includes the given item.

This can be useful if another type wants to make a decision based on whether the array includes that item.

@example
```
import type {Includes} from 'type-fest';

type hasRed<array extends any[]> = Includes<array, 'red'>;
```

@category Array
*/
export type Includes<Value extends readonly any[], Item> =
	Value extends readonly [Value[0], ...infer rest]
		? IsEqual<Value[0], Item> extends true
			? true
			: Includes<rest, Item>
		: false;

Version data entries

28 entries across 28 versions & 2 rubygems

Version Path
clapton-0.0.26 lib/clapton/javascripts/node_modules/type-fest/source/includes.d.ts
clapton-0.0.25 lib/clapton/javascripts/node_modules/type-fest/source/includes.d.ts
clapton-0.0.24 lib/clapton/javascripts/node_modules/type-fest/source/includes.d.ts
clapton-0.0.23 lib/clapton/javascripts/node_modules/type-fest/source/includes.d.ts
clapton-0.0.22 lib/clapton/javascripts/node_modules/type-fest/source/includes.d.ts
clapton-0.0.21 lib/clapton/javascripts/node_modules/type-fest/source/includes.d.ts
clapton-0.0.20 lib/clapton/javascripts/node_modules/type-fest/source/includes.d.ts
clapton-0.0.19 lib/clapton/javascripts/node_modules/type-fest/source/includes.d.ts
clapton-0.0.18 lib/clapton/javascripts/node_modules/type-fest/source/includes.d.ts
clapton-0.0.17 lib/clapton/javascripts/node_modules/type-fest/source/includes.d.ts
clapton-0.0.16 lib/clapton/javascripts/node_modules/type-fest/source/includes.d.ts
clapton-0.0.15 lib/clapton/javascripts/node_modules/type-fest/source/includes.d.ts
clapton-0.0.14 lib/clapton/javascripts/node_modules/type-fest/source/includes.d.ts
clapton-0.0.13 lib/clapton/javascripts/node_modules/type-fest/source/includes.d.ts
clapton-0.0.12 lib/clapton/javascripts/node_modules/type-fest/source/includes.d.ts
clapton-0.0.11 lib/clapton/javascripts/node_modules/type-fest/source/includes.d.ts
clapton-0.0.10 lib/clapton/javascripts/node_modules/type-fest/source/includes.d.ts
clapton-0.0.9 lib/clapton/javascripts/node_modules/type-fest/source/includes.d.ts
clapton-0.0.8 lib/clapton/javascripts/node_modules/type-fest/source/includes.d.ts
clapton-0.0.7 lib/clapton/javascripts/node_modules/type-fest/source/includes.d.ts