diego-santos/is
1
0
Fork 0
forked from orbit-oss/is
Code Pull requests Activity

Add predicate factory mode to is.any and is.all

Browse source 
Fixes #218
This commit is contained in:
Sindre Sorhus 2025-12-20 02:51:20 +01:00
parent fbcc68e139
commit 9bdcd9b57f
3 changed files with 245 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

113
test/test.ts
View file

@ -1648,12 +1648,17 @@ test('is.any', t => {
t.false(is.any(is.integer, true, 'lol', {}));
t.true(is.any([is.string, is.number], {}, true, '🦄'));
t.false(is.any([is.boolean, is.number], 'unicorns', [], new Map()));
t.is(typeof is.any([is.string, is.number]), 'function');
t.throws(() => {
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
is.any(null as any, true);
});
t.throws(() => {
is.any([], 'value');
});
t.throws(() => {
is.any(is.string);
});
@ -1666,6 +1671,10 @@ test('is.any', t => {
assert.any(is.object, false, {}, 'unicorns');
});
t.throws(() => {
assert.any([is.string, is.number]);
});
t.throws(() => {
assert.any(is.boolean, '🦄', [], 3);
});
@ -1679,6 +1688,10 @@ test('is.any', t => {
assert.any(null as any, true);
});
t.throws(() => {
assert.any([], 'value');
});
t.throws(() => {
assert.any(is.string);
});
@ -1726,12 +1739,18 @@ test('is.all', t => {
t.false(is.all(is.set, new Map(), {}));
t.true(is.all(is.array, ['1'], ['2']));
t.true(is.all([is.string, is.nonEmptyString], '🦄', 'unicorns'));
t.false(is.all([is.string, is.number], '🦄'));
t.throws(() => {
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
is.all(null as any, true);
});
t.throws(() => {
is.all([], 'value');
});
t.throws(() => {
is.all(is.string);
});
@ -1744,10 +1763,22 @@ test('is.all', t => {
assert.all(is.boolean, true, false);
});
t.throws(() => {
assert.all([is.string, is.number]);
});
t.notThrows(() => {
assert.all([is.string, is.nonEmptyString], '🦄', 'unicorns');
});
t.throws(() => {
assert.all(is.string, '🦄', []);
});
t.throws(() => {
assert.all([is.string, is.number], '🦄');
});
t.throws(() => {
assert.all(is.set, new Map(), {});
});
@ -1757,6 +1788,10 @@ test('is.all', t => {
assert.all(null as any, true);
});
t.throws(() => {
assert.all([], 'value');
});
t.throws(() => {
assert.all(is.string);
});
@ -1783,6 +1818,84 @@ test('is.all', t => {
});
});
test('is.any as predicate factory', t => {
// Returns a type guard function when called with only predicates
const isStringOrNumber = is.any([is.string, is.number]);
t.is(typeof isStringOrNumber, 'function');
t.true(isStringOrNumber('hello'));
t.true(isStringOrNumber(123));
t.false(isStringOrNumber(true));
t.false(isStringOrNumber({}));
// Type narrowing works correctly
const value: unknown = 'test';
if (isStringOrNumber(value)) {
// TypeScript should narrow to string | number
const narrowed: string | number = value;
t.pass(`narrowed to: ${typeof narrowed}`);
}
// Works with is.optional
t.true(is.optional(undefined, is.any([is.string, is.number])));
t.true(is.optional('test', is.any([is.string, is.number])));
t.true(is.optional(42, is.any([is.string, is.number])));
t.false(is.optional(true, is.any([is.string, is.number])));
const predicateArray: Predicate[] = [is.string, is.number];
const isStringOrNumberFromArray = is.any(predicateArray);
t.is(typeof isStringOrNumberFromArray, 'function');
t.true(isStringOrNumberFromArray('hello'));
t.true(isStringOrNumberFromArray(123));
t.false(isStringOrNumberFromArray(true));
// Type narrowing with is.optional
const optionalValue: unknown = undefined;
if (is.optional(optionalValue, is.any([is.string, is.number]))) {
// TypeScript should narrow to string | number | undefined
const narrowed: string | number | undefined = optionalValue;
t.pass(`optional narrowed to: ${typeof narrowed}`);
}
// Works with more predicates
const isStringOrNumberOrBoolean = is.any([is.string, is.number, is.boolean]);
t.true(isStringOrNumberOrBoolean('hello'));
t.true(isStringOrNumberOrBoolean(123));
t.true(isStringOrNumberOrBoolean(true));
t.false(isStringOrNumberOrBoolean({}));
t.throws(() => {
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
is.any([is.string, 123 as any]);
});
});
test('is.all as predicate factory', t => {
// Returns a type guard function when called with only predicates
const isArrayAndNonEmpty = is.all([is.array, is.nonEmptyArray]);
t.is(typeof isArrayAndNonEmpty, 'function');
t.true(isArrayAndNonEmpty(['hello']));
t.false(isArrayAndNonEmpty([]));
t.false(isArrayAndNonEmpty('hello'));
// Type narrowing works correctly
const value: unknown = ['test'];
if (isArrayAndNonEmpty(value)) {
// TypeScript should narrow to the intersection type
t.true(Array.isArray(value));
t.true(value.length > 0);
}
// Works with is.optional
t.true(is.optional(undefined, is.all([is.object, is.plainObject])));
t.true(is.optional({foo: 'bar'}, is.all([is.object, is.plainObject])));
t.false(is.optional([], is.all([is.object, is.plainObject])));
t.throws(() => {
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
is.all([is.string, 123 as any]);
});
});
test('is.formData supplemental', t => {
const data = new window.FormData();
t.true(is.formData(data));