public_library_map/node_modules/nth-check/lib/compile.d.ts

19 lines
644 B
TypeScript
Raw Normal View History

2021-09-05 20:12:48 +10:00
/**
* 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