Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 | 1x 1x 1x 1x 11x 11x 3x 3x | import { Predicate } from "@benneq/predicate";
import { isString } from "./isString";
import { isArray } from "@benneq/array";
import { isRegExp } from "@benneq/regexp";
import { isEqualTo } from "@benneq/object";
/**
*
*/
export type StringPredicateInput =
| string
| string[]
| RegExp
| Predicate<[string]>;
/**
* Creates a {@link Predicate} for Strings.
*
* @example
* Match against an array of allowed values
* ```ts
* const isAorB = stringPredicate(['a', 'b']);
* const matches = isAorB('b');
* console.log(matches); // true
* ```
*
* @example
* Match against a RegExp
* ```ts
* const startsWithA = stringPredicate(/a.+/);
* const matches = startsWithA('ab');
* console.log(matches); // true
* ```
*
* @returns the {@link Predicate}
*/
export const stringPredicate = (
predicateInput: StringPredicateInput
): Predicate<[string]> => {
return isString(predicateInput)
? isEqualTo(predicateInput)
: isArray(predicateInput)
? (key) => predicateInput.includes(key)
: isRegExp(predicateInput)
? (key) => predicateInput.test(key)
: predicateInput;
};
|