@thi.ng/parse 2.1.2 → 2.1.5

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2021-11-21T17:09:28Z
+- **Last updated**: 2022-03-11T12:13:49Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+### [2.1.5](https://github.com/thi-ng/umbrella/tree/@thi.ng/parse@2.1.5) (2022-03-11)
+
+#### ♻️ Refactoring
+
+- add type hint (TS4.6) ([6cd42e8](https://github.com/thi-ng/umbrella/commit/6cd42e8))
+
 ## [2.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/parse@2.1.0) (2021-11-17)
 
 #### 🚀 Features

package/README.md

@@ -572,4 +572,4 @@ If this project contributes to an academic publication, please cite it as:
 
 ## License
 
-© 2020 - 2021 Karsten Schmidt // Apache Software License 2.0
+© 2020 - 2022 Karsten Schmidt // Apache Software License 2.0

package/combinators/lookahead.d.ts

@@ -57,10 +57,10 @@ import type { Parser } from "../api.js";
  * // { p: 10, l: 1, c: 11, done: false, last: 'a' }
  * ```
  *
- * @param parser
- * @param ahead
- * @param capture
- * @param id
+ * @param parser -
+ * @param ahead -
+ * @param capture -
+ * @param id -
  */
 export declare const lookahead: <T>(parser: Parser<T>, ahead: Parser<T>, capture?: boolean, id?: string) => Parser<T>;
 //# sourceMappingURL=lookahead.d.ts.map

package/combinators/lookahead.js

@@ -56,10 +56,10 @@
  * // { p: 10, l: 1, c: 11, done: false, last: 'a' }
  * ```
  *
- * @param parser
- * @param ahead
- * @param capture
- * @param id
+ * @param parser -
+ * @param ahead -
+ * @param capture -
+ * @param id -
  */
 export const lookahead = (parser, ahead, capture = false, id = "lookahead") => (ctx) => {
     if (ctx.done)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/parse",
-  "version": "2.1.2",
+  "version": "2.1.5",
   "description": "Purely functional parser combinators & AST generation for generic inputs",
   "type": "module",
   "module": "./index.js",
@@ -34,19 +34,19 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.3.2",
-    "@thi.ng/checks": "^3.1.2",
-    "@thi.ng/defmulti": "^2.1.2",
-    "@thi.ng/errors": "^2.1.2",
-    "@thi.ng/strings": "^3.2.2"
+    "@thi.ng/api": "^8.3.4",
+    "@thi.ng/checks": "^3.1.4",
+    "@thi.ng/defmulti": "^2.1.4",
+    "@thi.ng/errors": "^2.1.4",
+    "@thi.ng/strings": "^3.3.2"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.18.19",
-    "@thi.ng/testament": "^0.2.2",
+    "@microsoft/api-extractor": "^7.19.4",
+    "@thi.ng/testament": "^0.2.4",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.22.9",
-    "typescript": "^4.5.2"
+    "typedoc": "^0.22.13",
+    "typescript": "^4.6.2"
   },
   "keywords": [
     "ast",
@@ -238,5 +238,5 @@
     ],
     "year": 2020
   },
-  "gitHead": "e8a7c2a40191b391cef182c2978e5a6c85987a87\n"
+  "gitHead": "0fc692a3225c068aacafdc4cb6140cf603c67ad8\n"
 }

package/prims/lit.d.ts

@@ -1,20 +1,20 @@
 /**
  * HOF predicate for matching given single char literal.
  *
- * @param c
+ * @param c -
  */
 export declare const litP: <T>(c: T) => (x: T) => boolean;
 /**
  * Matches single char/value `c`.
  *
- * @param c
- * @param id
+ * @param c -
+ * @param id -
  */
 export declare const lit: <T>(c: T, id?: string) => import("../api.js").LitParser<T>;
 /**
  * Discarded literal. Same as {@link lit}, but result will be discarded.
  *
- * @param c
+ * @param c -
  */
 export declare const litD: <T>(c: T) => import("../api.js").LitParser<T>;
 //# sourceMappingURL=lit.d.ts.map

package/prims/lit.js

@@ -2,19 +2,19 @@ import { satisfyD, satisfy } from "./satisfy.js";
 /**
  * HOF predicate for matching given single char literal.
  *
- * @param c
+ * @param c -
  */
 export const litP = (c) => (x) => x === c;
 /**
  * Matches single char/value `c`.
  *
- * @param c
- * @param id
+ * @param c -
+ * @param id -
  */
 export const lit = (c, id = "lit") => satisfy(litP(c), id);
 /**
  * Discarded literal. Same as {@link lit}, but result will be discarded.
  *
- * @param c
+ * @param c -
  */
 export const litD = (c) => satisfyD(litP(c));

package/prims/none-of.d.ts

@@ -4,22 +4,22 @@ import type { CharSet, LitParser } from "../api.js";
  * HOF predicate for matching single char against given options. Returns
  * true if there's no match.
  *
- * @param opts
+ * @param opts -
  */
 export declare const noneOfP: (opts: string | CharSet | any[] | Set<any>) => Predicate<any>;
 /**
  * Matches single char against given options and only succeeds if
  * there's no match. Also see {@link oneOf} for reverse logic.
  *
- * @param opts
- * @param id
+ * @param opts -
+ * @param id -
  */
 export declare function noneOf(opts: string | CharSet, id?: string): LitParser<string>;
 export declare function noneOf<T>(opts: T[] | Set<T>, id?: string): LitParser<T>;
 /**
  * Like {@link noneOf}, but discards result.
  *
- * @param opts
+ * @param opts -
  */
 export declare function noneOfD(opts: string | CharSet): LitParser<string>;
 export declare function noneOfD<T>(opts: T[] | Set<T>): LitParser<T>;

package/prims/none-of.js

@@ -5,7 +5,7 @@ import { satisfy, satisfyD } from "./satisfy.js";
  * HOF predicate for matching single char against given options. Returns
  * true if there's no match.
  *
- * @param opts
+ * @param opts -
  */
 export const noneOfP = (opts) => isSet(opts)
     ? (x) => !opts.has(x)

package/prims/one-of.d.ts

@@ -3,22 +3,22 @@ import type { CharSet, LitParser } from "../api.js";
 /**
  * HOF predicate for matching single char against given options.
  *
- * @param opts
+ * @param opts -
  */
 export declare const oneOfP: (opts: string | any[] | Set<any> | CharSet) => Predicate<any>;
 /**
  * Matches single char against given options. Also see {@link noneOf}
  * for reverse logic.
  *
- * @param opts
- * @param id
+ * @param opts -
+ * @param id -
  */
 export declare function oneOf(opts: string | CharSet, id?: string): LitParser<string>;
 export declare function oneOf<T>(opts: T[] | Set<T>, id?: string): LitParser<T>;
 /**
  * Like {@link oneOf}, but discards result.
  *
- * @param opts
+ * @param opts -
  */
 export declare function oneOfD(opts: string | CharSet): LitParser<string>;
 export declare function oneOfD<T>(opts: T[] | Set<T>): LitParser<T>;

package/prims/one-of.js

@@ -4,7 +4,7 @@ import { satisfy, satisfyD } from "./satisfy.js";
 /**
  * HOF predicate for matching single char against given options.
  *
- * @param opts
+ * @param opts -
  */
 export const oneOfP = (opts) => isSet(opts)
     ? (x) => opts.has(x)

package/prims/range.d.ts

@@ -22,17 +22,17 @@ export declare function rangeD(min: number, max: number): LitParser<number>;
 /**
  * Matches single char in given UTF-16 codepoint range.
  *
- * @param min
- * @param max
- * @param id
+ * @param min -
+ * @param max -
+ * @param id -
  */
 export declare const utf16Range: (min: number, max: number, id?: string) => LitParser<string>;
 /**
  * Matches single char in given UTF-16 codepoint range.
  *
- * @param min
- * @param max
- * @param id
+ * @param min -
+ * @param max -
+ * @param id -
  */
 export declare const utf16RangeD: (min: number, max: number) => LitParser<string>;
 //# sourceMappingURL=range.d.ts.map

package/prims/range.js

@@ -26,16 +26,16 @@ export function rangeD(min, max) {
 /**
  * Matches single char in given UTF-16 codepoint range.
  *
- * @param min
- * @param max
- * @param id
+ * @param min -
+ * @param max -
+ * @param id -
  */
 export const utf16Range = (min, max, id = "utfLit") => satisfy(utf16RangeP(min, max), id);
 /**
  * Matches single char in given UTF-16 codepoint range.
  *
- * @param min
- * @param max
- * @param id
+ * @param min -
+ * @param max -
+ * @param id -
  */
 export const utf16RangeD = (min, max) => satisfyD(utf16RangeP(min, max));

package/prims/satisfy.d.ts

@@ -5,7 +5,7 @@ export declare const satisfy: <T>(pred: Predicate<T>, id?: string) => LitParser<
  * Like {@link satisfy}, but avoids creating AST node and discards
  * result.
  *
- * @param pred
+ * @param pred -
  */
 export declare const satisfyD: <T>(pred: Predicate<T>) => LitParser<T>;
 //# sourceMappingURL=satisfy.d.ts.map

package/prims/satisfy.js

@@ -8,7 +8,7 @@ export const satisfy = (pred, id = "satisfy") => ((ctx) => {
  * Like {@link satisfy}, but avoids creating AST node and discards
  * result.
  *
- * @param pred
+ * @param pred -
  */
 export const satisfyD = (pred) => ((ctx) => {
     if (ctx.done)

package/prims/skip.d.ts

@@ -18,7 +18,7 @@ import type { Parser } from "../api.js";
  * // { p: 15, l: 2, c: 1, done: true, last: '\n' }
  * ```
  *
- * @param pred
+ * @param pred -
  */
 export declare const skipWhile: <T>(pred: Predicate<T>) => Parser<T>;
 //# sourceMappingURL=skip.d.ts.map

package/prims/skip.js

@@ -16,7 +16,7 @@
  * // { p: 15, l: 2, c: 1, done: true, last: '\n' }
  * ```
  *
- * @param pred
+ * @param pred -
  */
 export const skipWhile = (pred) => (ctx) => {
     const state = { ...ctx.state };

package/utils.d.ts

@@ -1,7 +1,7 @@
 /**
  * Memoized indentation.
  *
- * @param x
+ * @param x -
  *
  * @internal
  */

package/utils.js

@@ -3,7 +3,7 @@ const cache = [];
 /**
  * Memoized indentation.
  *
- * @param x
+ * @param x -
  *
  * @internal
  */

package/xform/collect.d.ts

@@ -3,13 +3,13 @@ import type { Parser, ScopeTransform } from "../api.js";
  * Collects results of all direct children into an array, then discards
  * children. Also see {@link collect}.
  *
- * @param scope
+ * @param scope -
  */
 export declare const xfCollect: ScopeTransform<any>;
 /**
  * Syntax sugar for `xform(parser, xfCollect)`.
  *
- * @param parser
+ * @param parser -
  */
 export declare const collect: <T>(parser: Parser<T>) => Parser<T>;
 //# sourceMappingURL=collect.d.ts.map

package/xform/collect.js

@@ -3,7 +3,7 @@ import { xform } from "../combinators/xform.js";
  * Collects results of all direct children into an array, then discards
  * children. Also see {@link collect}.
  *
- * @param scope
+ * @param scope -
  */
 export const xfCollect = (scope) => {
     scope.result = scope.children.map((c) => c.result);
@@ -13,6 +13,6 @@ export const xfCollect = (scope) => {
 /**
  * Syntax sugar for `xform(parser, xfCollect)`.
  *
- * @param parser
+ * @param parser -
  */
 export const collect = (parser) => xform(parser, xfCollect);

package/xform/comp.d.ts

@@ -3,7 +3,7 @@ import type { ScopeTransform } from "../api.js";
  * Takes any number of {@link ScopeTransform}s and composes them into
  * new xform w/ left to right order of execution.
  *
- * @param xs
+ * @param xs -
  */
 export declare const comp: <T>(...xs: ScopeTransform<T>[]) => ScopeTransform<T>;
 //# sourceMappingURL=comp.d.ts.map

package/xform/comp.js

@@ -2,7 +2,7 @@
  * Takes any number of {@link ScopeTransform}s and composes them into
  * new xform w/ left to right order of execution.
  *
- * @param xs
+ * @param xs -
  */
 export const comp = (...xs) => {
     const [a, b, c, d] = xs;

package/xform/count.d.ts

@@ -3,13 +3,13 @@ import type { Parser, ScopeTransform } from "../api.js";
  * Stores number of children as result, then discards children. Also see
  * {@link count}.
  *
- * @param scope
+ * @param scope -
  */
 export declare const xfCount: ScopeTransform<any>;
 /**
  * Syntax sugar for `xform(parser, xfCount)`.
  *
- * @param parser
+ * @param parser -
  */
 export declare const count: <T>(parser: Parser<T>) => Parser<T>;
 //# sourceMappingURL=count.d.ts.map

package/xform/count.js

@@ -3,7 +3,7 @@ import { xform } from "../combinators/xform.js";
  * Stores number of children as result, then discards children. Also see
  * {@link count}.
  *
- * @param scope
+ * @param scope -
  */
 export const xfCount = (scope) => {
     scope.result = scope.children ? scope.children.length : 0;
@@ -13,6 +13,6 @@ export const xfCount = (scope) => {
 /**
  * Syntax sugar for `xform(parser, xfCount)`.
  *
- * @param parser
+ * @param parser -
  */
 export const count = (parser) => xform(parser, xfCount);

package/xform/discard.d.ts

@@ -6,7 +6,7 @@ export declare const xfDiscard: () => null;
 /**
  * Syntax sugar for `xform(parser, xfDiscard)`.
  *
- * @param parser
+ * @param parser -
  */
 export declare const discard: (parser: Parser<any>) => Parser<any>;
 //# sourceMappingURL=discard.d.ts.map

package/xform/discard.js

@@ -6,6 +6,6 @@ export const xfDiscard = () => null;
 /**
  * Syntax sugar for `xform(parser, xfDiscard)`.
  *
- * @param parser
+ * @param parser -
  */
 export const discard = (parser) => xform(parser, xfDiscard);

package/xform/hoist.d.ts

@@ -2,26 +2,26 @@ import type { Parser, ScopeTransform } from "../api.js";
 /**
  * Replace AST node with its first child node. Also see {@link hoist}.
  *
- * @param scope
+ * @param scope -
  */
 export declare const xfHoist: ScopeTransform<any>;
 /**
  * Moves the result of first child node to this node, then discards all
  * children. Also see {@link hoistR}.
  *
- * @param scope
+ * @param scope -
  */
 export declare const xfHoistResult: ScopeTransform<any>;
 /**
  * Syntax sugar for `xform(parser, xfHoist)`.
  *
- * @param parser
+ * @param parser -
  */
 export declare const hoist: <T>(parser: Parser<T>) => Parser<T>;
 /**
  * Syntax sugar for `xform(parser, xfHoistR)`.
  *
- * @param parser
+ * @param parser -
  */
 export declare const hoistResult: <T>(parser: Parser<T>) => Parser<T>;
 //# sourceMappingURL=hoist.d.ts.map

package/xform/hoist.js

@@ -2,7 +2,7 @@ import { xform } from "../combinators/xform.js";
 /**
  * Replace AST node with its first child node. Also see {@link hoist}.
  *
- * @param scope
+ * @param scope -
  */
 export const xfHoist = (scope) => {
     Object.assign(scope, scope.children[0]);
@@ -12,7 +12,7 @@ export const xfHoist = (scope) => {
  * Moves the result of first child node to this node, then discards all
  * children. Also see {@link hoistR}.
  *
- * @param scope
+ * @param scope -
  */
 export const xfHoistResult = (scope) => {
     scope.result = scope.children[0].result;
@@ -22,12 +22,12 @@ export const xfHoistResult = (scope) => {
 /**
  * Syntax sugar for `xform(parser, xfHoist)`.
  *
- * @param parser
+ * @param parser -
  */
 export const hoist = (parser) => xform(parser, xfHoist);
 /**
  * Syntax sugar for `xform(parser, xfHoistR)`.
  *
- * @param parser
+ * @param parser -
  */
 export const hoistResult = (parser) => xform(parser, xfHoistResult);

package/xform/join.d.ts

@@ -4,13 +4,13 @@ import type { Parser, ParseScope } from "../api.js";
  * Recursively joins non-null results of all children into a single
  * string, then discards children. Also see {@link join}.
  *
- * @param scope
+ * @param scope -
  */
 export declare const xfJoin: <T>(scope: Nullable<ParseScope<T>>) => ParseScope<T> | null;
 /**
  * Syntax sugar for `xform(parser, xfJoin)`.
  *
- * @param parser
+ * @param parser -
  */
 export declare const join: <T>(parser: Parser<T>) => Parser<T>;
 //# sourceMappingURL=join.d.ts.map

package/xform/join.js

@@ -3,7 +3,7 @@ import { xform } from "../combinators/xform.js";
  * Recursively joins non-null results of all children into a single
  * string, then discards children. Also see {@link join}.
  *
- * @param scope
+ * @param scope -
  */
 export const xfJoin = (scope) => {
     if (!scope || !scope.children)
@@ -21,6 +21,6 @@ export const xfJoin = (scope) => {
 /**
  * Syntax sugar for `xform(parser, xfJoin)`.
  *
- * @param parser
+ * @param parser -
  */
 export const join = (parser) => xform(parser, xfJoin);

package/xform/nest.d.ts

@@ -12,7 +12,7 @@ import type { Parser, ScopeTransform } from "../api.js";
  * context will be configured to produce true absolute offsets for its results
  * as if they were in the main context.
  *
- * @param parser
+ * @param parser -
  */
 export declare const xfNest: (parser: Parser<string>) => ScopeTransform<string>;
 export declare const nest: (outer: Parser<string>, inner: Parser<string>) => Parser<string>;

package/xform/nest.js

@@ -14,7 +14,7 @@ import { xfJoin } from "./join.js";
  * context will be configured to produce true absolute offsets for its results
  * as if they were in the main context.
  *
- * @param parser
+ * @param parser -
  */
 export const xfNest = (parser) => (scope, ctx) => {
     if (!scope)

package/xform/number.d.ts

@@ -3,14 +3,14 @@ import type { ScopeTransform } from "../api.js";
  * Higher order transform. First joins all children via {@link xfJoin},
  * then parses resulting string into an integer with given `radix`.
  *
- * @param radix
+ * @param radix -
  */
 export declare const xfInt: (radix?: number) => ScopeTransform<string>;
 /**
  * First joins all children via {@link xfJoin}, then parses resulting
  * string into a floating point value.
  *
- * @param scope
+ * @param scope -
  */
 export declare const xfFloat: ScopeTransform<string>;
 //# sourceMappingURL=number.d.ts.map

package/xform/number.js

@@ -3,7 +3,7 @@ import { xfJoin } from "./join.js";
  * Higher order transform. First joins all children via {@link xfJoin},
  * then parses resulting string into an integer with given `radix`.
  *
- * @param radix
+ * @param radix -
  */
 export const xfInt = (radix = 10) => (scope) => {
     scope.result = parseInt(xfJoin(scope).result, radix);
@@ -13,7 +13,7 @@ export const xfInt = (radix = 10) => (scope) => {
  * First joins all children via {@link xfJoin}, then parses resulting
  * string into a floating point value.
  *
- * @param scope
+ * @param scope -
  */
 export const xfFloat = (scope) => {
     scope.result = parseFloat(xfJoin(scope).result);

package/xform/print.d.ts

@@ -9,9 +9,9 @@ import type { Parser, ScopeTransform } from "../api.js";
  * The optional `fn` function is used to print each AST node (default:
  * `console.log`).
  *
- * @param scope
- * @param ctx
- * @param level
+ * @param scope -
+ * @param ctx -
+ * @param level -
  */
 export declare const xfPrint: (fn?: Fn<string, void>) => ScopeTransform<any>;
 /**
@@ -29,7 +29,7 @@ export declare const xfPrint: (fn?: Fn<string, void>) => ScopeTransform<any>;
  * //   lit: "]"
  * ```
  *
- * @param parser
+ * @param parser -
  */
 export declare const print: <T>(parser: Parser<T>, fn?: Fn<string, void> | undefined) => Parser<T>;
 //# sourceMappingURL=print.d.ts.map

package/xform/print.js

@@ -9,9 +9,9 @@ import { indent } from "../utils.js";
  * The optional `fn` function is used to print each AST node (default:
  * `console.log`).
  *
- * @param scope
- * @param ctx
- * @param level
+ * @param scope -
+ * @param ctx -
+ * @param level -
  */
 export const xfPrint = (fn = console.log) => {
     const $print = (scope, _, level = 0) => {
@@ -45,6 +45,6 @@ export const xfPrint = (fn = console.log) => {
  * //   lit: "]"
  * ```
  *
- * @param parser
+ * @param parser -
  */
 export const print = (parser, fn) => xform(parser, xfPrint(fn));

package/xform/trim.d.ts

@@ -5,13 +5,13 @@ import type { Parser, ScopeTransform } from "../api.js";
  *
  * {@link trim}.
  *
- * @param scope
+ * @param scope -
  */
 export declare const xfTrim: ScopeTransform<string>;
 /**
  * Syntax sugar for `xform(parser, xfTrim)`.
  *
- * @param parser
+ * @param parser -
  */
 export declare const trim: (parser: Parser<string>) => Parser<string>;
 //# sourceMappingURL=trim.d.ts.map

package/xform/trim.js

@@ -5,7 +5,7 @@ import { xform } from "../combinators/xform.js";
  *
  * {@link trim}.
  *
- * @param scope
+ * @param scope -
  */
 export const xfTrim = (scope) => {
     scope.result = scope.result.trim();
@@ -14,6 +14,6 @@ export const xfTrim = (scope) => {
 /**
  * Syntax sugar for `xform(parser, xfTrim)`.
  *
- * @param parser
+ * @param parser -
  */
 export const trim = (parser) => xform(parser, xfTrim);

package/xform/with-id.d.ts

@@ -3,7 +3,7 @@ import type { ScopeTransform, Parser } from "../api.js";
  * Assigns given `id` to AST node. E.g. used for re-labeling parser
  * results defined by {@link defGrammar}.
  *
- * @param id
+ * @param id -
  */
 export declare const xfID: (id: string) => ScopeTransform<any>;
 export declare const withID: <T>(id: string, parser: Parser<T>) => Parser<T>;

package/xform/with-id.js

@@ -3,7 +3,7 @@ import { xform } from "../combinators/xform.js";
  * Assigns given `id` to AST node. E.g. used for re-labeling parser
  * results defined by {@link defGrammar}.
  *
- * @param id
+ * @param id -
  */
 export const xfID = (id) => (scope) => ((scope.id = id), scope);
 export const withID = (id, parser) => xform(parser, xfID(id));