@thi.ng/strings/balance.d.ts

Various string formatting & utility functions

import type { IObjectOf, Predicate } from "@thi.ng/api";
/**
 * Takes an (optional) object of open/close string pairs and constructs a
 * function which accepts a string-iterable as input and checks if it contains
 * balanced pairs of the configured "parenthesis"-like pairs. Also supports
 * `symmetric` pairs (given as string array), i.e. those where open/close
 * strings are the same.
 *
 * If `skip` is true (default), balancing will be skipped inside the first
 * symmetric pair encountered (e.g. inside a double-quoted "string").
 *
 * @remarks
 * By default checks against these:
 *
 * - pairs: `()`, `{}`, `[]`
 * - symmetric: `'`, `"` (i.e. single and double quotes)
 *
 * This function is NOT a full parser. Pairs are balanced indiscriminately,
 * unaware of any further syntactic constraints (other than pausing balancing of
 * other pairs if `skip` is enabled).
 *
 * @example
 * ```ts tangle:../export/balance.ts
 * import { balance } from "@thi.ng/strings";
 *
 * // using defaults
 * const check = balance();
 *
 * console.log(check("x = ((a[0] + b[0]) * c[0]) / (a[1] - c[1])"));
 * // true
 *
 * console.log(check("x = ((a[0 + b[0])"));
 * // false
 *
 * // by default skip balancing inside strings/symmetric pairs
 * console.log(check(`"1) one, 2) two"`));
 * // true
 *
 * // balance multi-character pairs
 * const check2 = balance({ "BEGIN": "END;" });
 *
 * // ...and supply tokenized input
 * console.log(check2("foo BEGIN a BEGIN b END; bar END;".split(" ")));
 * // true
 *
 * console.log(check2("foo BEGIN a b".split(" ")));
 * // false
 * ```
 *
 * @param pairs
 */
export declare const balance: (pairs?: IObjectOf<string>, symmetric?: string[], skip?: boolean) => Predicate<Iterable<string>>;
//# sourceMappingURL=balance.d.ts.map