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

feat: is.propertyKey

Browse source
This commit is contained in:
PopGoesTheWza 2021-09-07 10:54:53 +02:00
parent 6f2b24d822
commit efb08e4a13
2 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
source/index.ts
View file

@ -150,6 +150,8 @@ is.string = isOfType<string>('string');
const isNumberType = isOfType<number>('number');
is.number = (value: unknown): value is number => isNumberType(value) && !is.nan(value);
is.propertyKey = (value: unknown): value is PropertyKey => is.any([is.string, is.number, is.symbol], value);
is.bigint = isOfType<bigint>('bigint');
// eslint-disable-next-line @typescript-eslint/ban-types
@ -448,6 +450,7 @@ interface Assert {
undefined: (value: unknown) => asserts value is undefined;
string: (value: unknown) => asserts value is string;
number: (value: unknown) => asserts value is number;
propertyKey: (value: unknown) => asserts value is PropertyKey;
bigint: (value: unknown) => asserts value is bigint;
// eslint-disable-next-line @typescript-eslint/ban-types
function_: (value: unknown) => asserts value is Function;
@ -538,6 +541,8 @@ export const assert: Assert = {
undefined: (value: unknown): asserts value is undefined => assertType(is.undefined(value), 'undefined', value),
string: (value: unknown): asserts value is string => assertType(is.string(value), 'string', value),
number: (value: unknown): asserts value is number => assertType(is.number(value), 'number', value),
// ? Is an AssertionTypeDescription.propertyKey entry necessary?
propertyKey: (value: unknown): asserts value is number => assertType(is.propertyKey(value), 'PropertyKey', value),
bigint: (value: unknown): asserts value is bigint => assertType(is.bigint(value), 'bigint', value),
// eslint-disable-next-line @typescript-eslint/ban-types
function_: (value: unknown): asserts value is Function => assertType(is.function_(value), 'Function', value),

7
test/test.ts
View file

@ -613,6 +613,13 @@ test('is.number', t => {
testType(t, 'number', ['integer', 'safeInteger', 'infinite']);
});
test('is.propertyKey', t => {
// ??? Unsure what is the correct syntax to `testType` multiple types. Also are the exclusion relevant?
testType(t, 'string', ['emptyString', 'numericString']);
testType(t, 'number', ['nan', 'integer', 'safeInteger', 'infinite']);
testType(t, 'symbol');
});
test('is.bigint', t => {
testType(t, 'bigint');
});