@oliversalzburg/js-utils 0.0.2 → 0.0.4

package/README.md

@@ -1,48 +1 @@
-# Project Template
-
-## Does
-
--   [Yarn 3](https://yarnpkg.com/)
--   Uses [TypeScript](https://www.typescriptlang.org/)
--   Target application runs in [Node.js](https://nodejs.org/)
--   [esbuild](https://esbuild.github.io/)
--   [EditorConfig](https://editorconfig.org/) + [ESLint](https://eslint.org/) + [Prettier](https://prettier.io/) + [lint-staged](https://github.com/okonet/lint-staged)
--   QA with [GitHub Actions](https://github.com/features/actions)
--   [MkDocs](https://www.mkdocs.org/)-oriented Markdown in mind
-
-## Doesn't
-
--   [Yarn PnP](https://yarnpkg.com/features/pnp)
--   [Yarn telemetry](https://yarnpkg.com/advanced/telemetry)
--   [Yarn Zero-Installs](https://yarnpkg.com/features/zero-installs)
--   [Husky](https://github.com/typicode/husky)
-
-## Why
-
-1.  Why modern Yarn?
-
-    Among other things, Yarn is robust, performant and extremely versatile when it comes to repository management. The given configuration provides a very solid first-time experience. Some of the things that make modern Yarn great can be seen in this project template.
-
-1.  Why esbuild?
-
-    We want fast builds. The code is still checked for correctness in the editor and in CI.
-
-1.  Why the MkDocs Markdown?
-
-    If you're going to want to build any documentation site, you will appreciate having auto-formatted to this style from the start. Using mkdocs-material for documentation sites is highly recommended. The Python Markdown ecosystem is much more versatile and performant than the JS/TS space.
-
-1.  Why is PnP disabled?
-
-    While PnP is generally preferred for its strictness, using it still incurs a lot of friction. Because PnP is enabled by default in modern Yarn, this deters many users from adopting modern Yarn. Thus, this project uses Yarn's `node-modules` linker, the behavior of which should be very familiar to most adopters.
-
-1.  Why is telemetry disabled?
-
-    Whenever possible, the disclosure of _any_ data should be opt-in. Please refer to the document linked above, and enable telemetry after carefully reading it.
-
-1.  Why not Zero-Installs?
-
-    Zero-Installs are purely a `.gitignore`-controlled feature. Most new adopters do not expect the behavior of the default configuration and some adopters have raised concerns over long-term effects. Enable it after carefully reading the article linked above.
-
-1.  Why not use Husky for the hook?
-
-    Husky is more complex than what is required to install the hook in a modern Yarn repository. We also do not want to hand over control over repository behavior to a dependency.
+# JS Utils

package/output/array.d.ts

@@ -1,5 +1,32 @@
-import { ConstructorOf } from "./nil.js";
+import { ConstructorOf } from "./core.js";
+/**
+ * Places the items in the array in random order.
+ * @param array The array to shuffle.
+ * @returns The passed array in random order.
+ */
 export declare const shuffleArray: <T>(array: T[]) => T[];
+/**
+ * Returns an array that holds all items that appear in both
+ * passed arrays.
+ * @param a The first array.
+ * @param b The second array.
+ * @returns A new array which holds the items that appear in
+ * both passed arrays.
+ */
 export declare const intersect: <T>(a: T[], b: T[]) => T[];
+/**
+ * Returns an array that holds all items that only appear in `a`.
+ * @param a The first array.
+ * @param b The second array.
+ * @returns A new array which holds the items that ony appear
+ * in `a`.
+ */
 export declare const difference: <T>(a: T[], b: T[]) => T[];
+/**
+ * From an array with unknown contents, retrieve all the elements
+ * that are of a certain type and return them as a new array.
+ * @param array The array to filter.
+ * @param InstanceType The type to search for.
+ * @returns A new array with the filtered items.
+ */
 export declare const filterType: <T>(array: Array<unknown>, InstanceType: ConstructorOf<T>) => T[];

package/output/array.js

@@ -1,4 +1,9 @@
 import { is } from "./nil.js";
+/**
+ * Places the items in the array in random order.
+ * @param array The array to shuffle.
+ * @returns The passed array in random order.
+ */
 export const shuffleArray = (array) => {
     for (let index = array.length - 1; index > 0; index--) {
         const targetIndex = Math.floor(Math.random() * (index + 1));
@@ -8,11 +13,33 @@ export const shuffleArray = (array) => {
     }
     return array;
 };
+/**
+ * Returns an array that holds all items that appear in both
+ * passed arrays.
+ * @param a The first array.
+ * @param b The second array.
+ * @returns A new array which holds the items that appear in
+ * both passed arrays.
+ */
 export const intersect = (a, b) => {
     return a.filter(x => b.includes(x));
 };
+/**
+ * Returns an array that holds all items that only appear in `a`.
+ * @param a The first array.
+ * @param b The second array.
+ * @returns A new array which holds the items that ony appear
+ * in `a`.
+ */
 export const difference = (a, b) => {
     return a.filter(x => !b.includes(x));
 };
+/**
+ * From an array with unknown contents, retrieve all the elements
+ * that are of a certain type and return them as a new array.
+ * @param array The array to filter.
+ * @param InstanceType The type to search for.
+ * @returns A new array with the filtered items.
+ */
 export const filterType = (array, InstanceType) => array.filter(element => is(element, InstanceType));
 //# sourceMappingURL=array.js.map

package/output/array.js.map

@@ -1 +1 @@
-{"version":3,"file":"array.js","sourceRoot":"","sources":["../source/array.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,EAAE,EAAE,MAAM,UAAU,CAAC;AAE7C,MAAM,CAAC,MAAM,YAAY,GAAG,CAAI,KAAe,EAAE,EAAE;IACjD,KAAK,IAAI,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,EAAE,KAAK,EAAE,EAAE;QACrD,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;QAC5D,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;QAC1B,KAAK,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;QAClC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;KAC3B;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAI,CAAW,EAAE,CAAW,EAAE,EAAE;IACvD,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AACtC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,CAAI,CAAW,EAAE,CAAW,EAAE,EAAE;IACxD,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AACvC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,CAAI,KAAqB,EAAE,YAA8B,EAAE,EAAE,CACrF,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,YAAY,CAAC,CAAa,CAAC"}
+{"version":3,"file":"array.js","sourceRoot":"","sources":["../source/array.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,EAAE,MAAM,UAAU,CAAC;AAE9B;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAI,KAAe,EAAE,EAAE;IACjD,KAAK,IAAI,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,EAAE,KAAK,EAAE,EAAE;QACrD,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;QAC5D,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;QAC1B,KAAK,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;QAClC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;KAC3B;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAI,CAAW,EAAE,CAAW,EAAE,EAAE;IACvD,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AACtC,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAI,CAAW,EAAE,CAAW,EAAE,EAAE;IACxD,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AACvC,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAI,KAAqB,EAAE,YAA8B,EAAE,EAAE,CACrF,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,YAAY,CAAC,CAAa,CAAC"}

package/output/core.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Describes a function that is a constructor for T.
+ */
+export type ConstructorOf<T = Record<string, unknown>> = new (...args: any[]) => T;

package/output/core.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=core.js.map

package/output/core.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.js","sourceRoot":"","sources":["../source/core.ts"],"names":[],"mappings":""}

package/output/error-serializer.d.ts

@@ -0,0 +1,37 @@
+import { AbstractError } from "./errors/AbstractError.js";
+/**
+ * The shape of an `Error` instance, after it has been serialized into a simple hash.
+ */
+export type SerializedError = Record<string, Record<string, string> | string | undefined>;
+/**
+ * Determine if the given unknown subject is an `Error` instance.
+ * @param subject The object to inspect.
+ * @returns `true` if the subject is an `Error`, `false´ otherwise.
+ */
+export declare const isError: (subject: unknown) => subject is Error;
+/**
+ * Returns an `AbstractError` that best represents the passed subject.
+ * If the passed subject is already an `AbstractError`, it is returned as-is.
+ * Otherwise, it will be converted into an appropriate error type.
+ * @param subject The subject to inspect
+ * @returns An `AbstractError` instance.
+ */
+export declare const unknownToError: (subject: unknown) => AbstractError;
+/**
+ * Serializes an error into a JSON string.
+ * @param error The error to stringify.
+ * @returns A JSON string representing the error.
+ */
+export declare const errorToJSON: (error: Error) => string;
+/**
+ * Converts an error into a regular hash.
+ * @param error The error to convert.
+ * @returns A new object that contains all the properties of the error.
+ */
+export declare const errorToRecord: (error: Error) => Record<string, unknown>;
+/**
+ * Serializes an error into a simpler shape.
+ * @param error The error to serialize.
+ * @returns A simple representation of the error.
+ */
+export declare const errorToSimpleSerializable: <TError extends AbstractError = AbstractError>(error: TError) => SerializedError;

package/output/error-serializer.js

@@ -0,0 +1,63 @@
+import { types } from "node:util";
+import { AbstractError } from "./errors/AbstractError.js";
+import { InternalError } from "./errors/InternalError.js";
+import { UnknownError } from "./errors/UnknownError.js";
+/**
+ * Determine if the given unknown subject is an `Error` instance.
+ * @param subject The object to inspect.
+ * @returns `true` if the subject is an `Error`, `false´ otherwise.
+ */
+export const isError = (subject) => {
+    return subject instanceof Error || types.isNativeError(subject);
+};
+/**
+ * Returns an `AbstractError` that best represents the passed subject.
+ * If the passed subject is already an `AbstractError`, it is returned as-is.
+ * Otherwise, it will be converted into an appropriate error type.
+ * @param subject The subject to inspect
+ * @returns An `AbstractError` instance.
+ */
+export const unknownToError = (subject) => {
+    if (AbstractError.isAbstractError(subject)) {
+        return subject;
+    }
+    if (isError(subject)) {
+        return InternalError.fromError(subject);
+    }
+    return new UnknownError(String(subject));
+};
+/**
+ * Serializes an error into a JSON string.
+ * @param error The error to stringify.
+ * @returns A JSON string representing the error.
+ */
+export const errorToJSON = (error) => {
+    return JSON.stringify(error, Object.getOwnPropertyNames(error));
+};
+/**
+ * Converts an error into a regular hash.
+ * @param error The error to convert.
+ * @returns A new object that contains all the properties of the error.
+ */
+export const errorToRecord = (error) => {
+    const record = {};
+    for (const propertyName of Object.getOwnPropertyNames(error)) {
+        record[propertyName] = error[propertyName];
+    }
+    return record;
+};
+/**
+ * Serializes an error into a simpler shape.
+ * @param error The error to serialize.
+ * @returns A simple representation of the error.
+ */
+export const errorToSimpleSerializable = (error) => {
+    const serialized = {
+        code: error.code,
+        message: error.message,
+        name: error.name,
+        stack: error.stack,
+    };
+    return serialized;
+};
+//# sourceMappingURL=error-serializer.js.map

package/output/error-serializer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-serializer.js","sourceRoot":"","sources":["../source/error-serializer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAOxD;;;;GAIG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,OAAgB,EAAoB,EAAE;IAC5D,OAAO,OAAO,YAAY,KAAK,IAAI,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;AAClE,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,OAAgB,EAAiB,EAAE;IAChE,IAAI,aAAa,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE;QAC1C,OAAO,OAAO,CAAC;KAChB;IAED,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;QACpB,OAAO,aAAa,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;KACzC;IAED,OAAO,IAAI,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;AAC3C,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,KAAY,EAAU,EAAE;IAClD,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC;AAClE,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,KAAY,EAA2B,EAAE;IACrE,MAAM,MAAM,GAA4B,EAAE,CAAC;IAC3C,KAAK,MAAM,YAAY,IAAI,MAAM,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE;QAC5D,MAAM,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,YAAkC,CAAC,CAAC;KAClE;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CACvC,KAAa,EACI,EAAE;IACnB,MAAM,UAAU,GAAoB;QAClC,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,KAAK,EAAE,KAAK,CAAC,KAAK;KACnB,CAAC;IAEF,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC"}

package/output/errors/AbstractError.d.ts

@@ -0,0 +1,34 @@
+import { Maybe } from "../nil.js";
+/**
+ * Base class for all errors.
+ */
+export declare class AbstractError extends Error {
+    /**
+     * The HTTP status code to associate with this error.
+     * @deprecated We no longer respond to HTTP requests with error-specifc
+     * status codes.
+     */
+    status: number;
+    /**
+     * Another error that should be transported with this error.
+     * @deprecated We don't make use of this or interpret nested errors at all.
+     */
+    inner: Maybe<Error>;
+    /**
+     * A user-friendly error message that may be transported to the client.
+     * @deprecated User-friendly errors should be read from `extensions`.
+     */
+    info: Maybe<string>;
+    /**
+     * An application-unique, readable error code.
+     */
+    code: string;
+    /**
+     * Constructs a new AbstractError.
+     * @param code The main identification code for the error.
+     * @param message The main error message.
+     * @param status The HTTP status code to return.
+     */
+    constructor(code: string, message: string, status: number);
+    static isAbstractError(error: unknown, allowForeignModule?: boolean): error is AbstractError;
+}

package/output/errors/AbstractError.js

@@ -0,0 +1,62 @@
+/**
+ * Base class for all errors.
+ */
+export class AbstractError extends Error {
+    /**
+     * The HTTP status code to associate with this error.
+     * @deprecated We no longer respond to HTTP requests with error-specifc
+     * status codes.
+     */
+    status;
+    /**
+     * Another error that should be transported with this error.
+     * @deprecated We don't make use of this or interpret nested errors at all.
+     */
+    inner;
+    /**
+     * A user-friendly error message that may be transported to the client.
+     * @deprecated User-friendly errors should be read from `extensions`.
+     */
+    info;
+    /**
+     * An application-unique, readable error code.
+     */
+    code;
+    /**
+     * Constructs a new AbstractError.
+     * @param code The main identification code for the error.
+     * @param message The main error message.
+     * @param status The HTTP status code to return.
+     */
+    constructor(code, message, status) {
+        super(message);
+        this.code = code;
+        this.name = "AbstractError";
+        this.status = status;
+        this.inner = null;
+        // Capture a new stacktrace, otherwise it will include our base-class constructor instead of the code
+        // location we're actually interested in.
+        Error.captureStackTrace(this, AbstractError);
+    }
+    static isAbstractError(error, allowForeignModule = true) {
+        if (error instanceof AbstractError) {
+            return true;
+        }
+        // When multiple versions of core-models3 are loaded at runtime, the
+        // prototypes of errors don't align. In that case, we just analyze the
+        // error code.
+        if (allowForeignModule) {
+            const errorRecord = error;
+            if (Object(error) === error &&
+                "code" in errorRecord &&
+                typeof errorRecord.code === "string") {
+                const codedError = error;
+                if (codedError.code.match(/^ERR_OS_/)) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
+}
+//# sourceMappingURL=AbstractError.js.map

package/output/errors/AbstractError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractError.js","sourceRoot":"","sources":["../../source/errors/AbstractError.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,KAAK;IACtC;;;;OAIG;IACH,MAAM,CAAS;IAEf;;;OAGG;IACH,KAAK,CAAe;IAEpB;;;OAGG;IACH,IAAI,CAAgB;IAEpB;;OAEG;IACH,IAAI,CAAS;IAEb;;;;;OAKG;IACH,YAAY,IAAY,EAAE,OAAe,EAAE,MAAc;QACvD,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAElB,qGAAqG;QACrG,yCAAyC;QACzC,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IAC/C,CAAC;IAED,MAAM,CAAC,eAAe,CAAC,KAAc,EAAE,kBAAkB,GAAG,IAAI;QAC9D,IAAI,KAAK,YAAY,aAAa,EAAE;YAClC,OAAO,IAAI,CAAC;SACb;QAED,oEAAoE;QACpE,sEAAsE;QACtE,cAAc;QACd,IAAI,kBAAkB,EAAE;YACtB,MAAM,WAAW,GAAG,KAAgC,CAAC;YACrD,IACE,MAAM,CAAC,KAAK,CAAC,KAAK,KAAK;gBACvB,MAAM,IAAI,WAAW;gBACrB,OAAO,WAAW,CAAC,IAAI,KAAK,QAAQ,EACpC;gBACA,MAAM,UAAU,GAAG,KAAyB,CAAC;gBAC7C,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE;oBACrC,OAAO,IAAI,CAAC;iBACb;aACF;SACF;QAED,OAAO,KAAK,CAAC;IACf,CAAC;CACF"}

package/output/errors/InternalError.d.ts

@@ -0,0 +1,14 @@
+import { AbstractError } from "./AbstractError.js";
+/**
+ * Used when an `Error`-like object was caught and converted into an
+ * implementation of `AbstractError` for further processing.
+ */
+export declare class InternalError extends AbstractError {
+    /**
+     * Constructs a new `InternalError`.
+     * @param message The main error message.
+     * @param status The HTTP status code to return.
+     */
+    constructor(message: string, status?: number);
+    static fromError(error: Error): InternalError;
+}

package/output/errors/InternalError.js

@@ -0,0 +1,33 @@
+import { AbstractError } from "./AbstractError.js";
+/**
+ * Used when an `Error`-like object was caught and converted into an
+ * implementation of `AbstractError` for further processing.
+ */
+export class InternalError extends AbstractError {
+    /**
+     * Constructs a new `InternalError`.
+     * @param message The main error message.
+     * @param status The HTTP status code to return.
+     */
+    constructor(message, status = 500) {
+        super("ERR_OS_INTERNAL", message, status);
+        this.name = "InternalError";
+        // Capture a new stacktrace, otherwise it will include our base-class
+        // constructor instead of the code location we're actually interested in.
+        Error.captureStackTrace(this, InternalError);
+    }
+    static fromError(error) {
+        // Create a _real_ `InternalError` instance, which we will return later.
+        const internalError = new InternalError(error.message);
+        // Assign the error to it, to inherit all the fields in the error.
+        // Then assign another `InternalError` to replace key fields, like:
+        // name, code, status, ...
+        Object.assign(internalError, error, new InternalError(error.message));
+        // Set the inner error.
+        internalError.inner = error;
+        // Inherit the original error stack again.
+        internalError.stack = error.stack;
+        return internalError;
+    }
+}
+//# sourceMappingURL=InternalError.js.map

package/output/errors/InternalError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InternalError.js","sourceRoot":"","sources":["../../source/errors/InternalError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;GAGG;AACH,MAAM,OAAO,aAAc,SAAQ,aAAa;IAC9C;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,iBAAiB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAE1C,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAE5B,qEAAqE;QACrE,yEAAyE;QACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IAC/C,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,KAAY;QAC3B,wEAAwE;QACxE,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACvD,kEAAkE;QAClE,mEAAmE;QACnE,0BAA0B;QAC1B,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,KAAK,EAAE,IAAI,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QACtE,uBAAuB;QACvB,aAAa,CAAC,KAAK,GAAG,KAAK,CAAC;QAC5B,0CAA0C;QAC1C,aAAa,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;QAElC,OAAO,aAAa,CAAC;IACvB,CAAC;CACF"}

package/output/errors/InvalidArgumentError.d.ts

@@ -0,0 +1,13 @@
+import { AbstractError } from "./AbstractError.js";
+/**
+ * Used when the user supplied an argument that is not valid in the current
+ * context.
+ */
+export declare class InvalidArgumentError extends AbstractError {
+    /**
+     * Constructs a new `InvalidArgumentError`.
+     * @param message The main error message.
+     * @param status The HTTP status code to return.
+     */
+    constructor(message: string, status?: number);
+}

package/output/errors/InvalidArgumentError.js

@@ -0,0 +1,20 @@
+import { AbstractError } from "./AbstractError.js";
+/**
+ * Used when the user supplied an argument that is not valid in the current
+ * context.
+ */
+export class InvalidArgumentError extends AbstractError {
+    /**
+     * Constructs a new `InvalidArgumentError`.
+     * @param message The main error message.
+     * @param status The HTTP status code to return.
+     */
+    constructor(message, status = 400) {
+        super("ERR_OS_INVALID_ARGUMENT", message, status);
+        this.name = "InvalidArgumentError";
+        // Capture a new stacktrace, otherwise it will include our base-class
+        // constructor instead of the code location we're actually interested in.
+        Error.captureStackTrace(this, InvalidArgumentError);
+    }
+}
+//# sourceMappingURL=InvalidArgumentError.js.map

package/output/errors/InvalidArgumentError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InvalidArgumentError.js","sourceRoot":"","sources":["../../source/errors/InvalidArgumentError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;GAGG;AACH,MAAM,OAAO,oBAAqB,SAAQ,aAAa;IACrD;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,yBAAyB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAElD,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;QAEnC,qEAAqE;QACrE,yEAAyE;QACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,oBAAoB,CAAC,CAAC;IACtD,CAAC;CACF"}

package/output/errors/InvalidOperationError.d.ts

@@ -0,0 +1,13 @@
+import { AbstractError } from "./AbstractError.js";
+/**
+ * Used when an operation was attempted that can not be completed in the current
+ * context.
+ */
+export declare class InvalidOperationError extends AbstractError {
+    /**
+     * Constructs a new `InvalidOperationError`.
+     * @param message The main error message.
+     * @param status The HTTP status code to return.
+     */
+    constructor(message: string, status?: number);
+}

package/output/errors/InvalidOperationError.js

@@ -0,0 +1,20 @@
+import { AbstractError } from "./AbstractError.js";
+/**
+ * Used when an operation was attempted that can not be completed in the current
+ * context.
+ */
+export class InvalidOperationError extends AbstractError {
+    /**
+     * Constructs a new `InvalidOperationError`.
+     * @param message The main error message.
+     * @param status The HTTP status code to return.
+     */
+    constructor(message, status = 400) {
+        super("ERR_OS_INVALID_OPERATION", message, status);
+        this.name = "InvalidOperationError";
+        // Capture a new stacktrace, otherwise it will include our base-class
+        // constructor instead of the code location we're actually interested in.
+        Error.captureStackTrace(this, InvalidOperationError);
+    }
+}
+//# sourceMappingURL=InvalidOperationError.js.map

package/output/errors/InvalidOperationError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InvalidOperationError.js","sourceRoot":"","sources":["../../source/errors/InvalidOperationError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;GAGG;AACH,MAAM,OAAO,qBAAsB,SAAQ,aAAa;IACtD;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,0BAA0B,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAEnD,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;QAEpC,qEAAqE;QACrE,yEAAyE;QACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,qBAAqB,CAAC,CAAC;IACvD,CAAC;CACF"}

package/output/errors/NotImplementedError.d.ts

@@ -0,0 +1,12 @@
+import { AbstractError } from "./AbstractError.js";
+/**
+ * Used when a called method actually hasn't been implemented yet (whoops).
+ */
+export declare class NotImplementedError extends AbstractError {
+    /**
+     * Constructs a new `NotImplementedError`.
+     * @param message The main error message.
+     * @param status The HTTP status code to return.
+     */
+    constructor(message: string, status?: number);
+}

package/output/errors/NotImplementedError.js

@@ -0,0 +1,19 @@
+import { AbstractError } from "./AbstractError.js";
+/**
+ * Used when a called method actually hasn't been implemented yet (whoops).
+ */
+export class NotImplementedError extends AbstractError {
+    /**
+     * Constructs a new `NotImplementedError`.
+     * @param message The main error message.
+     * @param status The HTTP status code to return.
+     */
+    constructor(message, status = 501) {
+        super("ERR_OS_NOT_IMPLEMENTED", message, status);
+        this.name = "NotImplementedError";
+        // Capture a new stacktrace, otherwise it will include our base-class
+        // constructor instead of the code location we're actually interested in.
+        Error.captureStackTrace(this, NotImplementedError);
+    }
+}
+//# sourceMappingURL=NotImplementedError.js.map

package/output/errors/NotImplementedError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NotImplementedError.js","sourceRoot":"","sources":["../../source/errors/NotImplementedError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;GAEG;AACH,MAAM,OAAO,mBAAoB,SAAQ,aAAa;IACpD;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,wBAAwB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAEjD,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;QAElC,qEAAqE;QACrE,yEAAyE;QACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC;IACrD,CAAC;CACF"}

package/output/errors/PermissionViolationError.d.ts

@@ -0,0 +1,13 @@
+import { AbstractError } from "./AbstractError.js";
+/**
+ * An error used when access to a resource was requested, but the required
+ * permissions were not available.
+ */
+export declare class PermissionViolationError extends AbstractError {
+    /**
+     * Constructs a new `PermissionViolationError`.
+     * @param message The main error message.
+     * @param status The HTTP status code to return.
+     */
+    constructor(message: string, status?: number);
+}

package/output/errors/PermissionViolationError.js

@@ -0,0 +1,20 @@
+import { AbstractError } from "./AbstractError.js";
+/**
+ * An error used when access to a resource was requested, but the required
+ * permissions were not available.
+ */
+export class PermissionViolationError extends AbstractError {
+    /**
+     * Constructs a new `PermissionViolationError`.
+     * @param message The main error message.
+     * @param status The HTTP status code to return.
+     */
+    constructor(message, status = 403) {
+        super("ERR_OS_PERMISSION_VIOLATION", message, status);
+        this.name = "PermissionViolationError";
+        // Capture a new stacktrace, otherwise it will include our base-class
+        // constructor instead of the code location we're actually interested in.
+        Error.captureStackTrace(this, PermissionViolationError);
+    }
+}
+//# sourceMappingURL=PermissionViolationError.js.map

package/output/errors/PermissionViolationError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PermissionViolationError.js","sourceRoot":"","sources":["../../source/errors/PermissionViolationError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;GAGG;AACH,MAAM,OAAO,wBAAyB,SAAQ,aAAa;IACzD;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,6BAA6B,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAEtD,IAAI,CAAC,IAAI,GAAG,0BAA0B,CAAC;QAEvC,qEAAqE;QACrE,yEAAyE;QACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,wBAAwB,CAAC,CAAC;IAC1D,CAAC;CACF"}

package/output/errors/ResourceConflictError.d.ts

@@ -0,0 +1,12 @@
+import { AbstractError } from "./AbstractError.js";
+/**
+ * Used when a resource conflict was detected.
+ */
+export declare class ResourceConflictError extends AbstractError {
+    /**
+     * Constructs a new `ResourceConflictError`.
+     * @param message The main error message.
+     * @param status The HTTP status code to return.
+     */
+    constructor(message: string, status?: number);
+}

package/output/errors/ResourceConflictError.js

@@ -0,0 +1,19 @@
+import { AbstractError } from "./AbstractError.js";
+/**
+ * Used when a resource conflict was detected.
+ */
+export class ResourceConflictError extends AbstractError {
+    /**
+     * Constructs a new `ResourceConflictError`.
+     * @param message The main error message.
+     * @param status The HTTP status code to return.
+     */
+    constructor(message, status = 409) {
+        super("ERR_OS_RESOURCE_CONFLICT", message, status);
+        this.name = "ResourceConflictError";
+        // Capture a new stacktrace, otherwise it will include our base-class
+        // constructor instead of the code location we're actually interested in.
+        Error.captureStackTrace(this, ResourceConflictError);
+    }
+}
+//# sourceMappingURL=ResourceConflictError.js.map

package/output/errors/ResourceConflictError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResourceConflictError.js","sourceRoot":"","sources":["../../source/errors/ResourceConflictError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;GAEG;AACH,MAAM,OAAO,qBAAsB,SAAQ,aAAa;IACtD;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,0BAA0B,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAEnD,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;QAEpC,qEAAqE;QACrE,yEAAyE;QACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,qBAAqB,CAAC,CAAC;IACvD,CAAC;CACF"}

package/output/errors/UnknownError.d.ts

@@ -0,0 +1,16 @@
+import { AbstractError } from "./AbstractError.js";
+/**
+ * Used when an unknown, non-`Error`-like object was caught and converted into a
+ * real `Error` instance.
+ * Like when you catch a `throw "boom"`, we will convert the caught `"boom"`
+ * into an `UnknownError`.
+ * To enrich an `Error`-like object that was caught, use the `InternalError`.
+ */
+export declare class UnknownError extends AbstractError {
+    /**
+     * Constructs a new `UnknownError`.
+     * @param message The main error message.
+     * @param status The HTTP status code to return.
+     */
+    constructor(message: string, status?: number);
+}

package/output/errors/UnknownError.js

@@ -0,0 +1,23 @@
+import { AbstractError } from "./AbstractError.js";
+/**
+ * Used when an unknown, non-`Error`-like object was caught and converted into a
+ * real `Error` instance.
+ * Like when you catch a `throw "boom"`, we will convert the caught `"boom"`
+ * into an `UnknownError`.
+ * To enrich an `Error`-like object that was caught, use the `InternalError`.
+ */
+export class UnknownError extends AbstractError {
+    /**
+     * Constructs a new `UnknownError`.
+     * @param message The main error message.
+     * @param status The HTTP status code to return.
+     */
+    constructor(message, status = 500) {
+        super("ERR_OS_UNKNOWN", message, status);
+        this.name = "UnknownError";
+        // Capture a new stacktrace, otherwise it will include our base-class
+        // constructor instead of the code location we're actually interested in.
+        Error.captureStackTrace(this, UnknownError);
+    }
+}
+//# sourceMappingURL=UnknownError.js.map

package/output/errors/UnknownError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UnknownError.js","sourceRoot":"","sources":["../../source/errors/UnknownError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;;;;GAMG;AACH,MAAM,OAAO,YAAa,SAAQ,aAAa;IAC7C;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,gBAAgB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAEzC,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC;QAE3B,qEAAqE;QACrE,yEAAyE;QACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IAC9C,CAAC;CACF"}

package/output/errors/index.d.ts

@@ -0,0 +1,8 @@
+export * from "./AbstractError.js";
+export * from "./InternalError.js";
+export * from "./InvalidArgumentError.js";
+export * from "./InvalidOperationError.js";
+export * from "./NotImplementedError.js";
+export * from "./PermissionViolationError.js";
+export * from "./ResourceConflictError.js";
+export * from "./UnknownError.js";

package/output/errors/index.js

@@ -0,0 +1,9 @@
+export * from "./AbstractError.js";
+export * from "./InternalError.js";
+export * from "./InvalidArgumentError.js";
+export * from "./InvalidOperationError.js";
+export * from "./NotImplementedError.js";
+export * from "./PermissionViolationError.js";
+export * from "./ResourceConflictError.js";
+export * from "./UnknownError.js";
+//# sourceMappingURL=index.js.map

package/output/errors/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../source/errors/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AACzC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC"}

package/output/index.d.ts

@@ -1,3 +1,6 @@
 export * from "./array.js";
+export * from "./error-serializer.js";
+export * from "./errors/index.js";
 export * from "./nil.js";
 export * from "./sleep.js";
+export * from "./string-formatter.js";

package/output/index.js

@@ -1,4 +1,7 @@
 export * from "./array.js";
+export * from "./error-serializer.js";
+export * from "./errors/index.js";
 export * from "./nil.js";
 export * from "./sleep.js";
+export * from "./string-formatter.js";
 //# sourceMappingURL=index.js.map

package/output/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../source/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../source/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,uBAAuB,CAAC"}

package/output/nil.d.ts

@@ -1,30 +1,39 @@
+import { ConstructorOf } from "./core.js";
+/**
+ * When you want to normalize away `null` | `undefined`, or deal
+ * with either type through a consistent interface.
+ */
 export type Nil = null | undefined;
-export type Maybe<T> = T | Nil;
 /**
- * Describes a function that is a constructor for T.
+ * A type that could be either what you want, or `Nil`.
  */
-export type ConstructorOf<T = Record<string, unknown>> = new (...args: any[]) => T;
+export type Maybe<T> = T | Nil;
 /**
  * Check if something is a concrete value of the given type.
  * Can be used as a typeguard.
- *
  * @param nilable The subject that could be nil.
  * @param InstanceType The type to check against.
+ * @returns `true` if the input element matches the given type,
+ * `false` otherwise.
  */
 export declare function is<T>(nilable: Maybe<T>, InstanceType: ConstructorOf<T>): nilable is T;
 /**
- * Check if something is Nil.
+ * Check if something is nil.
  * Can be used as a typeguard.
- *
  * @param subject The subject that could be nil.
+ * @returns `true` if the subject is nil, `false` otherwise.
  */
 export declare function isNil<T>(subject: Maybe<T>): subject is Nil;
+/**
+ * Thrown when an unexpected nil value was encountered.
+ */
 export declare class UnexpectedNilError extends Error {
     constructor(message?: string);
 }
 /**
  * Ensure that the passed subject is not nil; throw otherwise.
- *
  * @param subject A subject that is possible nil.
+ * @returns The subject, if it isn't nil.
+ * @throws {UnexpectedNilError} When the subject is nil.
  */
 export declare function mustExist<T>(subject: Maybe<T>): T;

package/output/nil.js

@@ -1,22 +1,26 @@
 /**
  * Check if something is a concrete value of the given type.
  * Can be used as a typeguard.
- *
  * @param nilable The subject that could be nil.
  * @param InstanceType The type to check against.
+ * @returns `true` if the input element matches the given type,
+ * `false` otherwise.
  */
 export function is(nilable, InstanceType) {
     return !isNil(nilable) && nilable instanceof InstanceType;
 }
 /**
- * Check if something is Nil.
+ * Check if something is nil.
  * Can be used as a typeguard.
- *
  * @param subject The subject that could be nil.
+ * @returns `true` if the subject is nil, `false` otherwise.
  */
 export function isNil(subject) {
     return subject === null || subject === undefined;
 }
+/**
+ * Thrown when an unexpected nil value was encountered.
+ */
 export class UnexpectedNilError extends Error {
     constructor(message = "unexpected nil value") {
         super(message);
@@ -24,8 +28,9 @@ export class UnexpectedNilError extends Error {
 }
 /**
  * Ensure that the passed subject is not nil; throw otherwise.
- *
  * @param subject A subject that is possible nil.
+ * @returns The subject, if it isn't nil.
+ * @throws {UnexpectedNilError} When the subject is nil.
  */
 export function mustExist(subject) {
     if (isNil(subject)) {

package/output/nil.js.map

@@ -1 +1 @@
-{"version":3,"file":"nil.js","sourceRoot":"","sources":["../source/nil.ts"],"names":[],"mappings":"AAQA;;;;;;GAMG;AACH,MAAM,UAAU,EAAE,CAAI,OAAiB,EAAE,YAA8B;IACrE,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,OAAO,YAAY,YAAY,CAAC;AAC5D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,KAAK,CAAI,OAAiB;IACxC,OAAO,OAAO,KAAK,IAAI,IAAI,OAAO,KAAK,SAAS,CAAC;AACnD,CAAC;AAED,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAC3C,YAAY,OAAO,GAAG,sBAAsB;QAC1C,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAI,OAAiB;IAC5C,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE;QAClB,MAAM,IAAI,kBAAkB,EAAE,CAAC;KAChC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}
+{"version":3,"file":"nil.js","sourceRoot":"","sources":["../source/nil.ts"],"names":[],"mappings":"AAaA;;;;;;;GAOG;AACH,MAAM,UAAU,EAAE,CAAI,OAAiB,EAAE,YAA8B;IACrE,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,OAAO,YAAY,YAAY,CAAC;AAC5D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,KAAK,CAAI,OAAiB;IACxC,OAAO,OAAO,KAAK,IAAI,IAAI,OAAO,KAAK,SAAS,CAAC;AACnD,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAC3C,YAAY,OAAO,GAAG,sBAAsB;QAC1C,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CAAI,OAAiB;IAC5C,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE;QAClB,MAAM,IAAI,kBAAkB,EAAE,CAAC;KAChC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/output/sleep.d.ts

@@ -1,6 +1,6 @@
 /**
  * Wait a given period before continuing execution.
- *
  * @param duration How many milliseconds to wait.
+ * @returns Nothing
  */
-export declare function sleep(duration: number): Promise<void>;
+export declare const sleep: (duration: number) => Promise<void>;

package/output/sleep.js

@@ -1,9 +1,9 @@
 /**
  * Wait a given period before continuing execution.
- *
  * @param duration How many milliseconds to wait.
+ * @returns Nothing
  */
-export function sleep(duration) {
+export const sleep = (duration) => {
     return new Promise(resolve => setTimeout(resolve, duration));
-}
+};
 //# sourceMappingURL=sleep.js.map

package/output/sleep.js.map

@@ -1 +1 @@
-{"version":3,"file":"sleep.js","sourceRoot":"","sources":["../source/sleep.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,UAAU,KAAK,CAAC,QAAgB;IACpC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;AAC/D,CAAC"}
+{"version":3,"file":"sleep.js","sourceRoot":"","sources":["../source/sleep.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,QAAgB,EAAiB,EAAE;IACvD,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;AAC/D,CAAC,CAAC"}

package/output/string-formatter.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Formats a given input string with numeric placeholders.
+ * @example
+ * // returns "Hello World"
+ * formatString("{0} {1}", ["Hello", "World"]);
+ * @param string The input string with placeholders.
+ * @param formatArguments An array of strings to place into the placeholders.
+ * @returns The formatted string.
+ */
+export declare const formatString: (string: string, ...formatArguments: Array<string>) => string;
+/**
+ * Formats a given input string with alphanumeric placeholders.
+ * @example
+ * // returns "Hello World"
+ * formatString("{first} {second}", {first:"Hello", second:"World"});
+ * @param string The input string with placeholders.
+ * @param parameters A hash of parameters to place in the placeholders.
+ * @returns The formatted string.
+ */
+export declare const formatStringTemplate: (string: string, parameters: Record<string, string | undefined>) => string;

package/output/string-formatter.js

@@ -0,0 +1,26 @@
+/**
+ * Formats a given input string with numeric placeholders.
+ * @example
+ * // returns "Hello World"
+ * formatString("{0} {1}", ["Hello", "World"]);
+ * @param string The input string with placeholders.
+ * @param formatArguments An array of strings to place into the placeholders.
+ * @returns The formatted string.
+ */
+export const formatString = (string, ...formatArguments) => {
+    return string.replace(/{(\d+)}/g, (match, matchedDigits) => typeof formatArguments[matchedDigits] !== "undefined" ? formatArguments[matchedDigits] : match);
+};
+/**
+ * Formats a given input string with alphanumeric placeholders.
+ * @example
+ * // returns "Hello World"
+ * formatString("{first} {second}", {first:"Hello", second:"World"});
+ * @param string The input string with placeholders.
+ * @param parameters A hash of parameters to place in the placeholders.
+ * @returns The formatted string.
+ */
+export const formatStringTemplate = (string, parameters) => {
+    string = string.replace(/#{[\w.]+}/g, query => parameters[query.slice(2, query.length - 1)] ?? "<missing parameter>");
+    return string;
+};
+//# sourceMappingURL=string-formatter.js.map

package/output/string-formatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"string-formatter.js","sourceRoot":"","sources":["../source/string-formatter.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,MAAc,EAAE,GAAG,eAA8B,EAAU,EAAE;IACxF,OAAO,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,aAAqB,EAAU,EAAE,CACzE,OAAO,eAAe,CAAC,aAAa,CAAC,KAAK,WAAW,CAAC,CAAC,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,KAAK,CAC/F,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,MAAc,EACd,UAA8C,EACtC,EAAE;IACV,MAAM,GAAG,MAAM,CAAC,OAAO,CACrB,YAAY,EACZ,KAAK,CAAC,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,qBAAqB,CAC/E,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "@oliversalzburg/js-utils",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "license": "MIT",
   "author": "Oliver Salzburg <oliver.salzburg@gmail.com>",
   "type": "module",
@@ -17,7 +17,8 @@
     "build": "yarn run build:tsc",
     "build:esbuild": "node build.js",
     "build:tsc": "tsc",
-    "lint:eslint": "eslint source",
+    "lint": "yarn run lint:eslint && yarn run lint:tsc",
+    "lint:eslint": "eslint source ./*js",
     "lint:tsc": "tsc --noEmit",
     "npm:publish": "npm publish",
     "npm:publish:major": "npm version major && npm publish",
@@ -33,6 +34,7 @@
     "@typescript-eslint/parser": "6.9.0",
     "esbuild": "0.19.5",
     "eslint": "8.52.0",
+    "eslint-plugin-jsdoc": "46.8.2",
     "lint-staged": "15.0.2",
     "prettier": "3.0.3",
     "prettier-package-json": "2.8.0",