inferred-types 0.45.0 → 0.45.2

package/dist/runtime/api/defineApi.d.ts

@@ -0,0 +1,56 @@
+import { Api, ApiCallback, ApiEscape, AsApi, AsEscapeFunction, AsOptionalParamFn, Dictionary, Narrowable, OnPass, TypedFunction } from "../../types/index";
+/**
+ * **asEscapeFunction**`(fn)`
+ *
+ * Accepts a zero-parameter function as an escape function.
+ */
+export declare const asEscapeFunction: <TFn extends () => Narrowable>(fn: TFn) => AsEscapeFunction<TFn>;
+/**
+ * **asOptionalParamFunction**`(fn)`
+ *
+ * Marks a function as being optionally callable with _no parameters_.
+ */
+export declare const asOptionalParamFunction: <TFn extends (() => any) | ((p1?: any, p2?: any, p3?: any, p4?: any) => any)>(fn: TFn) => AsOptionalParamFn<TFn>;
+/**
+ * **asApi**`(surface)`
+ *
+ * Validates an API surface as a stateless API and returns it as `Api<Surface>` if
+ * it qualifies, otherwise results in an ErrorCondition.
+ */
+export declare const asApi: <T extends Dictionary | TypedFunction>(api: T) => OnPass<AsApi<T>, Api<T>>;
+/**
+ * **asCallbackProp**`(cb)`
+ *
+ * Defines a callback _type_ for a property in a function.
+ *
+ * **Note:** you will often _extend_ this type to understand the return type
+ */
+export declare const asCallbackProp: <TParams extends readonly Narrowable[]>(...args: TParams) => unknown;
+/**
+ * **getEscapeFunction**`(api)`
+ *
+ * Get's the escape function from a properly validated `Api<S>` (which
+ * is known to have an escape function).
+ */
+export declare const getEscapeFunction: <TApi extends Api>(api: TApi) => ApiEscape<TApi> & (() => unknown);
+/**
+ * **asApiCallback**`(api)`
+ *
+ * Converts a defined `Api` into a callback function which receives the API as an
+ * input to be used for a response.
+ */
+export declare const asApiCallback: <TApi extends Api>(api: TApi) => ApiCallback<TApi>;
+/**
+ * **asHandledApiCallback**`(api)`
+ *
+ * Takes an `Api` definition and converts it into a callback with a ApiHandler used.
+ *
+ * - if no handler is explicitly provided then the _default handler_ will be used
+ * - the default handler is responsible for:
+ *    - ensuring that if an uncalled part of the API is returned using the **escape function**
+ * to provide a more meaningful response
+ *    - if a function which is marked as being an `OptionalParamFn` is returned then it will
+ * be _called_ rather than leaving it as a function
+ */
+export declare const asHandledApiCallback: <T extends Api>(api: T, handler?: TypedFunction) => void;
+//# sourceMappingURL=defineApi.d.ts.map

package/dist/runtime/api/defineApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defineApi.d.ts","sourceRoot":"","sources":["../../../src/runtime/api/defineApi.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,GAAG,EACH,WAAW,EACX,SAAS,EAET,KAAK,EACL,gBAAgB,EAChB,iBAAiB,EACjB,UAAU,EACV,UAAU,EACV,MAAM,EACN,aAAa,EACd,0BAAwB;AAczB;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,qBACT,UAAU,MACxB,GAAG,0BAA8E,CAAC;AAGxF;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,sBACf,GAAG,WAAW,GAAG,OAAO,GAAG,OAAO,GAAG,OAAM,GAAG,KAAK,GAAG,OACrE,GAAG,2BAAuF,CAAC;AAEjG;;;;;GAKG;AACH,eAAO,MAAM,KAAK,8CAA+C,CAAC,KAAG,OAAO,MAAM,CAAC,CAAC,EAAC,IAAI,CAAC,CAAC,CAMlD,CAAC;AAK1C;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,mDAEhB,OAAO,YAAoB,CAAC;AAEvC;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,0BAGvB,IAAI,8BAYgC,OAAO,CACjD,CAAC;AAgCF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,0BAEnB,IAAI,sBAAY,CAAC;AAGxB;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,oBAAoB,uBAG1B,CAAC,YACI,aAAa,SAKxB,CAAA"}

package/dist/runtime/api/defineApi.js

@@ -0,0 +1,97 @@
+import { isApiSurface, isEscapeFunction, isFunction, isObject, } from "../index.js";
+import { isApi, createErrorCondition, createFnWithProps } from "../index.js";
+import { Never } from "../../constants/Never.js";
+/**
+ * **asEscapeFunction**`(fn)`
+ *
+ * Accepts a zero-parameter function as an escape function.
+ */
+export const asEscapeFunction = (fn) => createFnWithProps(fn, { escape: true });
+/**
+ * **asOptionalParamFunction**`(fn)`
+ *
+ * Marks a function as being optionally callable with _no parameters_.
+ */
+export const asOptionalParamFunction = (fn) => createFnWithProps(fn, { optionalParams: true });
+/**
+ * **asApi**`(surface)`
+ *
+ * Validates an API surface as a stateless API and returns it as `Api<Surface>` if
+ * it qualifies, otherwise results in an ErrorCondition.
+ */
+export const asApi = (api) => (isApi(api)
+    ? api
+    : isApiSurface(api)
+        ? { _kind: "api", surface: api }
+        : createErrorCondition("invalid-api"));
+// TODO: not implemented
+/**
+ * **asCallbackProp**`(cb)`
+ *
+ * Defines a callback _type_ for a property in a function.
+ *
+ * **Note:** you will often _extend_ this type to understand the return type
+ */
+export const asCallbackProp = (...args) => args;
+/**
+ * **getEscapeFunction**`(api)`
+ *
+ * Get's the escape function from a properly validated `Api<S>` (which
+ * is known to have an escape function).
+ */
+export const getEscapeFunction = (api) => {
+    const surface = api.surface;
+    return (isFunction(surface) && "escape" in surface && surface.escape === true
+        ? surface
+        : isObject(surface)
+            ? surface[Object.keys(surface).find(k => isEscapeFunction(surface[k]))]
+            : Never);
+};
+/**
+ * **defaultApiHandler**
+ *
+ * A handler which will automatically call:
+ *
+ * - a **optional parameter function** when the function is returned by user without a call to it
+ * - the **escape function** when an Api Surface is returned instead of value from the API
+ *
+ * All other user values are returned "as is" including a function which is not an
+ * _optional parameter function_ or an _escape function_.
+ */
+const defaultApiHandler = (_api) => {
+    // const esc = getEscapeFunction(api);
+    return (_result) => {
+    };
+};
+/** API callback */
+const cb = (api) => (cb) => {
+    try {
+        return cb(api.surface);
+    }
+    catch (e) {
+        throw new Error("oops");
+    }
+};
+/**
+ * **asApiCallback**`(api)`
+ *
+ * Converts a defined `Api` into a callback function which receives the API as an
+ * input to be used for a response.
+ */
+export const asApiCallback = (api) => cb(api);
+/**
+ * **asHandledApiCallback**`(api)`
+ *
+ * Takes an `Api` definition and converts it into a callback with a ApiHandler used.
+ *
+ * - if no handler is explicitly provided then the _default handler_ will be used
+ * - the default handler is responsible for:
+ *    - ensuring that if an uncalled part of the API is returned using the **escape function**
+ * to provide a more meaningful response
+ *    - if a function which is marked as being an `OptionalParamFn` is returned then it will
+ * be _called_ rather than leaving it as a function
+ */
+export const asHandledApiCallback = (api, handler) => {
+    let _h = handler ? handler : defaultApiHandler;
+    let _cb = asApiCallback(api);
+};

package/dist/runtime/api/handleDoneFn.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"handleDoneFn.d.ts","sourceRoot":"","sources":["../../../src/runtime/api/handleDoneFn.ts"],"names":[],"mappings":"AAEA;;;;;;;;;GASG;AACH,eAAO,MAAM,YAAY,uCAIlB,IAAI,iBACK,OAAO,QAWtB,CAAA"}

package/dist/runtime/api/index.d.ts

@@ -0,0 +1,3 @@
+export * from './defineApi';
+export * from "./handleDoneFn";
+//# sourceMappingURL=index.d.ts.map

package/dist/runtime/api/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/runtime/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC"}

package/dist/runtime/api/index.js

@@ -0,0 +1,2 @@
+export * from "./defineApi.js";
+export * from "./handleDoneFn.js";

package/dist/runtime/boolean-logic/ifArrayPartial.d.ts

@@ -1,3 +1,3 @@
 import { Narrowable } from "../../types/index";
-export declare function ifArrayPartial<T extends Narrowable>(): <IF extends Narrowable, ELSE extends Narrowable>(isAnArray: <N extends T & readonly unknown[]>(arr: N) => IF, isNotAnArray: <N_1 extends Exclude<T, unknown[] | readonly unknown[]>>(nonArr: N_1) => ELSE) => <V extends T>(val: V) => import("../../types/index").IsArray<V> extends true ? IF : ELSE;
+export declare function ifArrayPartial<T extends Narrowable>(): <IF extends Narrowable, ELSE extends Narrowable>(isAnArray: <N extends T & readonly unknown[]>(arr: N) => IF, isNotAnArray: <N_1 extends Exclude<T, readonly unknown[] | unknown[]>>(nonArr: N_1) => ELSE) => <V extends T>(val: V) => import("../../types/index").IsArray<V> extends true ? IF : ELSE;
 //# sourceMappingURL=ifArrayPartial.d.ts.map

package/dist/runtime/boolean-logic/ifArrayPartial.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ifArrayPartial.d.ts","sourceRoot":"","sources":["../../../src/runtime/boolean-logic/ifArrayPartial.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,0BAAwB;AAI7C,wBAAgB,cAAc,CAAC,CAAC,SAAS,UAAU,+GAEU,EAAE,yFACwB,IAAI,wBAE7D,CAAC,qEAE9B"}
+{"version":3,"file":"ifArrayPartial.d.ts","sourceRoot":"","sources":["../../../src/runtime/boolean-logic/ifArrayPartial.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,0BAAwB;AAK7C,wBAAgB,cAAc,CAAC,CAAC,SAAS,UAAU,+GAEU,EAAE,yFACwB,IAAI,wBAE7D,CAAC,qEAE9B"}

package/dist/runtime/boolean-logic/ifArrayPartial.js

@@ -1,4 +1,4 @@
-import { ifArray } from "../index.js";
+import { ifArray } from "./ifArray.js";
 export function ifArrayPartial() {
     return (isAnArray, isNotAnArray) => {
         return (val) => ifArray(val, isAnArray, isNotAnArray);

package/dist/runtime/boolean-logic/ifLength.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ifLength.d.ts","sourceRoot":"","sources":["../../../src/runtime/boolean-logic/ifLength.ts"],"names":[],"mappings":"AAAA,OAAO,EAAG,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,0BAAwB;AAEpF;;;;;;;;;;GAUG;AACH,wBAAgB,QAAQ,CACtB,KAAK,SAAS,SAAS,OAAO,EAAE,EAChC,IAAI,SAAS,MAAM,EACnB,EAAE,SAAS,UAAU,GAAG,KAAK,EAC7B,IAAI,SAAS,UAAU,GAAG,KAAK,EAE/B,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,IAAI,EACZ,KAAK,EAAE,CAAC,CAAC,SAAS,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,EACzE,OAAO,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,EAAC,CAAC,KAAK,IAAI,mCAQnF"}
+{"version":3,"file":"ifLength.d.ts","sourceRoot":"","sources":["../../../src/runtime/boolean-logic/ifLength.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,EAAE,EACF,OAAO,EACP,QAAQ,EACR,UAAU,EACV,MAAM,EACN,KAAK,EACN,0BAAwB;AAEzB;;;;;;;;;;GAUG;AACH,wBAAgB,QAAQ,CACtB,KAAK,SAAS,SAAS,OAAO,EAAE,EAChC,IAAI,SAAS,MAAM,EACnB,EAAE,SAAS,UAAU,GAAG,KAAK,EAC7B,IAAI,SAAS,UAAU,GAAG,KAAK,EAE/B,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,IAAI,EACZ,KAAK,EAAE,CAAC,CAAC,SAAS,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,EACzE,OAAO,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,EAAC,CAAC,KAAK,IAAI,mCAQnF"}

package/dist/runtime/boolean-logic/ifScalar.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ifScalar.d.ts","sourceRoot":"","sources":["../../../src/runtime/boolean-logic/ifScalar.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,0BAAwB;AAI/E;;;;;;;;;;;;GAYG;AACH,wBAAgB,QAAQ,CACtB,CAAC,SAAS,UAAU,EACpB,GAAG,SAAS,UAAU,EACtB,KAAK,SAAS,UAAU,EAExB,KAAK,EAAE,CAAC,EACR,UAAU,EAAE,CACV,CAAC,SAAS,OAAO,CAAC,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,OAAO,EAAE,CAAC,EACxD,CAAC,EAAE,CAAC,KAAK,GAAG,EACd,WAAW,EAAE,CAAC,CAAC,SAAS,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,KAAK,+CAQ3D"}
+{"version":3,"file":"ifScalar.d.ts","sourceRoot":"","sources":["../../../src/runtime/boolean-logic/ifScalar.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,EAAE,EACF,QAAQ,EACR,UAAU,EACV,MAAM,EACP,0BAAwB;AAKzB;;;;;;;;;;;;GAYG;AACH,wBAAgB,QAAQ,CACtB,CAAC,SAAS,UAAU,EACpB,GAAG,SAAS,UAAU,EACtB,KAAK,SAAS,UAAU,EAExB,KAAK,EAAE,CAAC,EACR,UAAU,EAAE,CACV,CAAC,SAAS,OAAO,CAAC,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,OAAO,EAAE,CAAC,EACxD,CAAC,EAAE,CAAC,KAAK,GAAG,EACd,WAAW,EAAE,CAAC,CAAC,SAAS,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,KAAK,+CAQ3D"}

package/dist/runtime/boolean-logic/ifScalar.js

@@ -1,4 +1,4 @@
-import { isScalar } from "../index.js";
+import { isScalar } from "../type-guards/isScalar.js";
 /**
  * **ifScalar**(value, ifCallback, notCallback)
  *

package/dist/runtime/boolean-logic/index.d.ts

@@ -16,5 +16,4 @@ export * from "./ifFalse";
 export * from "./ifChar";
 export * from "./ifUndefined";
 export * from "./ifArrayPartial";
-export * from "./handleDoneFn";
 //# sourceMappingURL=index.d.ts.map

package/dist/runtime/boolean-logic/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/runtime/boolean-logic/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/runtime/boolean-logic/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC"}

package/dist/runtime/boolean-logic/index.js

@@ -16,4 +16,3 @@ export * from "./ifFalse.js";
 export * from "./ifChar.js";
 export * from "./ifUndefined.js";
 export * from "./ifArrayPartial.js";
-export * from "./handleDoneFn.js";

package/dist/runtime/dictionary/defineOptions.d.ts

@@ -0,0 +1,26 @@
+import { Dictionary, MakeKeysRequired, RequiredKeys } from "../../types/index";
+export type UserOptions<TDefn extends Dictionary, TReq extends ((string | symbol) & keyof TDefn)> = TReq extends "" ? <T extends Partial<TDefn>, R extends TDefn>(opt?: T) => R & {
+    param: MakeKeysRequired<Partial<TDefn>, TReq>;
+} : TReq extends readonly (keyof TDefn)[] ? <T extends MakeKeysRequired<Partial<TDefn>, TReq>, R extends TDefn>(opt: T) => R & {
+    param: MakeKeysRequired<Partial<TDefn>, TReq>;
+} : never;
+export type AsUserOptions<TDefn extends Dictionary, _TDefaults extends Partial<TDefn>> = UserOptions<TDefn, RequiredKeys<TDefn>>;
+/**
+ * **defineOptions**`<T>(def_values?: () => { .. }) → UserOptions<T, TReq>`
+ *
+ * Defines:
+ *   1. a set of options,
+ *   2. allows default values to be assigned,
+ *   3. then provides
+ * a type for user input which makes all properties that were optional or have
+ * a default value be optional while also providing a type-strong merge function
+ * to merge in their results.
+ * ```ts
+ * // {
+ * //    userOptions: {width?: number; height: number}},
+ * //    merge<U>(user: U) => T
+ * // }
+ * const opts = defineOptions<{width: number; height: number}() => ({width: 640});
+ * ```
+ */
+//# sourceMappingURL=defineOptions.d.ts.map

package/dist/runtime/dictionary/defineOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defineOptions.d.ts","sourceRoot":"","sources":["../../../src/runtime/dictionary/defineOptions.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EAGV,gBAAgB,EAChB,YAAY,EACb,0BAAuB;AAMxB,MAAM,MAAM,WAAW,CACrB,KAAK,SAAS,UAAU,EACxB,IAAI,SAAS,CAAC,CAAC,MAAM,GAAC,MAAM,CAAC,GAAG,MAAM,KAAK,CAAC,IAC1C,IAAI,SAAS,EAAE,GACjB,CACE,CAAC,SAAS,OAAO,CAAC,KAAK,CAAC,EACxB,CAAC,SAAS,KAAK,EACf,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG;IAAE,KAAK,EAAE,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAA;CAAE,GACnE,IAAI,SAAS,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,GACrC,CACE,CAAC,SAAS,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,EAChD,CAAC,SAAS,KAAK,EACf,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG;IAAE,KAAK,EAAE,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAA;CAAE,GAClE,KAAK,CAAC;AAGR,MAAM,MAAM,aAAa,CACvB,KAAK,SAAS,UAAU,EACxB,UAAU,SAAS,OAAO,CAAC,KAAK,CAAC,IAC/B,WAAW,CACf,KAAK,EACL,YAAY,CAAC,KAAK,CAAC,CAClB,CAAC;AAiBF;;;;;;;;;;;;;;;;;GAiBG"}

package/dist/runtime/dictionary/defineOptions.js

@@ -0,0 +1,30 @@
+import { createFnWithProps, } from "../index.js";
+const _userOptions = (def_values) => createFnWithProps((opt) => {
+    return {
+        ...def_values,
+        opt
+    };
+}, { param: null });
+/**
+ * **defineOptions**`<T>(def_values?: () => { .. }) → UserOptions<T, TReq>`
+ *
+ * Defines:
+ *   1. a set of options,
+ *   2. allows default values to be assigned,
+ *   3. then provides
+ * a type for user input which makes all properties that were optional or have
+ * a default value be optional while also providing a type-strong merge function
+ * to merge in their results.
+ * ```ts
+ * // {
+ * //    userOptions: {width?: number; height: number}},
+ * //    merge<U>(user: U) => T
+ * // }
+ * const opts = defineOptions<{width: number; height: number}() => ({width: 640});
+ * ```
+ */
+// export const defineOptions = <
+//   T extends Dictionary
+// >(a: ({defaults: (<D extends Partial<T>>() => D)): void) => {
+//   return userOptions(cb());
+// };

package/dist/runtime/dictionary/keysOf.d.ts

@@ -8,5 +8,5 @@ import type { Container, Keys } from "../../types/index";
  * `readonly ["value"]` as the keys array when detected rather than reporting
  * on props like `__v_isRef`, etc.
  */
-export declare function keysOf<TContainer extends Container>(container: TContainer): Keys<TContainer>;
+export declare function keysOf<TContainer extends Container>(container: TContainer): Keys<TContainer> & readonly (keyof TContainer)[];
 //# sourceMappingURL=keysOf.d.ts.map

package/dist/runtime/dictionary/keysOf.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"keysOf.d.ts","sourceRoot":"","sources":["../../../src/runtime/dictionary/keysOf.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,0BAAwB;AAIvD;;;;;;;;GAQG;AACH,wBAAgB,MAAM,CAAC,UAAU,SAAS,SAAS,EACjD,SAAS,EAAE,UAAU,oBAatB"}
+{"version":3,"file":"keysOf.d.ts","sourceRoot":"","sources":["../../../src/runtime/dictionary/keysOf.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,0BAAwB;AAIvD;;;;;;;;GAQG;AACH,wBAAgB,MAAM,CAAC,UAAU,SAAS,SAAS,EACjD,SAAS,EAAE,UAAU,oDAatB"}

package/dist/runtime/errors/KindError.d.ts

@@ -1,4 +1,4 @@
-import { KindErrorDefn } from "../../types/index";
+import { KindErrorDefn, Unset } from "../../types/index";
 /**
  * **KindError**
  *
@@ -23,5 +23,5 @@ import { KindErrorDefn } from "../../types/index";
  * BadJuju("oh my god!", { flavor: "strawberry"})
  * ```
  */
-export declare const kindError: <K extends string, C extends Record<string, unknown> = {}>(kind: K, _defineContext?: C) => KindErrorDefn<K, C>;
+export declare const kindError: <K extends string, C extends Record<string, unknown> | Unset = Unset>(kind: K, _defineContext?: C) => KindErrorDefn<K, C>;
 //# sourceMappingURL=KindError.d.ts.map

package/dist/runtime/errors/KindError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"KindError.d.ts","sourceRoot":"","sources":["../../../src/runtime/errors/KindError.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2C,aAAa,EAAE,0BAAwB;AAGzF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,SAAS,mEAId,CAAC,mBACU,CAAC,KACjB,cAAc,CAAC,EAAC,CAAC,CAkBnB,CAAA"}
+{"version":3,"file":"KindError.d.ts","sourceRoot":"","sources":["../../../src/runtime/errors/KindError.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,aAAa,EACb,KAAK,EACN,0BAAwB;AAGzB;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,SAAS,8EAId,CAAC,mBACU,CAAC,KACjB,cAAc,CAAC,EAAC,CAAC,CAkBnB,CAAA"}

package/dist/runtime/functions/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./fnMeta";
+export * from "./wrapFn";
 //# sourceMappingURL=index.d.ts.map

package/dist/runtime/functions/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/runtime/functions/index.ts"],"names":[],"mappings":"AACA,cAAc,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/runtime/functions/index.ts"],"names":[],"mappings":"AACA,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC"}

package/dist/runtime/functions/index.js

@@ -1 +1,2 @@
 export * from "./fnMeta.js";
+export * from "./wrapFn.js";

package/dist/runtime/functions/wrapFn.d.ts

@@ -0,0 +1,2 @@
+export declare const wrapFn: "NOT IMPLEMENTED";
+//# sourceMappingURL=wrapFn.d.ts.map

package/dist/runtime/functions/wrapFn.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wrapFn.d.ts","sourceRoot":"","sources":["../../../src/runtime/functions/wrapFn.ts"],"names":[],"mappings":"AA+BA,eAAO,MAAM,MAAM,mBAA6B,CAAC"}

package/dist/runtime/functions/wrapFn.js

@@ -0,0 +1,24 @@
+// import { FnFrom } from "src/types/index";
+// import { identity } from "../literals";
+// export const wrapFn = <
+//   TInteriorFn extends TypedFunction,
+// >(fn: TInteriorFn) => {
+//   return <
+//     TWrap extends <I extends ReturnType<TInteriorFn>>(input: I) => unknown
+//   >(wrap: TWrap) => <F extends Parameters<TInteriorFn>>(...input: F) => {
+//     const interior = fn(input) as ReturnType<TInteriorFn>;
+//     return wrap(interior) as ReturnType<TWrap>
+//   }
+// };
+// export const wrapFn = <
+//   TWrap extends FnFrom<[any]>,
+// >(wrap: TWrap) => {
+//   return <TInterior extends (...args: any[]) => Parameters<TWrap>[0]>(fn: TInterior) => {
+//     return <TFn extends Parameters<TInterior>>(...args: TFn) => {
+//       const interior = identity(fn(...args) as ReturnType<TInterior>) as ()=>ReturnType<TInterior>;
+//       const wrapped = wrap(interior()) as ReturnType<TWrap>;
+//       return wrapped;
+//     }
+//   }
+// };
+export const wrapFn = "NOT IMPLEMENTED";

package/dist/runtime/index.d.ts

@@ -1,4 +1,4 @@
-export * from "./boolean-logic/index";
+export * from "./api/index";
 export * from "./combinators/index";
 export * from "./dictionary/index";
 export * from "./errors/index";

package/dist/runtime/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/runtime/index.ts"],"names":[],"mappings":"AASA,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,uBAAuB,CAAC;AACtC,cAAc,cAAc,CAAC;AAC7B,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/runtime/index.ts"],"names":[],"mappings":"AACA,cAAc,aAAa,CAAC;AAC5B,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,uBAAuB,CAAC;AACtC,cAAc,cAAc,CAAC;AAC7B,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAA"}

package/dist/runtime/index.js

@@ -1,10 +1,4 @@
-// #autoindex
-// #region auto-indexed files
-// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
-// hash-code: 9dd9ac96
-// file exports
-// directory exports
-export * from "./boolean-logic/index.js";
+export * from "./api/index.js";
 export * from "./combinators/index.js";
 export * from "./dictionary/index.js";
 export * from "./errors/index.js";
@@ -19,6 +13,3 @@ export * from "./sets/index.js";
 export * from "./type-conversion/index.js";
 export * from "./type-guards/index.js";
 export * from "./vuejs/index.js";
-// #endregion auto-indexed files
-// see https://github.com/inocan-group/do-devops/docs/autoindex.md
-// for more info

package/dist/runtime/lists/find.d.ts

@@ -4,7 +4,7 @@ import { Find, FromDefn, Narrowable, ShapeCallback, Tuple } from "../../types/in
  *
  * A configured utility designed to find elements in a list.
  */
-export type Finder<TList extends Tuple, TDeref extends string | number | null> = <TExtends extends Narrowable | ShapeCallback>(value: TExtends) => Find<TList, FromDefn<TExtends>, TDeref>;
+export type Finder<TList extends Tuple, TDeref extends string | number | null> = <TExtends extends Narrowable | ShapeCallback>(value: TExtends) => Find<TList, "equals", FromDefn<TExtends>, TDeref>;
 /**
  * **find**(list, [deref]) => (value) => el | undefined
  *

package/dist/runtime/lists/find.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"find.d.ts","sourceRoot":"","sources":["../../../src/runtime/lists/find.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,IAAI,EACJ,QAAQ,EACR,UAAU,EACV,aAAa,EACb,KAAK,EACN,0BAAwB;AAIzB;;;;GAIG;AACH,MAAM,MAAM,MAAM,CAChB,KAAK,SAAS,KAAK,EACnB,MAAM,SAAS,MAAM,GAAG,MAAM,GAAG,IAAI,IACnC,CAAC,QAAQ,SAAS,UAAU,GAAG,aAAa,EAAE,KAAK,EAAE,QAAQ,KAAK,IAAI,CACxE,KAAK,EACL,QAAQ,CAAC,QAAQ,CAAC,EAClB,MAAM,CACP,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,IAAI,yFAIT,KAAK,UACJ,MAAM,KACZ,OAAO,KAAK,EAAE,MAAM,CAYtB,CAAC"}
+{"version":3,"file":"find.d.ts","sourceRoot":"","sources":["../../../src/runtime/lists/find.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,IAAI,EACJ,QAAQ,EACR,UAAU,EACV,aAAa,EACb,KAAK,EACN,0BAAwB;AAIzB;;;;GAIG;AACH,MAAM,MAAM,MAAM,CAChB,KAAK,SAAS,KAAK,EACnB,MAAM,SAAS,MAAM,GAAG,MAAM,GAAG,IAAI,IACnC,CAAC,QAAQ,SAAS,UAAU,GAAG,aAAa,EAAE,KAAK,EAAE,QAAQ,KAAK,IAAI,CACxE,KAAK,EACL,QAAQ,EACR,QAAQ,CAAC,QAAQ,CAAC,EAClB,MAAM,CACP,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,IAAI,yFAIT,KAAK,UACJ,MAAM,KACZ,OAAO,KAAK,EAAE,MAAM,CAYtB,CAAC"}

package/dist/runtime/lists/intersection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"intersection.d.ts","sourceRoot":"","sources":["../../../src/runtime/lists/intersection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAa,YAAY,EAAG,0BAAwB;AA2ChE;;;;;;;;;GASG;AACH,eAAO,MAAM,YAAY,uGAKpB,CAAC,KACD,CAAC,UACG,MAAM,KACZ,aAAa,CAAC,EAAE,CAAC,EAAE,MAAM,CAM3B,CAAC"}
+{"version":3,"file":"intersection.d.ts","sourceRoot":"","sources":["../../../src/runtime/lists/intersection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAa,YAAY,EAAG,0BAAwB;AA4ChE;;;;;;;;;GASG;AACH,eAAO,MAAM,YAAY,uGAKpB,CAAC,KACD,CAAC,UACG,MAAM,KACZ,aAAa,CAAC,EAAE,CAAC,EAAE,MAAM,CAM3B,CAAC"}

package/dist/runtime/lists/intersection.js

@@ -1,4 +1,5 @@
-import { isIndexable, getEach, ifNotNull, get } from "../index.js";
+import { isIndexable, getEach, get } from "../index.js";
+import { ifNotNull } from "../boolean-logic/ifNotNull.js";
 function intersectWithOffset(a, b, deref) {
     const aIndexable = a.every(i => isIndexable(i));
     const bIndexable = b.every(i => isIndexable(i));

package/dist/runtime/literals/asPhoneNumber.d.ts

@@ -0,0 +1,10 @@
+import { RemovePhoneCountryCode, GetPhoneCountryCode, PhoneNumber, ToPhoneFormat } from "../../types/index";
+export declare const getPhoneCountryCode: <T extends string>(phone: T) => GetPhoneCountryCode<T>;
+export declare const removePhoneCountryCode: <T extends string>(phone: T) => RemovePhoneCountryCode<T>;
+/**
+ * **asPhoneNumber**`(phone, format)`
+ *
+ * Receives a phone number and returns it as a well formatted version.
+ */
+export declare const asPhoneNumber: <T extends string, F extends "Dashed (e.g., 456-555-1212)" | "Dotted (e.g., 456.555.1212)" | "ParaSpaced (e.g., (456) 555 1212)" | "ParaDashed (e.g., (456) 555-1212)">(phone: T & PhoneNumber<T>, format?: F) => ToPhoneFormat<T, F>;
+//# sourceMappingURL=asPhoneNumber.d.ts.map

package/dist/runtime/literals/asPhoneNumber.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"asPhoneNumber.d.ts","sourceRoot":"","sources":["../../../src/runtime/literals/asPhoneNumber.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,mBAAmB,EAAe,WAAW,EAAE,aAAa,EAAE,0BAAwB;AAKvH,eAAO,MAAM,mBAAmB,4BACvB,CAAC,2BAUT,CAAA;AAED,eAAO,MAAM,sBAAsB,4BAE1B,CAAC,8BAUT,CAAA;AA2BD;;;;GAIG;AACH,eAAO,MAAM,aAAa,iLAIjB,CAAC,GAAG,YAAY,CAAC,CAAC,WACjB,CAAC,wBAyBV,CAAA"}

package/dist/runtime/literals/asPhoneNumber.js

@@ -0,0 +1,62 @@
+import { asChars, isPhoneNumber, retainWhile, stripChars, stripLeading } from "../index.js";
+import { NUMERIC_CHAR } from "../../constants/NumericChar.js";
+export const getPhoneCountryCode = (phone) => {
+    return (phone.trim().startsWith("+") || phone.trim().startsWith("00")
+        ? retainWhile(stripLeading(stripLeading(phone.trim(), "+"), "00"), ...NUMERIC_CHAR)
+        : "");
+};
+export const removePhoneCountryCode = (phone) => {
+    const countryCode = getPhoneCountryCode(phone);
+    return (countryCode !== ""
+        ? stripLeading(stripLeading(phone.trim(), "+", "00"), countryCode).trim()
+        : phone.trim());
+};
+const convert = (countryCode, phone, delimiter, para) => {
+    const parts = stripChars(phone, "(", ")").trim().split(/[-. ]/);
+    const isRegional = parts.length === 2 ? true : false;
+    const isCountry = parts.length === 3 ? true : false;
+    const isShortCode = parts.length === 1 && asChars(phone).length < 7 ? true : false;
+    const replacement = isShortCode
+        ? phone
+        : isRegional
+            ? parts.join(delimiter)
+            : isCountry && para
+                ? `(${parts[0]}) ${parts.slice(1).join(delimiter)}`
+                : isCountry
+                    ? parts.join(delimiter)
+                    : undefined;
+    if (!replacement) {
+        throw new Error(`invalid phone number: ${phone}. Unable to parse!`);
+    }
+    return countryCode === ""
+        ? replacement
+        : `+${countryCode} ${replacement}`;
+};
+/**
+ * **asPhoneNumber**`(phone, format)`
+ *
+ * Receives a phone number and returns it as a well formatted version.
+ */
+export const asPhoneNumber = (phone, format = "Dotted (e.g., 456.555.1212)") => {
+    if (!isPhoneNumber(phone)) {
+        throw new Error(`Invalid phone number presented to asPhoneNumber(phone,format)!`);
+    }
+    const countryCode = getPhoneCountryCode(phone);
+    const remaining = removePhoneCountryCode(phone);
+    let result;
+    switch (format) {
+        case "Dashed (e.g., 456-555-1212)":
+            result = convert(countryCode, remaining, "-", false);
+            break;
+        case "Dotted (e.g., 456.555.1212)":
+            result = convert(countryCode, remaining, ".", false);
+            break;
+        case "ParaDashed (e.g., (456) 555-1212)":
+            result = convert(countryCode, remaining, "-", true);
+            break;
+        case "ParaSpaced (e.g., (456) 555 1212)":
+            result = convert(countryCode, remaining, " ", true);
+            break;
+    }
+    return result;
+};

package/dist/runtime/literals/index.d.ts

@@ -32,4 +32,8 @@ export * from "./toUppercase";
 export * from "./toNumericArray";
 export * from "./truncate";
 export * from "./takeNumericCharacters";
+export * from "./retainChars";
+export * from "./stripChars";
+export * from "./retainWhile";
+export * from "./asPhoneNumber";
 //# sourceMappingURL=index.d.ts.map

package/dist/runtime/literals/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/runtime/literals/index.ts"],"names":[],"mappings":"AAMA,cAAc,OAAO,CAAC;AACtB,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,QAAQ,CAAC;AACvB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,YAAY,CAAC;AAC3B,cAAc,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/runtime/literals/index.ts"],"names":[],"mappings":"AAMA,cAAc,OAAO,CAAC;AACtB,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,QAAQ,CAAC;AACvB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,YAAY,CAAC;AAC3B,cAAc,yBAAyB,CAAC;AACxC,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC"}

package/dist/runtime/literals/index.js

@@ -37,6 +37,10 @@ export * from "./toUppercase.js";
 export * from "./toNumericArray.js";
 export * from "./truncate.js";
 export * from "./takeNumericCharacters.js";
+export * from "./retainChars.js";
+export * from "./stripChars.js";
+export * from "./retainWhile.js";
+export * from "./asPhoneNumber.js";
 // #endregion auto-indexed files
 // see https://github.com/inocan-group/do-devops/docs/autoindex.md
 // for more info

package/dist/runtime/literals/retainChars.d.ts

@@ -0,0 +1,16 @@
+import { RetainChars, TupleToUnion } from "../../types/type-conversion";
+/**
+ * **retainChars**`(content, ...retain)`
+ *
+ * Retains the characters from `retain[]` which are
+ * found in `content` while discarding the rest.
+ *
+ * ```ts
+ * // "42"
+ * const num = retainChars("4foobar2", ...NUMERIC_CHAR);
+ * ```
+ *
+ * **Related:** `stripChars()`, `retainWhile()`, `retainUntil()`
+ */
+export declare const retainChars: <TContent extends string, TRetain extends readonly string[]>(content: TContent, ...retain: TRetain) => RetainChars<TContent, TupleToUnion<TRetain>>;
+//# sourceMappingURL=retainChars.d.ts.map

package/dist/runtime/literals/retainChars.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"retainChars.d.ts","sourceRoot":"","sources":["../../../src/runtime/literals/retainChars.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,oCAAkC;AAGtE;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,WAAW,wEAIb,QAAQ,aACN,OAAO,KACjB,YAAY,QAAQ,EAAE,aAAa,OAAO,CAAC,CAE7C,CAAA"}

package/dist/runtime/literals/retainChars.js

@@ -0,0 +1,17 @@
+import { asChars } from "../type-conversion/asChars.js";
+/**
+ * **retainChars**`(content, ...retain)`
+ *
+ * Retains the characters from `retain[]` which are
+ * found in `content` while discarding the rest.
+ *
+ * ```ts
+ * // "42"
+ * const num = retainChars("4foobar2", ...NUMERIC_CHAR);
+ * ```
+ *
+ * **Related:** `stripChars()`, `retainWhile()`, `retainUntil()`
+ */
+export const retainChars = (content, ...retain) => {
+    return asChars(content).filter(c => retain.includes(c)).join("");
+};

package/dist/runtime/literals/retainWhile.d.ts

@@ -0,0 +1,11 @@
+import { RetainWhile } from "../../types/string-literals";
+import { TupleToUnion } from "../../types/type-conversion";
+/**
+ * **retainWhile**`(content, ...retain)`
+ *
+ * Retains the characters at the start of the string
+ * so long as they are part of the character values
+ * passed in for `retain[]`
+ */
+export declare const retainWhile: <TContent extends string, TRetain extends readonly string[]>(content: TContent, ...retain: TRetain) => RetainWhile<TContent, TupleToUnion<TRetain>>;
+//# sourceMappingURL=retainWhile.d.ts.map

package/dist/runtime/literals/retainWhile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"retainWhile.d.ts","sourceRoot":"","sources":["../../../src/runtime/literals/retainWhile.ts"],"names":[],"mappings":"AAAA,OAAO,EAAG,WAAW,EAAE,oCAAkC;AAEzD,OAAO,EAAE,YAAY,EAAE,oCAAkC;AAGzD;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,wEAIb,QAAQ,aACN,OAAO,iDAInB,CAAA"}

package/dist/runtime/literals/retainWhile.js

@@ -0,0 +1,12 @@
+import { asChars } from "../type-conversion/index.js";
+/**
+ * **retainWhile**`(content, ...retain)`
+ *
+ * Retains the characters at the start of the string
+ * so long as they are part of the character values
+ * passed in for `retain[]`
+ */
+export const retainWhile = (content, ...retain) => {
+    const stopIdx = asChars(content).findIndex(c => !retain.includes(c));
+    return content.slice(0, stopIdx);
+};