diff --git a/package.json b/package.json index 746bfa5..92ee644 100644 --- a/package.json +++ b/package.json @@ -58,7 +58,7 @@ "tempy": "^0.2.1", "tslint": "^5.9.1", "tslint-xo": "^0.9.0", - "typescript": "^3.1.1", + "typescript": "^3.1.4", "zen-observable": "^0.8.8" }, "types": "dist/index.d.ts" diff --git a/source/index.ts b/source/index.ts index b8f397c..8b52bc1 100644 --- a/source/index.ts +++ b/source/index.ts @@ -11,7 +11,7 @@ export interface ArrayLike { length: number; } -export interface Class { +export interface Class { new(...args: any[]): T; } @@ -56,10 +56,10 @@ export const enum TypeName { } const toString = Object.prototype.toString; -const isOfType = (type: string) => (value: any): value is T => typeof value === type; -const isBuffer = (input: any): input is Buffer => !is.nullOrUndefined(input) && !is.nullOrUndefined(input.constructor) && is.function_(input.constructor.isBuffer) && input.constructor.isBuffer(input); +const isOfType = (type: string) => (value: unknown): value is T => typeof value === type; +const isBuffer = (input: unknown): input is Buffer => !is.nullOrUndefined(input) && !is.nullOrUndefined((input as Buffer).constructor) && is.function_((input as Buffer).constructor.isBuffer) && (input as Buffer).constructor.isBuffer(input); -const getObjectType = (value: any): TypeName | null => { +const getObjectType = (value: unknown): TypeName | null => { const objectName = toString.call(value).slice(8, -1) as string; if (objectName) { @@ -69,9 +69,9 @@ const getObjectType = (value: any): TypeName | null => { return null; }; -const isObjectOfType = (type: TypeName) => (value: any): value is T => getObjectType(value) === type; +const isObjectOfType = (type: TypeName) => (value: unknown): value is T => getObjectType(value) === type; -function is(value: any): TypeName { // tslint:disable-line:only-arrow-functions +function is(value: unknown): TypeName { // tslint:disable-line:only-arrow-functions switch (value) { case null: return TypeName.null; @@ -122,53 +122,55 @@ function is(value: any): TypeName { // tslint:disable-line:only-arrow-functions } namespace is { // tslint:disable-line:no-namespace - const isObject = (value: any): value is object => typeof value === 'object'; + // tslint:disable-next-line:strict-type-predicates + const isObject = (value: unknown): value is object => typeof value === 'object'; // tslint:disable:variable-name export const undefined = isOfType('undefined'); export const string = isOfType('string'); export const number = isOfType('number'); export const function_ = isOfType('function'); - export const null_ = (value: any): value is null => value === null; - export const class_ = (value: any): value is Class => function_(value) && value.toString().startsWith('class '); - export const boolean = (value: any): value is boolean => value === true || value === false; + // tslint:disable-next-line:strict-type-predicates + export const null_ = (value: unknown): value is null => value === null; + export const class_ = (value: unknown): value is Class => function_(value) && value.toString().startsWith('class '); + export const boolean = (value: unknown): value is boolean => value === true || value === false; export const symbol = isOfType('symbol'); // tslint:enable:variable-name - export const nullOrUndefined = (value: any): value is null | undefined => null_(value) || undefined(value); - export const numericString = (value: any): boolean => + export const numericString = (value: unknown): boolean => string(value) && value.length > 0 && !Number.isNaN(Number(value)); export const array = Array.isArray; export const buffer = isBuffer; - export const object = (value: any): value is object => !nullOrUndefined(value) && (function_(value) || isObject(value)); - export const iterable = (value: any): value is IterableIterator => !nullOrUndefined(value) && function_(value[Symbol.iterator]); - export const asyncIterable = (value: any): value is AsyncIterableIterator => !nullOrUndefined(value) && function_(value[Symbol.asyncIterator]); - export const generator = (value: any): value is Generator => iterable(value) && function_(value.next) && function_(value.throw); + export const nullOrUndefined = (value: unknown): value is null | undefined => null_(value) || undefined(value); + export const object = (value: unknown): value is object => !nullOrUndefined(value) && (function_(value) || isObject(value)); + export const iterable = (value: unknown): value is IterableIterator => !nullOrUndefined(value) && function_((value as IterableIterator)[Symbol.iterator]); + export const asyncIterable = (value: unknown): value is AsyncIterableIterator => !nullOrUndefined(value) && function_((value as AsyncIterableIterator)[Symbol.asyncIterator]); + export const generator = (value: unknown): value is Generator => iterable(value) && function_(value.next) && function_(value.throw); - export const nativePromise = (value: any): value is Promise => - isObjectOfType>(TypeName.Promise)(value); + export const nativePromise = (value: unknown): value is Promise => + isObjectOfType>(TypeName.Promise)(value); - const hasPromiseAPI = (value: any): value is Promise => + const hasPromiseAPI = (value: unknown): value is Promise => !null_(value) && - isObject(value) as any && - function_(value.then) && - function_(value.catch); + isObject(value) as unknown && + function_((value as Promise).then) && + function_((value as Promise).catch); - export const promise = (value: any): value is Promise => nativePromise(value) || hasPromiseAPI(value); + export const promise = (value: unknown): value is Promise => nativePromise(value) || hasPromiseAPI(value); export const generatorFunction = isObjectOfType(TypeName.GeneratorFunction); export const asyncFunction = isObjectOfType(TypeName.AsyncFunction); - export const boundFunction = (value: any): value is Function => function_(value) && !value.hasOwnProperty('prototype'); + export const boundFunction = (value: unknown): value is Function => function_(value) && !value.hasOwnProperty('prototype'); export const regExp = isObjectOfType(TypeName.RegExp); export const date = isObjectOfType(TypeName.Date); export const error = isObjectOfType(TypeName.Error); - export const map = (value: any): value is Map => isObjectOfType>(TypeName.Map)(value); - export const set = (value: any): value is Set => isObjectOfType>(TypeName.Set)(value); - export const weakMap = (value: any): value is WeakMap => isObjectOfType>(TypeName.WeakMap)(value); - export const weakSet = (value: any): value is WeakSet => isObjectOfType>(TypeName.WeakSet)(value); + export const map = (value: unknown): value is Map => isObjectOfType>(TypeName.Map)(value); + export const set = (value: unknown): value is Set => isObjectOfType>(TypeName.Set)(value); + export const weakMap = (value: unknown): value is WeakMap => isObjectOfType>(TypeName.WeakMap)(value); + export const weakSet = (value: unknown): value is WeakSet => isObjectOfType>(TypeName.WeakSet)(value); export const int8Array = isObjectOfType(TypeName.Int8Array); export const uint8Array = isObjectOfType(TypeName.Uint8Array); @@ -184,13 +186,13 @@ namespace is { // tslint:disable-line:no-namespace export const sharedArrayBuffer = isObjectOfType(TypeName.SharedArrayBuffer); export const dataView = isObjectOfType(TypeName.DataView); - export const directInstanceOf = (instance: any, klass: Class): instance is T => Object.getPrototypeOf(instance) === klass.prototype; - export const urlInstance = (value: any): value is URL => isObjectOfType(TypeName.URL)(value); + export const directInstanceOf = (instance: unknown, klass: Class): instance is T => Object.getPrototypeOf(instance) === klass.prototype; + export const urlInstance = (value: unknown): value is URL => isObjectOfType(TypeName.URL)(value); - export const truthy = (value: any) => Boolean(value); - export const falsy = (value: any) => !value; + export const truthy = (value: unknown) => Boolean(value); + export const falsy = (value: unknown) => !value; - export const nan = (value: any) => Number.isNaN(value); + export const nan = (value: unknown) => Number.isNaN(value as number); const primitiveTypes = new Set([ 'undefined', @@ -200,12 +202,12 @@ namespace is { // tslint:disable-line:no-namespace 'symbol' ]); - export const primitive = (value: any): value is Primitive => null_(value) || primitiveTypes.has(typeof value); + export const primitive = (value: unknown): value is Primitive => null_(value) || primitiveTypes.has(typeof value); - export const integer = (value: any): value is number => Number.isInteger(value); - export const safeInteger = (value: any): value is number => Number.isSafeInteger(value); + export const integer = (value: unknown): value is number => Number.isInteger(value as number); + export const safeInteger = (value: unknown): value is number => Number.isSafeInteger(value as number); - export const plainObject = (value: any) => { + export const plainObject = (value: unknown) => { // From: https://github.com/sindresorhus/is-plain-obj/blob/master/index.js let prototype; @@ -225,7 +227,7 @@ namespace is { // tslint:disable-line:no-namespace TypeName.Float32Array, TypeName.Float64Array ]); - export const typedArray = (value: any): value is TypedArray => { + export const typedArray = (value: unknown): value is TypedArray => { const objectType = getObjectType(value); if (objectType === null) { @@ -235,8 +237,8 @@ namespace is { // tslint:disable-line:no-namespace return typedArrayTypes.has(objectType); }; - const isValidLength = (value: any) => safeInteger(value) && value > -1; - export const arrayLike = (value: any): value is ArrayLike => !nullOrUndefined(value) && !function_(value) && isValidLength(value.length); + const isValidLength = (value: unknown) => safeInteger(value) && value > -1; + export const arrayLike = (value: unknown): value is ArrayLike => !nullOrUndefined(value) && !function_(value) && isValidLength((value as ArrayLike).length); export const inRange = (value: number, range: number | number[]) => { if (number(range)) { @@ -259,38 +261,38 @@ namespace is { // tslint:disable-line:no-namespace 'nodeValue' ]; - export const domElement = (value: any): value is DomElement => object(value) as any && value.nodeType === NODE_TYPE_ELEMENT && string(value.nodeName) && - !plainObject(value) && DOM_PROPERTIES_TO_CHECK.every(property => property in value); + export const domElement = (value: unknown): value is DomElement => object(value) && (value as DomElement).nodeType === NODE_TYPE_ELEMENT && string((value as DomElement).nodeName) && + !plainObject(value) && DOM_PROPERTIES_TO_CHECK.every(property => property in (value as DomElement)); - export const observable = (value: any) => Boolean(value && value[symbolObservable] && value === value[symbolObservable]()); - export const nodeStream = (value: any): value is NodeStream => !nullOrUndefined(value) && isObject(value) as any && function_(value.pipe) && !observable(value); + export const observable = (value: unknown) => Boolean(value && (value as any)[symbolObservable] && value === (value as any)[symbolObservable]()); + export const nodeStream = (value: unknown): value is NodeStream => !nullOrUndefined(value) && isObject(value) as unknown && function_((value as NodeStream).pipe) && !observable(value); - export const infinite = (value: any) => value === Infinity || value === -Infinity; + export const infinite = (value: unknown) => value === Infinity || value === -Infinity; const isAbsoluteMod2 = (rem: number) => (value: number) => integer(value) && Math.abs(value % 2) === rem; export const even = isAbsoluteMod2(0); export const odd = isAbsoluteMod2(1); - const isWhiteSpaceString = (value: any) => string(value) && /\S/.test(value) === false; + const isWhiteSpaceString = (value: unknown) => string(value) && /\S/.test(value) === false; - export const emptyArray = (value: any) => array(value) && value.length === 0; - export const nonEmptyArray = (value: any) => array(value) && value.length > 0; + export const emptyArray = (value: unknown) => array(value) && value.length === 0; + export const nonEmptyArray = (value: unknown) => array(value) && value.length > 0; - export const emptyString = (value: any) => string(value) && value.length === 0; - export const nonEmptyString = (value: any) => string(value) && value.length > 0; - export const emptyStringOrWhitespace = (value: any) => emptyString(value) || isWhiteSpaceString(value); + export const emptyString = (value: unknown) => string(value) && value.length === 0; + export const nonEmptyString = (value: unknown) => string(value) && value.length > 0; + export const emptyStringOrWhitespace = (value: unknown) => emptyString(value) || isWhiteSpaceString(value); - export const emptyObject = (value: any) => object(value) && !map(value) && !set(value) && Object.keys(value).length === 0; - export const nonEmptyObject = (value: any) => object(value) && !map(value) && !set(value) && Object.keys(value).length > 0; + export const emptyObject = (value: unknown) => object(value) && !map(value) && !set(value) && Object.keys(value).length === 0; + export const nonEmptyObject = (value: unknown) => object(value) && !map(value) && !set(value) && Object.keys(value).length > 0; - export const emptySet = (value: any) => set(value) && value.size === 0; - export const nonEmptySet = (value: any) => set(value) && value.size > 0; + export const emptySet = (value: unknown) => set(value) && value.size === 0; + export const nonEmptySet = (value: unknown) => set(value) && value.size > 0; - export const emptyMap = (value: any) => map(value) && value.size === 0; - export const nonEmptyMap = (value: any) => map(value) && value.size > 0; + export const emptyMap = (value: unknown) => map(value) && value.size === 0; + export const nonEmptyMap = (value: unknown) => map(value) && value.size > 0; - type ArrayMethod = (fn: (value: any, index: number, array: any[]) => boolean, thisArg?: any) => boolean; - const predicateOnArray = (method: ArrayMethod, predicate: any, values: any[]) => { + type ArrayMethod = (fn: (value: unknown, index: number, array: unknown[]) => boolean, thisArg?: unknown) => boolean; + const predicateOnArray = (method: ArrayMethod, predicate: unknown, values: unknown[]) => { if (function_(predicate) === false) { throw new TypeError(`Invalid predicate: ${JSON.stringify(predicate)}`); } @@ -303,8 +305,8 @@ namespace is { // tslint:disable-line:no-namespace }; // tslint:disable variable-name - export const any = (predicate: any, ...values: any[]) => predicateOnArray(Array.prototype.some, predicate, values); - export const all = (predicate: any, ...values: any[]) => predicateOnArray(Array.prototype.every, predicate, values); + export const any = (predicate: unknown, ...values: unknown[]) => predicateOnArray(Array.prototype.some, predicate, values); + export const all = (predicate: unknown, ...values: unknown[]) => predicateOnArray(Array.prototype.every, predicate, values); // tslint:enable variable-name } diff --git a/source/tests/test.ts b/source/tests/test.ts index a210807..4fcac81 100644 --- a/source/tests/test.ts +++ b/source/tests/test.ts @@ -21,8 +21,8 @@ const {document} = window; const createDomElement = (element: string) => document.createElement(element); interface Test { - is(value: any): boolean; - fixtures: any[]; + is(value: unknown): boolean; + fixtures: unknown[]; } const types = new Map([ @@ -77,7 +77,7 @@ const types = new Map([ ] }], ['numericString', { - is: m.numericString, + is: is.numericString, fixtures: [ '5', '-3.2', @@ -106,7 +106,7 @@ const types = new Map([ function () {}, () => {}, async function () {}, - function * (): any {} + function * (): unknown {} // tslint:enable:no-unused no-empty no-unused-variable only-arrow-functions no-function-expression ] }], @@ -377,7 +377,7 @@ const types = new Map([ ]); // This ensures a certain method matches only the types it's supposed to and none of the other methods' types -const testType = (t: TestContext & Context, type: string, exclude?: string[]) => { +const testType = (t: TestContext & Context, type: string, exclude?: string[]) => { const testData = types.get(type); if (testData === undefined) { @@ -436,8 +436,8 @@ test('is.symbol', t => { test('is.numericString', t => { testType(t, 'numericString'); - t.false(m.numericString('')); - t.false(m.numericString(1)); + t.false(is.numericString('')); + t.false(is.numericString(1)); }); test('is.array', t => {