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

Remove deprecated methods and improve Class definition (#209)

Browse source
This commit is contained in:
Bjorn Stromberg 2024-06-26 20:30:00 +08:00 • committed by GitHub
parent 92699e1049
commit 8cbcaee674
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 9 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

30
source/index.ts
View file

@ -236,14 +236,10 @@ const is = Object.assign(
boundFunction: isBoundFunction, boundFunction: isBoundFunction,
buffer: isBuffer, buffer: isBuffer,
class: isClass, class: isClass,
/** @deprecated Renamed to `class`. */
class_: isClass,
dataView: isDataView, dataView: isDataView,
date: isDate, date: isDate,
detect, detect,
directInstanceOf: isDirectInstanceOf, directInstanceOf: isDirectInstanceOf,
/** @deprecated Renamed to `htmlElement` */
domElement: isHtmlElement,
emptyArray: isEmptyArray, emptyArray: isEmptyArray,
emptyMap: isEmptyMap, emptyMap: isEmptyMap,
emptyObject: isEmptyObject, emptyObject: isEmptyObject,
@ -258,8 +254,6 @@ const is = Object.assign(
float64Array: isFloat64Array, float64Array: isFloat64Array,
formData: isFormData, formData: isFormData,
function: isFunction, function: isFunction,
/** @deprecated Renamed to `function`. */
function_: isFunction,
generator: isGenerator, generator: isGenerator,
generatorFunction: isGeneratorFunction, generatorFunction: isGeneratorFunction,
htmlElement: isHtmlElement, htmlElement: isHtmlElement,
@ -282,8 +276,6 @@ const is = Object.assign(
nonEmptyString: isNonEmptyString, nonEmptyString: isNonEmptyString,
nonEmptyStringAndNotWhitespace: isNonEmptyStringAndNotWhitespace, nonEmptyStringAndNotWhitespace: isNonEmptyStringAndNotWhitespace,
null: isNull, null: isNull,
/** @deprecated Renamed to `null`. */
null_: isNull,
nullOrUndefined: isNullOrUndefined, nullOrUndefined: isNullOrUndefined,
number: isNumber, number: isNumber,
numericString: isNumericString, numericString: isNumericString,
@ -403,7 +395,7 @@ export function isBuffer(value: unknown): value is Buffer {
return (value as any)?.constructor?.isBuffer?.(value) ?? false; return (value as any)?.constructor?.isBuffer?.(value) ?? false;
} }
export function isClass(value: unknown): value is Class { export function isClass<T = unknown>(value: unknown): value is Class<T> {
return isFunction(value) && value.toString().startsWith('class '); return isFunction(value) && value.toString().startsWith('class ');
} }
@ -832,17 +824,9 @@ type Assert = {
bigint: (value: unknown, message?: string) => asserts value is bigint; bigint: (value: unknown, message?: string) => asserts value is bigint;
// eslint-disable-next-line @typescript-eslint/ban-types // eslint-disable-next-line @typescript-eslint/ban-types
function: (value: unknown, message?: string) => asserts value is Function; function: (value: unknown, message?: string) => asserts value is Function;
/** @deprecated Renamed to `function`. */
// eslint-disable-next-line @typescript-eslint/ban-types
function_: (value: unknown, message?: string) => asserts value is Function;
// eslint-disable-next-line @typescript-eslint/ban-types // eslint-disable-next-line @typescript-eslint/ban-types
null: (value: unknown, message?: string) => asserts value is null; null: (value: unknown, message?: string) => asserts value is null;
/** @deprecated Renamed to `null`. */ class: <T = unknown>(value: unknown, message?: string) => asserts value is Class<T>;
// eslint-disable-next-line @typescript-eslint/ban-types
null_: (value: unknown, message?: string) => asserts value is null;
class: (value: unknown, message?: string) => asserts value is Class;
/** @deprecated Renamed to `class`. */
class_: (value: unknown, message?: string) => asserts value is Class;
boolean: (value: unknown, message?: string) => asserts value is boolean; boolean: (value: unknown, message?: string) => asserts value is boolean;
symbol: (value: unknown, message?: string) => asserts value is symbol; symbol: (value: unknown, message?: string) => asserts value is symbol;
numericString: (value: unknown, message?: string) => asserts value is `${number}`; numericString: (value: unknown, message?: string) => asserts value is `${number}`;
@ -902,8 +886,6 @@ type Assert = {
typedArray: (value: unknown, message?: string) => asserts value is TypedArray; typedArray: (value: unknown, message?: string) => asserts value is TypedArray;
arrayLike: <T = unknown>(value: unknown, message?: string) => asserts value is ArrayLike<T>; arrayLike: <T = unknown>(value: unknown, message?: string) => asserts value is ArrayLike<T>;
tupleLike: <T extends Array<TypeGuard<unknown>>>(value: unknown, guards: [...T], message?: string) => asserts value is ResolveTypesOfTypeGuardsTuple<T>; tupleLike: <T extends Array<TypeGuard<unknown>>>(value: unknown, guards: [...T], message?: string) => asserts value is ResolveTypesOfTypeGuardsTuple<T>;
/** @deprecated Renamed to `htmlElement` */
domElement: (value: unknown, message?: string) => asserts value is HTMLElement;
htmlElement: (value: unknown, message?: string) => asserts value is HTMLElement; htmlElement: (value: unknown, message?: string) => asserts value is HTMLElement;
observable: (value: unknown, message?: string) => asserts value is ObservableLike; observable: (value: unknown, message?: string) => asserts value is ObservableLike;
nodeStream: (value: unknown, message?: string) => asserts value is NodeStream; nodeStream: (value: unknown, message?: string) => asserts value is NodeStream;
@ -958,11 +940,9 @@ export const assert: Assert = {
boundFunction: assertBoundFunction, boundFunction: assertBoundFunction,
buffer: assertBuffer, buffer: assertBuffer,
class: assertClass, class: assertClass,
class_: assertClass,
dataView: assertDataView, dataView: assertDataView,
date: assertDate, date: assertDate,
directInstanceOf: assertDirectInstanceOf, directInstanceOf: assertDirectInstanceOf,
domElement: assertHtmlElement,
emptyArray: assertEmptyArray, emptyArray: assertEmptyArray,
emptyMap: assertEmptyMap, emptyMap: assertEmptyMap,
emptyObject: assertEmptyObject, emptyObject: assertEmptyObject,
@ -977,7 +957,6 @@ export const assert: Assert = {
float64Array: assertFloat64Array, float64Array: assertFloat64Array,
formData: assertFormData, formData: assertFormData,
function: assertFunction, function: assertFunction,
function_: assertFunction,
generator: assertGenerator, generator: assertGenerator,
generatorFunction: assertGeneratorFunction, generatorFunction: assertGeneratorFunction,
htmlElement: assertHtmlElement, htmlElement: assertHtmlElement,
@ -1000,7 +979,6 @@ export const assert: Assert = {
nonEmptyString: assertNonEmptyString, nonEmptyString: assertNonEmptyString,
nonEmptyStringAndNotWhitespace: assertNonEmptyStringAndNotWhitespace, nonEmptyStringAndNotWhitespace: assertNonEmptyStringAndNotWhitespace,
null: assertNull, null: assertNull,
null_: assertNull,
nullOrUndefined: assertNullOrUndefined, nullOrUndefined: assertNullOrUndefined,
number: assertNumber, number: assertNumber,
numericString: assertNumericString, numericString: assertNumericString,
@ -1056,8 +1034,6 @@ const methodTypeMap = {
isDataView: 'DataView', isDataView: 'DataView',
isDate: 'Date', isDate: 'Date',
isDirectInstanceOf: 'T', isDirectInstanceOf: 'T',
/** @deprecated */
isDomElement: 'HTMLElement',
isEmptyArray: 'empty array', isEmptyArray: 'empty array',
isEmptyMap: 'empty map', isEmptyMap: 'empty map',
isEmptyObject: 'empty object', isEmptyObject: 'empty object',
@ -1247,7 +1223,7 @@ export function assertBuffer(value: unknown, message?: string): asserts value is
} }
} }
export function assertClass(value: unknown, message?: string): asserts value is Class { export function assertClass<T>(value: unknown, message?: string): asserts value is Class<T> {
if (!isClass(value)) { if (!isClass(value)) {
throw new TypeError(message ?? typeErrorMessage('Class', value)); throw new TypeError(message ?? typeErrorMessage('Class', value));
} }

6
source/types.ts
View file

@ -15,14 +15,12 @@ export type Primitive =
/** /**
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).
*/ */
/// type Constructor<T, Arguments extends unknown[] = any[]> = new(...arguments_: Arguments) => T; type Constructor<T, Arguments extends unknown[] = any[]> = new(...arguments_: Arguments) => T;
/** /**
Matches a [`class`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes). Matches a [`class`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes).
*/ */
// TODO: Use the below in the next major version. export type Class<T, Arguments extends unknown[] = any[]> = Constructor<T, Arguments> & {prototype: T};
// export type Class<T, Arguments extends unknown[] = any[]> = Constructor<T, Arguments> & {prototype: T};
export type Class<T = unknown, Arguments extends any[] = any[]> = new (...arguments_: Arguments) => T;
/** /**
Matches any [typed array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray), like `Uint8Array` or `Float64Array`. Matches any [typed array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray), like `Uint8Array` or `Float64Array`.

8
test/test.ts
View file

@ -61,7 +61,7 @@ const types = new Map<string, Test>([
}], }],
['null', { ['null', {
is: is.null, is: is.null,
assert: assert.null_, assert: assert.null,
fixtures: [ fixtures: [
null, null,
], ],
@ -161,7 +161,7 @@ const types = new Map<string, Test>([
}], }],
['function', { ['function', {
is: is.function, is: is.function,
assert: assert.function_, assert: assert.function,
fixtures: [ fixtures: [
function foo() {}, // eslint-disable-line func-names function foo() {}, // eslint-disable-line func-names
function () {}, function () {},
@ -840,7 +840,7 @@ test('is.asyncFunction', t => {
t.true(is.function(fixture().then)); t.true(is.function(fixture().then));
t.notThrows(() => { t.notThrows(() => {
assert.function_(fixture().then); assert.function(fixture().then);
}); });
} }
}); });
@ -1370,7 +1370,7 @@ test('is.class', t => {
t.true(is.class(classDeclaration)); t.true(is.class(classDeclaration));
t.notThrows(() => { t.notThrows(() => {
assert.class_(classDeclaration); assert.class(classDeclaration);
}); });
} }
}); });