orbit-oss/is
5
5
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Require Node.js 14, TS 4.7, and move to ESM (#167)

Browse source
This commit is contained in:
Sindre Sorhus 2022-06-11 17:44:01 +07:00
parent c408f5a268
commit d6fc1ce0fe
8 changed files with 341 additions and 316 deletions
Download patch file Download diff file Expand all files Collapse all files

8
.github/workflows/main.yml vendored
View file

@ -10,12 +10,12 @@ jobs:
fail-fast: false fail-fast: false
matrix: matrix:
node-version: node-version:
- 18
- 16
- 14 - 14
- 12
- 10
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- uses: actions/setup-node@v1 - uses: actions/setup-node@v3
with: with:
node-version: ${{ matrix.node-version }} node-version: ${{ matrix.node-version }}
- run: npm install - run: npm install

62
package.json
View file

@ -10,9 +10,11 @@
"email": "sindresorhus@gmail.com", "email": "sindresorhus@gmail.com",
"url": "https://sindresorhus.com" "url": "https://sindresorhus.com"
}, },
"main": "dist/index.js", "type": "module",
"exports": "./index.js",
"types": "./index.d.ts",
"engines": { "engines": {
"node": ">=10" "node": ">=14.16"
}, },
"scripts": { "scripts": {
"build": "del dist && tsc", "build": "del dist && tsc",
@ -47,50 +49,34 @@
"types" "types"
], ],
"devDependencies": { "devDependencies": {
"@sindresorhus/tsconfig": "^0.7.0", "@sindresorhus/tsconfig": "^3.0.1",
"@types/jsdom": "^16.1.0", "@types/jsdom": "^16.2.14",
"@types/node": "^14.0.13", "@types/node": "^17.0.42",
"@types/zen-observable": "^0.8.0", "@types/zen-observable": "^0.8.3",
"@typescript-eslint/eslint-plugin": "^2.20.0", "ava": "^4.3.0",
"@typescript-eslint/parser": "^2.20.0", "del-cli": "^4.0.1",
"ava": "^3.3.0", "jsdom": "^19.0.0",
"del-cli": "^2.0.0", "rxjs": "^7.5.5",
"eslint-config-xo-typescript": "^0.26.0", "tempy": "^3.0.0",
"jsdom": "^16.0.1", "ts-node": "^10.8.1",
"rxjs": "^6.4.0", "typescript": "~4.7.3",
"tempy": "^0.4.0", "xo": "^0.50.0",
"ts-node": "^8.3.0", "zen-observable": "^0.8.15"
"typescript": "~3.8.2",
"xo": "^0.26.1",
"zen-observable": "^0.8.8"
}, },
"types": "dist/index.d.ts",
"sideEffects": false, "sideEffects": false,
"ava": { "ava": {
"extensions": [ "extensions": {
"ts" "ts": "module"
], },
"require": [ "nodeArguments": [
"ts-node/register" "--loader=ts-node/esm"
] ]
}, },
"xo": { "xo": {
"extends": "xo-typescript",
"extensions": [
"ts"
],
"parserOptions": {
"project": "./tsconfig.xo.json"
},
"globals": [
"BigInt",
"BigInt64Array",
"BigUint64Array"
],
"rules": { "rules": {
"@typescript-eslint/promise-function-async": "off",
"@typescript-eslint/no-empty-function": "off", "@typescript-eslint/no-empty-function": "off",
"@typescript-eslint/explicit-function-return-type": "off" "@typescript-eslint/explicit-function-return-type": "off",
"@typescript-eslint/triple-slash-reference": "off"
} }
} }
} }

8
readme.md
View file

@ -24,7 +24,7 @@ npm install @sindresorhus/is
## Usage ## Usage
```js ```js
const is = require('@sindresorhus/is'); import is from '@sindresorhus/is';
is('🦄'); is('🦄');
//=> 'string' //=> 'string'
@ -39,7 +39,7 @@ is.number(6);
[Assertions](#type-assertions) perform the same type checks, but throw an error if the type does not match. [Assertions](#type-assertions) perform the same type checks, but throw an error if the type does not match.
```js ```js
const {assert} = require('@sindresorhus/is'); import {assert} from '@sindresorhus/is';
assert.string(2); assert.string(2);
//=> Error: Expected value which is `string`, received value of type `number`. //=> Error: Expected value which is `string`, received value of type `number`.
@ -436,7 +436,7 @@ Returns `true` if `value` is a DOM Element.
Returns `true` if `value` is a Node.js [stream](https://nodejs.org/api/stream.html). Returns `true` if `value` is a Node.js [stream](https://nodejs.org/api/stream.html).
```js ```js
const fs = require('fs'); import fs from 'node:fs';
is.nodeStream(fs.createReadStream('unicorn.png')); is.nodeStream(fs.createReadStream('unicorn.png'));
//=> true //=> true
@ -447,7 +447,7 @@ is.nodeStream(fs.createReadStream('unicorn.png'));
Returns `true` if `value` is an `Observable`. Returns `true` if `value` is an `Observable`.
```js ```js
const {Observable} = require('rxjs'); import {Observable} from 'rxjs';
is.observable(new Observable()); is.observable(new Observable());
//=> true //=> true

155
source/index.ts
View file

@ -1,8 +1,5 @@
/// <reference lib="es2018"/> import type {Buffer} from 'node:buffer';
/// <reference lib="dom"/> import type {Class, Falsy, TypedArray, ObservableLike, Primitive} from './types.js';
/// <reference types="node"/>
import {Class, Falsy, TypedArray, ObservableLike, Primitive} from './types';
const typedArrayTypeNames = [ const typedArrayTypeNames = [
'Int8Array', 'Int8Array',
@ -15,7 +12,7 @@ const typedArrayTypeNames = [
'Float32Array', 'Float32Array',
'Float64Array', 'Float64Array',
'BigInt64Array', 'BigInt64Array',
'BigUint64Array' 'BigUint64Array',
] as const; ] as const;
type TypedArrayTypeName = typeof typedArrayTypeNames[number]; type TypedArrayTypeName = typeof typedArrayTypeNames[number];
@ -52,7 +49,7 @@ const objectTypeNames = [
'URLSearchParams', 'URLSearchParams',
'HTMLElement', 'HTMLElement',
'NaN', 'NaN',
...typedArrayTypeNames ...typedArrayTypeNames,
] as const; ] as const;
type ObjectTypeName = typeof objectTypeNames[number]; type ObjectTypeName = typeof objectTypeNames[number];
@ -68,7 +65,7 @@ const primitiveTypeNames = [
'number', 'number',
'bigint', 'bigint',
'boolean', 'boolean',
'symbol' 'symbol',
] as const; ] as const;
type PrimitiveTypeName = typeof primitiveTypeNames[number]; type PrimitiveTypeName = typeof primitiveTypeNames[number];
@ -149,6 +146,7 @@ function is(value: unknown): TypeName {
} }
is.undefined = isOfType<undefined>('undefined'); is.undefined = isOfType<undefined>('undefined');
is.string = isOfType<string>('string'); is.string = isOfType<string>('string');
const isNumberType = isOfType<number>('number'); const isNumberType = isOfType<number>('number');
@ -159,9 +157,13 @@ is.bigint = isOfType<bigint>('bigint');
// eslint-disable-next-line @typescript-eslint/ban-types // eslint-disable-next-line @typescript-eslint/ban-types
is.function_ = isOfType<Function>('function'); is.function_ = isOfType<Function>('function');
// eslint-disable-next-line @typescript-eslint/ban-types
is.null_ = (value: unknown): value is null => value === null; is.null_ = (value: unknown): value is null => value === null;
is.class_ = (value: unknown): value is Class => is.function_(value) && value.toString().startsWith('class '); is.class_ = (value: unknown): value is Class => is.function_(value) && value.toString().startsWith('class ');
is.boolean = (value: unknown): value is boolean => value === true || value === false; is.boolean = (value: unknown): value is boolean => value === true || value === false;
is.symbol = isOfType<symbol>('symbol'); is.symbol = isOfType<symbol>('symbol');
is.numericString = (value: unknown): value is string => is.numericString = (value: unknown): value is string =>
@ -176,14 +178,18 @@ is.array = <T = unknown>(value: unknown, assertion?: (value: T) => value is T):
return true; return true;
} }
return value.every(assertion); return value.every(element => assertion(element));
}; };
// eslint-disable-next-line @typescript-eslint/no-unsafe-return, @typescript-eslint/no-unsafe-call
is.buffer = (value: unknown): value is Buffer => (value as any)?.constructor?.isBuffer?.(value) ?? false; is.buffer = (value: unknown): value is Buffer => (value as any)?.constructor?.isBuffer?.(value) ?? false;
is.blob = (value: unknown): value is Blob => isObjectOfType<Blob>('Blob')(value); is.blob = (value: unknown): value is Blob => isObjectOfType<Blob>('Blob')(value);
is.nullOrUndefined = (value: unknown): value is null | undefined => is.null_(value) || is.undefined(value); is.nullOrUndefined = (value: unknown): value is null | undefined => is.null_(value) || is.undefined(value); // eslint-disable-line @typescript-eslint/ban-types
is.object = (value: unknown): value is object => !is.null_(value) && (typeof value === 'object' || is.function_(value));
is.object = (value: unknown): value is object => !is.null_(value) && (typeof value === 'object' || is.function_(value)); // eslint-disable-line @typescript-eslint/ban-types
is.iterable = <T = unknown>(value: unknown): value is Iterable<T> => is.function_((value as Iterable<T>)?.[Symbol.iterator]); is.iterable = <T = unknown>(value: unknown): value is Iterable<T> => is.function_((value as Iterable<T>)?.[Symbol.iterator]);
is.asyncIterable = <T = unknown>(value: unknown): value is AsyncIterable<T> => is.function_((value as AsyncIterable<T>)?.[Symbol.asyncIterator]); is.asyncIterable = <T = unknown>(value: unknown): value is AsyncIterable<T> => is.function_((value as AsyncIterable<T>)?.[Symbol.asyncIterator]);
@ -195,11 +201,11 @@ is.asyncGenerator = (value: unknown): value is AsyncGenerator => is.asyncIterabl
is.nativePromise = <T = unknown>(value: unknown): value is Promise<T> => is.nativePromise = <T = unknown>(value: unknown): value is Promise<T> =>
isObjectOfType<Promise<T>>('Promise')(value); isObjectOfType<Promise<T>>('Promise')(value);
const hasPromiseAPI = <T = unknown>(value: unknown): value is Promise<T> => const hasPromiseApi = <T = unknown>(value: unknown): value is Promise<T> =>
is.function_((value as Promise<T>)?.then) && is.function_((value as Promise<T>)?.then)
is.function_((value as Promise<T>)?.catch); && is.function_((value as Promise<T>)?.catch);
is.promise = <T = unknown>(value: unknown): value is Promise<T> => is.nativePromise(value) || hasPromiseAPI(value); is.promise = <T = unknown>(value: unknown): value is Promise<T> => is.nativePromise(value) || hasPromiseApi(value);
is.generatorFunction = isObjectOfType<GeneratorFunction>('GeneratorFunction'); is.generatorFunction = isObjectOfType<GeneratorFunction>('GeneratorFunction');
@ -211,12 +217,18 @@ is.asyncFunction = <T = unknown>(value: unknown): value is ((...args: any[]) =>
is.boundFunction = (value: unknown): value is Function => is.function_(value) && !value.hasOwnProperty('prototype'); is.boundFunction = (value: unknown): value is Function => is.function_(value) && !value.hasOwnProperty('prototype');
is.regExp = isObjectOfType<RegExp>('RegExp'); is.regExp = isObjectOfType<RegExp>('RegExp');
is.date = isObjectOfType<Date>('Date'); is.date = isObjectOfType<Date>('Date');
is.error = isObjectOfType<Error>('Error'); is.error = isObjectOfType<Error>('Error');
is.map = <Key = unknown, Value = unknown>(value: unknown): value is Map<Key, Value> => isObjectOfType<Map<Key, Value>>('Map')(value); is.map = <Key = unknown, Value = unknown>(value: unknown): value is Map<Key, Value> => isObjectOfType<Map<Key, Value>>('Map')(value);
is.set = <T = unknown>(value: unknown): value is Set<T> => isObjectOfType<Set<T>>('Set')(value); is.set = <T = unknown>(value: unknown): value is Set<T> => isObjectOfType<Set<T>>('Set')(value);
is.weakMap = <Key extends object = object, Value = unknown>(value: unknown): value is WeakMap<Key, Value> => isObjectOfType<WeakMap<Key, Value>>('WeakMap')(value);
is.weakSet = (value: unknown): value is WeakSet<object> => isObjectOfType<WeakSet<object>>('WeakSet')(value); is.weakMap = <Key extends object = object, Value = unknown>(value: unknown): value is WeakMap<Key, Value> => isObjectOfType<WeakMap<Key, Value>>('WeakMap')(value); // eslint-disable-line @typescript-eslint/ban-types
is.weakSet = (value: unknown): value is WeakSet<object> => isObjectOfType<WeakSet<object>>('WeakSet')(value); // eslint-disable-line @typescript-eslint/ban-types
is.int8Array = isObjectOfType<Int8Array>('Int8Array'); is.int8Array = isObjectOfType<Int8Array>('Int8Array');
is.uint8Array = isObjectOfType<Uint8Array>('Uint8Array'); is.uint8Array = isObjectOfType<Uint8Array>('Uint8Array');
@ -231,11 +243,15 @@ is.bigInt64Array = isObjectOfType<BigInt64Array>('BigInt64Array');
is.bigUint64Array = isObjectOfType<BigUint64Array>('BigUint64Array'); is.bigUint64Array = isObjectOfType<BigUint64Array>('BigUint64Array');
is.arrayBuffer = isObjectOfType<ArrayBuffer>('ArrayBuffer'); is.arrayBuffer = isObjectOfType<ArrayBuffer>('ArrayBuffer');
is.sharedArrayBuffer = isObjectOfType<SharedArrayBuffer>('SharedArrayBuffer'); is.sharedArrayBuffer = isObjectOfType<SharedArrayBuffer>('SharedArrayBuffer');
is.dataView = isObjectOfType<DataView>('DataView'); is.dataView = isObjectOfType<DataView>('DataView');
is.enumCase = <T = unknown>(value: unknown, targetEnum: T) => Object.values(targetEnum).includes(value as string); is.enumCase = <T = unknown>(value: unknown, targetEnum: T) => Object.values(targetEnum).includes(value as string);
is.directInstanceOf = <T>(instance: unknown, class_: Class<T>): instance is T => Object.getPrototypeOf(instance) === class_.prototype; is.directInstanceOf = <T>(instance: unknown, class_: Class<T>): instance is T => Object.getPrototypeOf(instance) === class_.prototype;
is.urlInstance = (value: unknown): value is URL => isObjectOfType<URL>('URL')(value); is.urlInstance = (value: unknown): value is URL => isObjectOfType<URL>('URL')(value);
is.urlString = (value: unknown): value is string => { is.urlString = (value: unknown): value is string => {
@ -252,7 +268,8 @@ is.urlString = (value: unknown): value is string => {
}; };
// Example: `is.truthy = (value: unknown): value is (not false | not 0 | not '' | not undefined | not null) => Boolean(value);` // Example: `is.truthy = (value: unknown): value is (not false | not 0 | not '' | not undefined | not null) => Boolean(value);`
is.truthy = <T>(value: T | Falsy): value is T => Boolean(value); is.truthy = <T>(value: T | Falsy): value is T => Boolean(value); // eslint-disable-line unicorn/prefer-native-coercion-functions
// Example: `is.falsy = (value: unknown): value is (not true | 0 | '' | undefined | null) => Boolean(value);` // Example: `is.falsy = (value: unknown): value is (not true | 0 | '' | undefined | null) => Boolean(value);`
is.falsy = <T>(value: T | Falsy): value is Falsy => !value; is.falsy = <T>(value: T | Falsy): value is Falsy => !value;
@ -261,6 +278,7 @@ is.nan = (value: unknown) => Number.isNaN(value as number);
is.primitive = (value: unknown): value is Primitive => is.null_(value) || isPrimitiveTypeName(typeof value); is.primitive = (value: unknown): value is Primitive => is.null_(value) || isPrimitiveTypeName(typeof value);
is.integer = (value: unknown): value is number => Number.isInteger(value as number); is.integer = (value: unknown): value is number => Number.isInteger(value as number);
is.safeInteger = (value: unknown): value is number => Number.isSafeInteger(value as number); is.safeInteger = (value: unknown): value is number => Number.isSafeInteger(value as number);
is.plainObject = <Value = unknown>(value: unknown): value is Record<PropertyKey, Value> => { is.plainObject = <Value = unknown>(value: unknown): value is Record<PropertyKey, Value> => {
@ -269,6 +287,7 @@ is.plainObject = <Value = unknown>(value: unknown): value is Record<PropertyKey,
return false; return false;
} }
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
const prototype = Object.getPrototypeOf(value); const prototype = Object.getPrototypeOf(value);
return prototype === null || prototype === Object.getPrototypeOf({}); return prototype === null || prototype === Object.getPrototypeOf({});
@ -296,33 +315,35 @@ is.inRange = (value: number, range: number | number[]): value is number => {
throw new TypeError(`Invalid range: ${JSON.stringify(range)}`); throw new TypeError(`Invalid range: ${JSON.stringify(range)}`);
}; };
// eslint-disable-next-line @typescript-eslint/naming-convention
const NODE_TYPE_ELEMENT = 1; const NODE_TYPE_ELEMENT = 1;
// eslint-disable-next-line @typescript-eslint/naming-convention
const DOM_PROPERTIES_TO_CHECK: Array<(keyof HTMLElement)> = [ const DOM_PROPERTIES_TO_CHECK: Array<(keyof HTMLElement)> = [
'innerHTML', 'innerHTML',
'ownerDocument', 'ownerDocument',
'style', 'style',
'attributes', 'attributes',
'nodeValue' 'nodeValue',
]; ];
is.domElement = (value: unknown): value is HTMLElement => { is.domElement = (value: unknown): value is HTMLElement => is.object(value)
return is.object(value) && && (value as HTMLElement).nodeType === NODE_TYPE_ELEMENT
(value as HTMLElement).nodeType === NODE_TYPE_ELEMENT && && is.string((value as HTMLElement).nodeName)
is.string((value as HTMLElement).nodeName) && && !is.plainObject(value)
!is.plainObject(value) && && DOM_PROPERTIES_TO_CHECK.every(property => property in value);
DOM_PROPERTIES_TO_CHECK.every(property => property in value);
};
is.observable = (value: unknown): value is ObservableLike => { is.observable = (value: unknown): value is ObservableLike => {
if (!value) { if (!value) {
return false; return false;
} }
// eslint-disable-next-line no-use-extend-native/no-use-extend-native // eslint-disable-next-line no-use-extend-native/no-use-extend-native, @typescript-eslint/no-unsafe-call
if (value === (value as any)[Symbol.observable]?.()) { if (value === (value as any)[Symbol.observable]?.()) {
return true; return true;
} }
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
if (value === (value as any)['@@observable']?.()) { if (value === (value as any)['@@observable']?.()) {
return true; return true;
} }
@ -336,13 +357,14 @@ export interface NodeStream extends NodeJS.EventEmitter {
is.nodeStream = (value: unknown): value is NodeStream => is.object(value) && is.function_((value as NodeStream).pipe) && !is.observable(value); is.nodeStream = (value: unknown): value is NodeStream => is.object(value) && is.function_((value as NodeStream).pipe) && !is.observable(value);
is.infinite = (value: unknown): value is number => value === Infinity || value === -Infinity; is.infinite = (value: unknown): value is number => value === Number.POSITIVE_INFINITY || value === Number.NEGATIVE_INFINITY;
const isAbsoluteMod2 = (remainder: number) => (value: number): value is number => is.integer(value) && Math.abs(value % 2) === remainder; const isAbsoluteMod2 = (remainder: number) => (value: number): value is number => is.integer(value) && Math.abs(value % 2) === remainder;
is.evenInteger = isAbsoluteMod2(0); is.evenInteger = isAbsoluteMod2(0);
is.oddInteger = isAbsoluteMod2(1); is.oddInteger = isAbsoluteMod2(1);
is.emptyArray = (value: unknown): value is never[] => is.array(value) && value.length === 0; is.emptyArray = (value: unknown): value is never[] => is.array(value) && value.length === 0;
is.nonEmptyArray = (value: unknown): value is unknown[] => is.array(value) && value.length > 0; is.nonEmptyArray = (value: unknown): value is unknown[] => is.array(value) && value.length > 0;
is.emptyString = (value: unknown): value is '' => is.string(value) && value.length === 0; is.emptyString = (value: unknown): value is '' => is.string(value) && value.length === 0;
@ -356,20 +378,27 @@ is.nonEmptyString = (value: unknown): value is string => is.string(value) && val
// TODO: Use `not ''` when the `not` operator is available. // TODO: Use `not ''` when the `not` operator is available.
is.nonEmptyStringAndNotWhitespace = (value: unknown): value is string => is.string(value) && !is.emptyStringOrWhitespace(value); is.nonEmptyStringAndNotWhitespace = (value: unknown): value is string => is.string(value) && !is.emptyStringOrWhitespace(value);
// eslint-disable-next-line unicorn/no-array-callback-reference
is.emptyObject = <Key extends keyof any = string>(value: unknown): value is Record<Key, never> => is.object(value) && !is.map(value) && !is.set(value) && Object.keys(value).length === 0; is.emptyObject = <Key extends keyof any = string>(value: unknown): value is Record<Key, never> => is.object(value) && !is.map(value) && !is.set(value) && Object.keys(value).length === 0;
// TODO: Use `not` operator here to remove `Map` and `Set` from type guard: // TODO: Use `not` operator here to remove `Map` and `Set` from type guard:
// - https://github.com/Microsoft/TypeScript/pull/29317 // - https://github.com/Microsoft/TypeScript/pull/29317
// eslint-disable-next-line unicorn/no-array-callback-reference
is.nonEmptyObject = <Key extends keyof any = string, Value = unknown>(value: unknown): value is Record<Key, Value> => is.object(value) && !is.map(value) && !is.set(value) && Object.keys(value).length > 0; is.nonEmptyObject = <Key extends keyof any = string, Value = unknown>(value: unknown): value is Record<Key, Value> => is.object(value) && !is.map(value) && !is.set(value) && Object.keys(value).length > 0;
is.emptySet = (value: unknown): value is Set<never> => is.set(value) && value.size === 0; is.emptySet = (value: unknown): value is Set<never> => is.set(value) && value.size === 0;
is.nonEmptySet = <T = unknown>(value: unknown): value is Set<T> => is.set(value) && value.size > 0; is.nonEmptySet = <T = unknown>(value: unknown): value is Set<T> => is.set(value) && value.size > 0;
// eslint-disable-next-line unicorn/no-array-callback-reference
is.emptyMap = (value: unknown): value is Map<never, never> => is.map(value) && value.size === 0; is.emptyMap = (value: unknown): value is Map<never, never> => is.map(value) && value.size === 0;
// eslint-disable-next-line unicorn/no-array-callback-reference
is.nonEmptyMap = <Key = unknown, Value = unknown>(value: unknown): value is Map<Key, Value> => is.map(value) && value.size > 0; is.nonEmptyMap = <Key = unknown, Value = unknown>(value: unknown): value is Map<Key, Value> => is.map(value) && value.size > 0;
// `PropertyKey` is any value that can be used as an object key (string, number, or symbol) // `PropertyKey` is any value that can be used as an object key (string, number, or symbol)
is.propertyKey = (value: unknown): value is PropertyKey => is.any([is.string, is.number, is.symbol], value); is.propertyKey = (value: unknown): value is PropertyKey => is.any([is.string, is.number, is.symbol], value);
is.formData = (value: unknown): value is FormData => isObjectOfType<FormData>('FormData')(value); is.formData = (value: unknown): value is FormData => isObjectOfType<FormData>('FormData')(value);
is.urlSearchParams = (value: unknown): value is URLSearchParams => isObjectOfType<URLSearchParams>('URLSearchParams')(value); is.urlSearchParams = (value: unknown): value is URLSearchParams => isObjectOfType<URLSearchParams>('URLSearchParams')(value);
@ -393,7 +422,7 @@ const predicateOnArray = (method: ArrayMethod, predicate: Predicate, values: unk
is.any = (predicate: Predicate | Predicate[], ...values: unknown[]): boolean => { is.any = (predicate: Predicate | Predicate[], ...values: unknown[]): boolean => {
const predicates = is.array(predicate) ? predicate : [predicate]; const predicates = is.array(predicate) ? predicate : [predicate];
return predicates.some(singlePredicate => return predicates.some(singlePredicate =>
predicateOnArray(Array.prototype.some, singlePredicate, values) predicateOnArray(Array.prototype.some, singlePredicate, values),
); );
}; };
@ -402,13 +431,13 @@ is.all = (predicate: Predicate, ...values: unknown[]): boolean => predicateOnArr
const assertType = (condition: boolean, description: string, value: unknown, options: {multipleValues?: boolean} = {}): asserts condition => { const assertType = (condition: boolean, description: string, value: unknown, options: {multipleValues?: boolean} = {}): asserts condition => {
if (!condition) { if (!condition) {
const {multipleValues} = options; const {multipleValues} = options;
const valuesMessage = multipleValues ? const valuesMessage = multipleValues
`received values of types ${[ ? `received values of types ${[
...new Set( ...new Set(
(value as any[]).map(singleValue => `\`${is(singleValue)}\``) (value as any[]).map(singleValue => `\`${is(singleValue)}\``),
) ),
].join(', ')}` : ].join(', ')}`
`received value of type \`${is(value)}\``; : `received value of type \`${is(value)}\``;
throw new TypeError(`Expected value which is \`${description}\`, ${valuesMessage}.`); throw new TypeError(`Expected value which is \`${description}\`, ${valuesMessage}.`);
} }
@ -427,7 +456,7 @@ export const enum AssertionTypeDescription {
nan = 'NaN', nan = 'NaN',
primitive = 'primitive', primitive = 'primitive',
integer = 'integer', integer = 'integer',
safeInteger = 'integer', safeInteger = 'integer', // eslint-disable-line @typescript-eslint/no-duplicate-enum-values
plainObject = 'plain object', plainObject = 'plain object',
arrayLike = 'array-like', arrayLike = 'array-like',
typedArray = 'TypedArray', typedArray = 'TypedArray',
@ -466,7 +495,7 @@ interface Assert {
bigint: (value: unknown) => asserts value is bigint; bigint: (value: unknown) => asserts value is bigint;
// eslint-disable-next-line @typescript-eslint/ban-types // eslint-disable-next-line @typescript-eslint/ban-types
function_: (value: unknown) => asserts value is Function; function_: (value: unknown) => asserts value is Function;
null_: (value: unknown) => asserts value is null; null_: (value: unknown) => asserts value is null; // eslint-disable-line @typescript-eslint/ban-types
class_: (value: unknown) => asserts value is Class; class_: (value: unknown) => asserts value is Class;
boolean: (value: unknown) => asserts value is boolean; boolean: (value: unknown) => asserts value is boolean;
symbol: (value: unknown) => asserts value is symbol; symbol: (value: unknown) => asserts value is symbol;
@ -474,7 +503,7 @@ interface Assert {
array: <T = unknown>(value: unknown, assertion?: (element: unknown) => asserts element is T) => asserts value is T[]; array: <T = unknown>(value: unknown, assertion?: (element: unknown) => asserts element is T) => asserts value is T[];
buffer: (value: unknown) => asserts value is Buffer; buffer: (value: unknown) => asserts value is Buffer;
blob: (value: unknown) => asserts value is Blob; blob: (value: unknown) => asserts value is Blob;
nullOrUndefined: (value: unknown) => asserts value is null | undefined; nullOrUndefined: (value: unknown) => asserts value is null | undefined; // eslint-disable-line @typescript-eslint/ban-types
object: <Key extends keyof any = string, Value = unknown>(value: unknown) => asserts value is Record<Key, Value>; object: <Key extends keyof any = string, Value = unknown>(value: unknown) => asserts value is Record<Key, Value>;
iterable: <T = unknown>(value: unknown) => asserts value is Iterable<T>; iterable: <T = unknown>(value: unknown) => asserts value is Iterable<T>;
asyncIterable: <T = unknown>(value: unknown) => asserts value is AsyncIterable<T>; asyncIterable: <T = unknown>(value: unknown) => asserts value is AsyncIterable<T>;
@ -493,8 +522,8 @@ interface Assert {
error: (value: unknown) => asserts value is Error; error: (value: unknown) => asserts value is Error;
map: <Key = unknown, Value = unknown>(value: unknown) => asserts value is Map<Key, Value>; map: <Key = unknown, Value = unknown>(value: unknown) => asserts value is Map<Key, Value>;
set: <T = unknown>(value: unknown) => asserts value is Set<T>; set: <T = unknown>(value: unknown) => asserts value is Set<T>;
weakMap: <Key extends object = object, Value = unknown>(value: unknown) => asserts value is WeakMap<Key, Value>; weakMap: <Key extends object = object, Value = unknown>(value: unknown) => asserts value is WeakMap<Key, Value>; // eslint-disable-line @typescript-eslint/ban-types
weakSet: <T extends object = object>(value: unknown) => asserts value is WeakSet<T>; weakSet: <T extends object = object>(value: unknown) => asserts value is WeakSet<T>; // eslint-disable-line @typescript-eslint/ban-types
int8Array: (value: unknown) => asserts value is Int8Array; int8Array: (value: unknown) => asserts value is Int8Array;
uint8Array: (value: unknown) => asserts value is Uint8Array; uint8Array: (value: unknown) => asserts value is Uint8Array;
uint8ClampedArray: (value: unknown) => asserts value is Uint8ClampedArray; uint8ClampedArray: (value: unknown) => asserts value is Uint8ClampedArray;
@ -554,6 +583,7 @@ interface Assert {
all: (predicate: Predicate, ...values: unknown[]) => void | never; all: (predicate: Predicate, ...values: unknown[]) => void | never;
} }
/* eslint-disable @typescript-eslint/no-confusing-void-expression */
export const assert: Assert = { export const assert: Assert = {
// Unknowns. // Unknowns.
undefined: (value: unknown): asserts value is undefined => assertType(is.undefined(value), 'undefined', value), undefined: (value: unknown): asserts value is undefined => assertType(is.undefined(value), 'undefined', value),
@ -562,23 +592,24 @@ export const assert: Assert = {
bigint: (value: unknown): asserts value is bigint => assertType(is.bigint(value), 'bigint', value), bigint: (value: unknown): asserts value is bigint => assertType(is.bigint(value), 'bigint', value),
// eslint-disable-next-line @typescript-eslint/ban-types // eslint-disable-next-line @typescript-eslint/ban-types
function_: (value: unknown): asserts value is Function => assertType(is.function_(value), 'Function', value), function_: (value: unknown): asserts value is Function => assertType(is.function_(value), 'Function', value),
null_: (value: unknown): asserts value is null => assertType(is.null_(value), 'null', value), null_: (value: unknown): asserts value is null => assertType(is.null_(value), 'null', value), // eslint-disable-line @typescript-eslint/ban-types
class_: (value: unknown): asserts value is Class => assertType(is.class_(value), AssertionTypeDescription.class_, value), class_: (value: unknown): asserts value is Class => assertType(is.class_(value), AssertionTypeDescription.class_, value),
boolean: (value: unknown): asserts value is boolean => assertType(is.boolean(value), 'boolean', value), boolean: (value: unknown): asserts value is boolean => assertType(is.boolean(value), 'boolean', value),
symbol: (value: unknown): asserts value is symbol => assertType(is.symbol(value), 'symbol', value), symbol: (value: unknown): asserts value is symbol => assertType(is.symbol(value), 'symbol', value),
numericString: (value: unknown): asserts value is string => assertType(is.numericString(value), AssertionTypeDescription.numericString, value), numericString: (value: unknown): asserts value is string => assertType(is.numericString(value), AssertionTypeDescription.numericString, value),
array: <T = unknown>(value: unknown, assertion?: (element: unknown) => asserts element is T): asserts value is T[] => { array: <T = unknown>(value: unknown, assertion?: (element: unknown) => asserts element is T): asserts value is T[] => { // eslint-disable-line object-shorthand
const assert: (condition: boolean, description: string, value: unknown) => asserts condition = assertType; const assert: (condition: boolean, description: string, value: unknown) => asserts condition = assertType;
assert(is.array(value), 'Array', value); assert(is.array(value), 'Array', value);
if (assertion) { if (assertion) {
// eslint-disable-next-line unicorn/no-array-for-each, unicorn/no-array-callback-reference
value.forEach(assertion); value.forEach(assertion);
} }
}, },
buffer: (value: unknown): asserts value is Buffer => assertType(is.buffer(value), 'Buffer', value), buffer: (value: unknown): asserts value is Buffer => assertType(is.buffer(value), 'Buffer', value),
blob: (value: unknown): asserts value is Blob => assertType(is.blob(value), 'Blob', value), blob: (value: unknown): asserts value is Blob => assertType(is.blob(value), 'Blob', value),
nullOrUndefined: (value: unknown): asserts value is null | undefined => assertType(is.nullOrUndefined(value), AssertionTypeDescription.nullOrUndefined, value), nullOrUndefined: (value: unknown): asserts value is null | undefined => assertType(is.nullOrUndefined(value), AssertionTypeDescription.nullOrUndefined, value), // eslint-disable-line @typescript-eslint/ban-types
object: (value: unknown): asserts value is object => assertType(is.object(value), 'Object', value), object: (value: unknown): asserts value is object => assertType(is.object(value), 'Object', value), // eslint-disable-line @typescript-eslint/ban-types
iterable: <T = unknown>(value: unknown): asserts value is Iterable<T> => assertType(is.iterable(value), AssertionTypeDescription.iterable, value), iterable: <T = unknown>(value: unknown): asserts value is Iterable<T> => assertType(is.iterable(value), AssertionTypeDescription.iterable, value),
asyncIterable: <T = unknown>(value: unknown): asserts value is AsyncIterable<T> => assertType(is.asyncIterable(value), AssertionTypeDescription.asyncIterable, value), asyncIterable: <T = unknown>(value: unknown): asserts value is AsyncIterable<T> => assertType(is.asyncIterable(value), AssertionTypeDescription.asyncIterable, value),
generator: (value: unknown): asserts value is Generator => assertType(is.generator(value), 'Generator', value), generator: (value: unknown): asserts value is Generator => assertType(is.generator(value), 'Generator', value),
@ -594,10 +625,10 @@ export const assert: Assert = {
regExp: (value: unknown): asserts value is RegExp => assertType(is.regExp(value), 'RegExp', value), regExp: (value: unknown): asserts value is RegExp => assertType(is.regExp(value), 'RegExp', value),
date: (value: unknown): asserts value is Date => assertType(is.date(value), 'Date', value), date: (value: unknown): asserts value is Date => assertType(is.date(value), 'Date', value),
error: (value: unknown): asserts value is Error => assertType(is.error(value), 'Error', value), error: (value: unknown): asserts value is Error => assertType(is.error(value), 'Error', value),
map: <Key = unknown, Value = unknown>(value: unknown): asserts value is Map<Key, Value> => assertType(is.map(value), 'Map', value), map: <Key = unknown, Value = unknown>(value: unknown): asserts value is Map<Key, Value> => assertType(is.map(value), 'Map', value), // eslint-disable-line unicorn/no-array-callback-reference
set: <T = unknown>(value: unknown): asserts value is Set<T> => assertType(is.set(value), 'Set', value), set: <T = unknown>(value: unknown): asserts value is Set<T> => assertType(is.set(value), 'Set', value),
weakMap: <Key extends object = object, Value = unknown>(value: unknown): asserts value is WeakMap<Key, Value> => assertType(is.weakMap(value), 'WeakMap', value), weakMap: <Key extends object = object, Value = unknown>(value: unknown): asserts value is WeakMap<Key, Value> => assertType(is.weakMap(value), 'WeakMap', value), // eslint-disable-line @typescript-eslint/ban-types
weakSet: <T extends object = object>(value: unknown): asserts value is WeakSet<T> => assertType(is.weakSet(value), 'WeakSet', value), weakSet: <T extends object = object>(value: unknown): asserts value is WeakSet<T> => assertType(is.weakSet(value), 'WeakSet', value), // eslint-disable-line @typescript-eslint/ban-types
int8Array: (value: unknown): asserts value is Int8Array => assertType(is.int8Array(value), 'Int8Array', value), int8Array: (value: unknown): asserts value is Int8Array => assertType(is.int8Array(value), 'Int8Array', value),
uint8Array: (value: unknown): asserts value is Uint8Array => assertType(is.uint8Array(value), 'Uint8Array', value), uint8Array: (value: unknown): asserts value is Uint8Array => assertType(is.uint8Array(value), 'Uint8Array', value),
uint8ClampedArray: (value: unknown): asserts value is Uint8ClampedArray => assertType(is.uint8ClampedArray(value), 'Uint8ClampedArray', value), uint8ClampedArray: (value: unknown): asserts value is Uint8ClampedArray => assertType(is.uint8ClampedArray(value), 'Uint8ClampedArray', value),
@ -653,42 +684,36 @@ export const assert: Assert = {
inRange: (value: number, range: number | number[]): asserts value is number => assertType(is.inRange(value, range), AssertionTypeDescription.inRange, value), inRange: (value: number, range: number | number[]): asserts value is number => assertType(is.inRange(value, range), AssertionTypeDescription.inRange, value),
// Variadic functions. // Variadic functions.
any: (predicate: Predicate | Predicate[], ...values: unknown[]): void | never => { any: (predicate: Predicate | Predicate[], ...values: unknown[]): void | never => assertType(is.any(predicate, ...values), AssertionTypeDescription.any, values, {multipleValues: true}),
return assertType(is.any(predicate, ...values), AssertionTypeDescription.any, values, {multipleValues: true}); all: (predicate: Predicate, ...values: unknown[]): void | never => assertType(is.all(predicate, ...values), AssertionTypeDescription.all, values, {multipleValues: true}),
},
all: (predicate: Predicate, ...values: unknown[]): void | never => assertType(is.all(predicate, ...values), AssertionTypeDescription.all, values, {multipleValues: true})
}; };
/* eslint-enable @typescript-eslint/no-confusing-void-expression */
// Some few keywords are reserved, but we'll populate them for Node.js users // Some few keywords are reserved, but we'll populate them for Node.js users
// See https://github.com/Microsoft/TypeScript/issues/2536 // See https://github.com/Microsoft/TypeScript/issues/2536
Object.defineProperties(is, { Object.defineProperties(is, {
class: { class: {
value: is.class_ value: is.class_,
}, },
function: { function: {
value: is.function_ value: is.function_,
}, },
null: { null: {
value: is.null_ value: is.null_,
} },
}); });
Object.defineProperties(assert, { Object.defineProperties(assert, {
class: { class: {
value: assert.class_ value: assert.class_,
}, },
function: { function: {
value: assert.function_ value: assert.function_,
}, },
null: { null: {
value: assert.null_ value: assert.null_,
} },
}); });
export default is; export default is;
export {Class, TypedArray, ObservableLike, Primitive} from './types'; export type {Class, TypedArray, ObservableLike, Primitive} from './types.js';
// For CommonJS default export support
module.exports = is;
module.exports.default = is;
module.exports.assert = assert;

4
source/types.ts
View file

@ -4,7 +4,7 @@
Matches any [primitive value](https://developer.mozilla.org/en-US/docs/Glossary/Primitive). Matches any [primitive value](https://developer.mozilla.org/en-US/docs/Glossary/Primitive).
*/ */
export type Primitive = export type Primitive =
| null | null // eslint-disable-line @typescript-eslint/ban-types
| undefined | undefined
| string | string
| number | number
@ -12,7 +12,6 @@ export type Primitive =
| symbol | symbol
| bigint; | bigint;
// TODO: Remove the `= unknown` sometime in the future when most users are on TS 3.5 as it's now the default
/** /**
Matches a [`class` constructor](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes). Matches a [`class` constructor](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes).
*/ */
@ -48,4 +47,5 @@ export interface ObservableLike {
[Symbol.observable](): ObservableLike; [Symbol.observable](): ObservableLike;
} }
// eslint-disable-next-line @typescript-eslint/ban-types
export type Falsy = false | 0 | 0n | '' | null | undefined; export type Falsy = false | 0 | 0n | '' | null | undefined;

400
test/test.ts
View file

File diff suppressed because it is too large Load diff

14
tsconfig.json
View file

@ -1,14 +1,14 @@
{ {
"extends": "@sindresorhus/tsconfig", "extends": "@sindresorhus/tsconfig",
"compilerOptions": { "compilerOptions": {
"outDir": "dist", "outDir": "dist"
"target": "es2018",
"lib": [
"es2018",
"dom"
]
}, },
"include": [ "include": [
"source" "source"
] ],
"ts-node": {
"transpileOnly": true,
"files": true,
"experimentalResolver": true
}
} }

6
tsconfig.xo.json
View file

@ -1,6 +0,0 @@
{
"extends": "./tsconfig.json",
"include": [
"test"
]
}