Add getValuesMessage option for assertType
This commit is contained in:
parent
5ed7e9bb40
commit
5b13eeedda
2 changed files with 30 additions and 3 deletions
|
|
@ -388,9 +388,11 @@ is.any = (predicate: Predicate | Predicate[], ...values: unknown[]): boolean =>
|
|||
|
||||
is.all = (predicate: Predicate, ...values: unknown[]): boolean => predicateOnArray(Array.prototype.every, predicate, values);
|
||||
|
||||
const assertType = (condition: boolean, description: string, value: unknown): asserts condition => {
|
||||
const assertType = (condition: boolean, description: string, value: unknown, options: { getValuesMessage?: () => string } = {}): asserts condition => {
|
||||
if (!condition) {
|
||||
throw new TypeError(`Expected value which is \`${description}\`, received value of type \`${is(value)}\`.`);
|
||||
const {getValuesMessage} = options;
|
||||
const valuesMessage = getValuesMessage ? getValuesMessage() : `received value of type \`${is(value)}\``;
|
||||
throw new TypeError(`Expected value which is \`${description}\`, ${valuesMessage}.`);
|
||||
}
|
||||
};
|
||||
|
||||
|
|
@ -620,7 +622,11 @@ export const assert: Assert = {
|
|||
inRange: (value: number, range: number | number[]): asserts value is number => assertType(is.inRange(value, range), AssertionTypeDescription.inRange, value),
|
||||
|
||||
// Variadic functions.
|
||||
any: (predicate: Predicate | Predicate[], ...values: unknown[]): void | never => assertType(is.any(predicate, ...values), AssertionTypeDescription.any, values),
|
||||
any: (predicate: Predicate | Predicate[], ...values: unknown[]): void | never => {
|
||||
// Remove duplicate value types using Set.
|
||||
const getValuesMessage = () => `received values of types ${[...new Set(values.map(value => `\`${is(value)}\``))].join(', ')}`;
|
||||
return assertType(is.any(predicate, ...values), AssertionTypeDescription.any, values, {getValuesMessage});
|
||||
},
|
||||
all: (predicate: Predicate, ...values: unknown[]): void | never => assertType(is.all(predicate, ...values), AssertionTypeDescription.all, values)
|
||||
};
|
||||
|
||||
|
|
|
|||
21
test/test.ts
21
test/test.ts
|
|
@ -1529,6 +1529,27 @@ test('is.any', t => {
|
|||
t.throws(() => {
|
||||
assert.any(is.string);
|
||||
});
|
||||
|
||||
t.throws(() => {
|
||||
assert.any(is.string, 1, 2, 3);
|
||||
}, {
|
||||
// Removes duplicates:
|
||||
message: /received values of types `number`./
|
||||
});
|
||||
|
||||
t.throws(() => {
|
||||
assert.any(is.string, 1, [4]);
|
||||
}, {
|
||||
// Lists all types:
|
||||
message: /received values of types `number`, `Array`./
|
||||
});
|
||||
|
||||
t.throws(() => {
|
||||
assert.any([is.string, is.nullOrUndefined], 1);
|
||||
}, {
|
||||
// Handles array as first argument:
|
||||
message: /received values of types `number`./
|
||||
});
|
||||
});
|
||||
|
||||
test('is.all', t => {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue