diff options
Diffstat (limited to 'includes/external/addressbook/node_modules/nth-check/lib/esm/compile.d.ts')
-rw-r--r-- | includes/external/addressbook/node_modules/nth-check/lib/esm/compile.d.ts | 55 |
1 files changed, 0 insertions, 55 deletions
diff --git a/includes/external/addressbook/node_modules/nth-check/lib/esm/compile.d.ts b/includes/external/addressbook/node_modules/nth-check/lib/esm/compile.d.ts deleted file mode 100644 index 63e9be5..0000000 --- a/includes/external/addressbook/node_modules/nth-check/lib/esm/compile.d.ts +++ /dev/null @@ -1,55 +0,0 @@ -/** - * Returns a function that checks if an elements index matches the given rule - * highly optimized to return the fastest solution. - * - * @param parsed A tuple [a, b], as returned by `parse`. - * @returns A highly optimized function that returns whether an index matches the nth-check. - * @example - * - * ```js - * const check = nthCheck.compile([2, 3]); - * - * check(0); // `false` - * check(1); // `false` - * check(2); // `true` - * check(3); // `false` - * check(4); // `true` - * check(5); // `false` - * check(6); // `true` - * ``` - */ -export declare function compile(parsed: [a: number, b: number]): (index: number) => boolean; -/** - * Returns a function that produces a monotonously increasing sequence of indices. - * - * If the sequence has an end, the returned function will return `null` after - * the last index in the sequence. - * - * @param parsed A tuple [a, b], as returned by `parse`. - * @returns A function that produces a sequence of indices. - * @example <caption>Always increasing (2n+3)</caption> - * - * ```js - * const gen = nthCheck.generate([2, 3]) - * - * gen() // `1` - * gen() // `3` - * gen() // `5` - * gen() // `8` - * gen() // `11` - * ``` - * - * @example <caption>With end value (-2n+10)</caption> - * - * ```js - * - * const gen = nthCheck.generate([-2, 5]); - * - * gen() // 0 - * gen() // 2 - * gen() // 4 - * gen() // null - * ``` - */ -export declare function generate(parsed: [a: number, b: number]): () => number | null; -//# sourceMappingURL=compile.d.ts.map
\ No newline at end of file |