28 lines
920 B
TypeScript
28 lines
920 B
TypeScript
|
import { parse } from "./parse";
|
||
|
|
import { compile } from "./compile";
|
||
|
|
export { parse, compile };
|
||
|
|
/**
|
||
|
|
* Parses and compiles a formula to a highly optimized function.
|
||
|
|
* Combination of `parse` and `compile`.
|
||
|
|
*
|
||
|
|
* If the formula doesn't match any elements,
|
||
|
|
* it returns [`boolbase`](https://github.com/fb55/boolbase)'s `falseFunc`.
|
||
|
|
* Otherwise, a function accepting an _index_ is returned, which returns
|
||
|
|
* whether or not the passed _index_ matches the formula.
|
||
|
|
*
|
||
|
|
* Note: The nth-rule starts counting at `1`, the returned function at `0`.
|
||
|
|
*
|
||
|
|
* @param formula The formula to compile.
|
||
|
|
* @example
|
||
|
|
* const check = nthCheck("2n+3");
|
||
|
|
*
|
||
|
|
* check(0); // `false`
|
||
|
|
* check(1); // `false`
|
||
|
|
* check(2); // `true`
|
||
|
|
* check(3); // `false`
|
||
|
|
* check(4); // `true`
|
||
|
|
* check(5); // `false`
|
||
|
|
* check(6); // `true`
|
||
|
|
*/
|
||
|
|
export default function nthCheck(formula: string): (index: number) => boolean;
|
||
|
|
//# sourceMappingURL=index.d.ts.map
|