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

Improve TS code by adding generics and removing any where applicable

Browse source
This commit is contained in:
Lukas Tetzlaff 2018-04-29 19:45:24 +02:00
parent d5cb95e87b
commit 09a3f4d557
2 changed files with 61 additions and 66 deletions
Download patch file Download diff file Expand all files Collapse all files

97
source/index.ts
View file

@ -58,30 +58,25 @@ const getObjectType = (value: any): TypeName | null => {
const isObjectOfType = <T>(type: TypeName) => (value: any): value is T => getObjectType(value) === type; const isObjectOfType = <T>(type: TypeName) => (value: any): value is T => getObjectType(value) === type;
function is(value: any): TypeName { // tslint:disable-line:only-arrow-functions function is(value: any): TypeName { // tslint:disable-line:only-arrow-functions
if (value === null) { switch (value) {
return TypeName.null; case null:
return TypeName.null;
case true:
case false:
return TypeName.boolean;
default:
} }
if (value === true || value === false) { switch (typeof value) {
return TypeName.boolean; case 'undefined':
} return TypeName.undefined;
case 'string':
const type = typeof value; return TypeName.string;
case 'number':
if (type === 'undefined') { return TypeName.number;
return TypeName.undefined; case 'symbol':
} return TypeName.symbol;
default:
if (type === 'string') {
return TypeName.string;
}
if (type === 'number') {
return TypeName.number;
}
if (type === 'symbol') {
return TypeName.symbol;
} }
if (is.function_(value)) { if (is.function_(value)) {
@ -109,7 +104,7 @@ function is(value: any): TypeName { // tslint:disable-line:only-arrow-functions
} }
namespace is { // tslint:disable-line:no-namespace namespace is { // tslint:disable-line:no-namespace
const isObject = (value: any) => typeof value === 'object'; const isObject = (value: object) => typeof value === 'object'; // tslint:disable-line:strict-type-predicates
// tslint:disable:variable-name // tslint:disable:variable-name
export const undefined = isOfType<undefined>('undefined'); export const undefined = isOfType<undefined>('undefined');
@ -118,7 +113,7 @@ namespace is { // tslint:disable-line:no-namespace
export const function_ = isOfType<Function>('function'); export const function_ = isOfType<Function>('function');
export const null_ = (value: any): value is null => value === null; export const null_ = (value: any): value is null => value === null;
export const class_ = (value: any) => function_(value) && value.toString().startsWith('class '); export const class_ = (value: any) => function_(value) && value.toString().startsWith('class ');
export const boolean = (value: any): value is boolean => value === true || value === false; export const boolean = (value: boolean): value is boolean => value === true || value === false;
export const symbol = isOfType<Symbol>('symbol'); export const symbol = isOfType<Symbol>('symbol');
// tslint:enable:variable-name // tslint:enable:variable-name
@ -126,32 +121,32 @@ namespace is { // tslint:disable-line:no-namespace
export const buffer = Buffer.isBuffer; export const buffer = Buffer.isBuffer;
export const nullOrUndefined = (value: any): value is null | undefined => null_(value) || undefined(value); export const nullOrUndefined = (value: any): value is null | undefined => null_(value) || undefined(value);
export const object = (value: any) => !nullOrUndefined(value) && (function_(value) || isObject(value)); export const object = (value: object) => !nullOrUndefined(value) && (function_(value) || isObject(value));
export const iterable = (value: any): value is Iterator<any> => !nullOrUndefined(value) && function_(value[Symbol.iterator]); export const iterable = (value: IterableIterator<any>): value is IterableIterator<any> => !nullOrUndefined(value) && function_(value[Symbol.iterator]);
export const generator = (value: any): value is Generator => iterable(value) && function_(value.next) && function_(value.throw); export const generator = (value: any): value is Generator => iterable(value) && function_(value.next) && function_(value.throw);
export const nativePromise = isObjectOfType<Promise<any>>(TypeName.Promise); export const nativePromise = <T = any>(value: Promise<T>): value is Promise<T> =>
isObjectOfType<Promise<T>>(TypeName.Promise)(value);
const hasPromiseAPI = (value: any): value is Promise<any> => const hasPromiseAPI = <T = any>(value: Promise<T>): value is Promise<T> =>
!null_(value) && !null_(value) &&
isObject(value) && isObject(value) &&
function_(value.then) && function_(value.then) &&
function_(value.catch); function_(value.catch);
export const promise = (value: any): value is Promise<any> => nativePromise(value) || hasPromiseAPI(value); export const promise = <T = any>(value: Promise<T>): value is Promise<T> => nativePromise<T>(value) || hasPromiseAPI<T>(value);
const isFunctionOfType = <T>(type: TypeName) => isObjectOfType<T>(type); export const generatorFunction = isObjectOfType<GeneratorFunction>(TypeName.GeneratorFunction);
export const generatorFunction = isFunctionOfType<GeneratorFunction>(TypeName.GeneratorFunction); export const asyncFunction = isObjectOfType<Function>(TypeName.AsyncFunction);
export const asyncFunction = isFunctionOfType<Function>(TypeName.AsyncFunction); export const boundFunction = (value: Function): value is Function => function_(value) && !value.hasOwnProperty('prototype');
export const boundFunction = (value: any): value is Function => function_(value) && !value.hasOwnProperty('prototype');
export const regExp = isObjectOfType<RegExp>(TypeName.RegExp); export const regExp = isObjectOfType<RegExp>(TypeName.RegExp);
export const date = isObjectOfType<Date>(TypeName.Date); export const date = isObjectOfType<Date>(TypeName.Date);
export const error = isObjectOfType<Error>(TypeName.Error); export const error = isObjectOfType<Error>(TypeName.Error);
export const map = isObjectOfType<Map<any, any>>(TypeName.Map); export const map = <T1 = any, T2 = any>(value: Map<T1, T2>): value is Map<T1, T2> => isObjectOfType<Map<T1, T2>>(TypeName.Map)(value);
export const set = isObjectOfType<Set<any>>(TypeName.Set); export const set = <T = any>(value: Set<T>): value is Set<T> => isObjectOfType<Set<T>>(TypeName.Set)(value);
export const weakMap = isObjectOfType<WeakMap<any, any>>(TypeName.WeakMap); export const weakMap = <T1 extends object = any, T2 = any>(value: WeakMap<T1, T2>): value is WeakMap<T1, T2> => isObjectOfType<WeakMap<T1, T2>>(TypeName.WeakMap)(value);
export const weakSet = isObjectOfType<WeakSet<any>>(TypeName.WeakSet); export const weakSet = <T extends object = any>(value: WeakSet<T>): value is WeakSet<T> => isObjectOfType<WeakSet<T>>(TypeName.WeakSet)(value);
export const int8Array = isObjectOfType<Int8Array>(TypeName.Int8Array); export const int8Array = isObjectOfType<Int8Array>(TypeName.Int8Array);
export const uint8Array = isObjectOfType<Uint8Array>(TypeName.Uint8Array); export const uint8Array = isObjectOfType<Uint8Array>(TypeName.Uint8Array);
@ -172,7 +167,7 @@ namespace is { // tslint:disable-line:no-namespace
export const truthy = (value: any) => Boolean(value); export const truthy = (value: any) => Boolean(value);
export const falsy = (value: any) => !value; export const falsy = (value: any) => !value;
export const nan = (value: any) => Number.isNaN(value); export const nan = (value: number) => Number.isNaN(value);
const primitiveTypes = new Set([ const primitiveTypes = new Set([
'undefined', 'undefined',
@ -182,10 +177,10 @@ namespace is { // tslint:disable-line:no-namespace
'symbol' 'symbol'
]); ]);
export const primitive = (value: any): value is Primitive => null_(value) || primitiveTypes.has(typeof value); export const primitive = (value: Primitive): value is Primitive => null_(value) || primitiveTypes.has(typeof value);
export const integer = (value: any): value is number => Number.isInteger(value); export const integer = (value: number): value is number => Number.isInteger(value);
export const safeInteger = (value: any): value is number => Number.isSafeInteger(value); export const safeInteger = (value: number): value is number => Number.isSafeInteger(value);
export const plainObject = (value: any) => { export const plainObject = (value: any) => {
// From: https://github.com/sindresorhus/is-plain-obj/blob/master/index.js // From: https://github.com/sindresorhus/is-plain-obj/blob/master/index.js
@ -207,7 +202,7 @@ namespace is { // tslint:disable-line:no-namespace
TypeName.Float32Array, TypeName.Float32Array,
TypeName.Float64Array TypeName.Float64Array
]); ]);
export const typedArray = (value: any): value is TypedArray => { export const typedArray = (value: TypedArray): value is TypedArray => {
const objectType = getObjectType(value); const objectType = getObjectType(value);
if (objectType === null) { if (objectType === null) {
@ -217,8 +212,8 @@ namespace is { // tslint:disable-line:no-namespace
return typedArrayTypes.has(objectType); return typedArrayTypes.has(objectType);
}; };
const isValidLength = (value: any) => safeInteger(value) && value > -1; const isValidLength = (value: number) => safeInteger(value) && value > -1;
export const arrayLike = (value: any): value is ArrayLike => !nullOrUndefined(value) && !function_(value) && isValidLength(value.length); export const arrayLike = (value: ArrayLike): value is ArrayLike => !nullOrUndefined(value) && !function_(value) && isValidLength(value.length);
export const inRange = (value: number, range: number | number[]) => { export const inRange = (value: number, range: number | number[]) => {
if (number(range)) { if (number(range)) {
@ -246,22 +241,22 @@ namespace is { // tslint:disable-line:no-namespace
export const nodeStream = (value: any) => !nullOrUndefined(value) && isObject(value) && function_(value.pipe); export const nodeStream = (value: any) => !nullOrUndefined(value) && isObject(value) && function_(value.pipe);
export const infinite = (value: any) => value === Infinity || value === -Infinity; export const infinite = (value: number) => value === Infinity || value === -Infinity;
const isAbsoluteMod2 = (value: number) => (rem: number) => integer(rem) && Math.abs(rem % 2) === value; const isAbsoluteMod2 = (value: number) => (rem: number) => integer(rem) && Math.abs(rem % 2) === value;
export const even = isAbsoluteMod2(0); export const even = isAbsoluteMod2(0);
export const odd = isAbsoluteMod2(1); export const odd = isAbsoluteMod2(1);
const isWhiteSpaceString = (value: any) => string(value) && /\S/.test(value) === false; const isWhiteSpaceString = (value: string) => string(value) && /\S/.test(value) === false;
const isEmptyStringOrArray = (value: any) => (string(value) || array(value)) && value.length === 0; const isEmptyStringOrArray = (value: string | any[]) => (string(value) || array(value)) && value.length === 0;
const isEmptyObject = (value: any) => !map(value) && !set(value) && object(value) && Object.keys(value).length === 0; const isEmptyObject = (value: any) => !map(value) && !set(value) && object(value) && Object.keys(value).length === 0;
const isEmptyMapOrSet = (value: any) => (map(value) || set(value)) && value.size === 0; const isEmptyMapOrSet = (value: any) => (map(value) || set(value)) && value.size === 0;
export const empty = (value: any) => falsy(value) || isEmptyStringOrArray(value) || isEmptyObject(value) || isEmptyMapOrSet(value); export const empty = (value: any) => falsy(value) || isEmptyStringOrArray(value) || isEmptyObject(value) || isEmptyMapOrSet(value);
export const emptyOrWhitespace = (value: any) => empty(value) || isWhiteSpaceString(value); export const emptyOrWhitespace = (value: any) => empty(value) || isWhiteSpaceString(value);
type ArrayMethod = (fn: (value: any, index: number, array: any[]) => boolean, thisArg?: any) => boolean; type ArrayMethod = <T>(fn: (value: T, index: number, array: T[]) => boolean, thisArg?: any) => boolean;
const predicateOnArray = (method: ArrayMethod, predicate: any, values: any[]) => { const predicateOnArray = <T = any>(method: ArrayMethod, predicate: T, values: any[]) => {
if (function_(predicate) === false) { if (function_(predicate) === false) {
throw new TypeError(`Invalid predicate: ${util.inspect(predicate)}`); throw new TypeError(`Invalid predicate: ${util.inspect(predicate)}`);
} }
@ -274,8 +269,8 @@ namespace is { // tslint:disable-line:no-namespace
}; };
// tslint:disable variable-name // tslint:disable variable-name
export const any = (predicate: any, ...values: any[]) => predicateOnArray(Array.prototype.some, predicate, values); export const any = <T>(predicate: T, ...values: any[]) => predicateOnArray(Array.prototype.some, predicate, values);
export const all = (predicate: any, ...values: any[]) => predicateOnArray(Array.prototype.every, predicate, values); export const all = <T>(predicate: T, ...values: any[]) => predicateOnArray(Array.prototype.every, predicate, values);
// tslint:enable variable-name // tslint:enable variable-name
} }

30
source/tests/test.ts
View file

@ -322,7 +322,7 @@ const types = new Map<string, Test>([
] ]
}], }],
['infinite', { ['infinite', {
is: m.infinite, is: m.infinite,
fixtures: [ fixtures: [
Infinity, Infinity,
-Infinity -Infinity
@ -582,15 +582,15 @@ test('is.plainObject', t => {
}); });
test('is.iterable', t => { test('is.iterable', t => {
t.true(m.iterable('')); t.true(m.iterable('' as any));
t.true(m.iterable([])); t.true(m.iterable([] as any));
t.true(m.iterable(new Map())); t.true(m.iterable(new Map() as any));
t.false(m.iterable(null)); t.false(m.iterable(null as any));
t.false(m.iterable(undefined)); t.false(m.iterable(undefined as any));
t.false(m.iterable(0)); t.false(m.iterable(0 as any));
t.false(m.iterable(NaN)); t.false(m.iterable(NaN as any));
t.false(m.iterable(Infinity)); t.false(m.iterable(Infinity as any));
t.false(m.iterable({})); t.false(m.iterable({} as any));
}); });
test('is.class', t => { test('is.class', t => {
@ -623,9 +623,9 @@ test('is.typedArray', t => {
t.true(m.typedArray(el)); t.true(m.typedArray(el));
} }
t.false(m.typedArray(new ArrayBuffer(1))); t.false(m.typedArray(new ArrayBuffer(1) as any));
t.false(m.typedArray([])); t.false(m.typedArray([] as any));
t.false(m.typedArray({})); t.false(m.typedArray({} as any));
}); });
test('is.arrayLike', t => { test('is.arrayLike', t => {
@ -635,9 +635,9 @@ test('is.arrayLike', t => {
t.true(m.arrayLike([])); t.true(m.arrayLike([]));
t.true(m.arrayLike('unicorn')); t.true(m.arrayLike('unicorn'));
t.false(m.arrayLike({})); t.false(m.arrayLike({} as any));
t.false(m.arrayLike(() => {})); // tslint:disable-line:no-empty t.false(m.arrayLike(() => {})); // tslint:disable-line:no-empty
t.false(m.arrayLike(new Map())); t.false(m.arrayLike(new Map() as any));
}); });
test('is.inRange', t => { test('is.inRange', t => {