diff options
Diffstat (limited to 'node_modules/nth-check/lib/compile.d.ts')
-rw-r--r-- | node_modules/nth-check/lib/compile.d.ts | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/node_modules/nth-check/lib/compile.d.ts b/node_modules/nth-check/lib/compile.d.ts new file mode 100644 index 0000000..03a0be3 --- /dev/null +++ b/node_modules/nth-check/lib/compile.d.ts @@ -0,0 +1,19 @@ +/** + * 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 + * 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; +//# sourceMappingURL=compile.d.ts.map
\ No newline at end of file |