complete-common 1.0.0 → 1.0.1

package/dist/functions/string.d.mts

@@ -0,0 +1,122 @@
+/**
+ * Helper functions that have to do with strings.
+ *
+ * @module
+ */
+/** Helper function to capitalize the first letter of a string. */
+export declare function capitalizeFirstLetter(string: string): string;
+/**
+ * Helper function to replace all of the ampersands, less than signs, greater than signs, double
+ * quotes, and single quotes in a string with the escaped counterparts. For example, "<" will be
+ * replaced with "&lt;".
+ */
+export declare function escapeHTMLCharacters(string: string): string;
+/**
+ * Helper function to get the number of consecutive diacritics in a string.
+ *
+ * This is useful for sanitization purposes, since many subsequent diacritics can be a sign of a
+ * malicious string.
+ */
+export declare function getNumConsecutiveDiacritics(string: string): number;
+/** Helper function to check if a string has one or more diacritics in it. */
+export declare function hasDiacritic(string: string): boolean;
+/**
+ * Helper function to check if a string has one or more emoji in it.
+ *
+ * Under the hood, this uses the same regex check as the Zod library.
+ */
+export declare function hasEmoji(string: string): boolean;
+/** From: https://stackoverflow.com/questions/1731190/check-if-a-string-has-white-space */
+export declare function hasWhitespace(string: string): boolean;
+/**
+ * From:
+ * https://stackoverflow.com/questions/8334606/check-if-first-letter-of-word-is-a-capital-letter
+ */
+export declare function isFirstLetterCapitalized(string: string): boolean;
+/** Kebab case is the naming style of using all lowercase and hyphens, like "foo-bar". */
+export declare function isKebabCase(string: string): boolean;
+/**
+ * Helper function to check if a given string is a valid Semantic Version.
+ *
+ * @see https://semver.org/
+ */
+export declare function isSemanticVersion(versionString: string): boolean;
+/** Helper function to convert a string from kebab-case to camel-case. */
+export declare function kebabCaseToCamelCase(string: string): string;
+/**
+ * Helper function to normalize a string. Specifically, this performs the following steps:
+ *
+ * - Removes any non-printable characters, if any.
+ * - Normalizes all newlines to "\n".
+ * - Normalizes all spaces to " ".
+ * - Removes leading/trailing whitespace.
+ *
+ * @see
+ * https://stackoverflow.com/questions/11598786/how-to-replace-non-printable-unicode-characters-javascript
+ */
+export declare function normalizeString(string: string): string;
+/**
+ * Helper function to parse a Semantic Versioning string into its individual constituents. Returns
+ * undefined if the submitted string was not a proper Semantic Version.
+ *
+ * @see https://semver.org/
+ */
+export declare function parseSemanticVersion(versionString: string): {
+    /** The first number inside of the semantic version. */
+    majorVersion: number;
+    /** The second number inside of the semantic version. */
+    minorVersion: number;
+    /** The third number inside of the semantic version. */
+    patchVersion: number;
+} | undefined;
+/**
+ * Helper function to remove lines from a multi-line string. This function looks for a "-start" and
+ * a "-end" suffix after the marker. Lines with markets will be completely removed from the output.
+ *
+ * For example, by using a marker of "@foo":
+ *
+ * ```text
+ * line1
+ * # @foo-start
+ * line2
+ * line3
+ * # @foo-end
+ * line4
+ * ```
+ *
+ * Would return:
+ *
+ * ```text
+ * line1
+ * line4
+ * ```
+ */
+export declare function removeLinesBetweenMarkers(string: string, marker: string): string;
+/** Helper function to remove lines from a multi-line string matching a certain other string. */
+export declare function removeLinesMatching(string: string, match: string): string;
+/**
+ * Helper function to remove all non-printable characters from a string.
+ *
+ * @see
+ * https://stackoverflow.com/questions/11598786/how-to-replace-non-printable-unicode-characters-javascript
+ */
+export declare function removeNonPrintableCharacters(string: string): string;
+/** Helper function to remove all whitespace characters from a string. */
+export declare function removeWhitespace(string: string): string;
+/**
+ * Helper function to trim a prefix from a string, if it exists. Returns the trimmed string.
+ *
+ * @param string The string to trim.
+ * @param prefix The prefix to trim.
+ * @param trimAll Whether to remove multiple instances of the prefix, if they exist. If this is set
+ *                to true, the prefix must only be a single character.
+ */
+export declare function trimPrefix(string: string, prefix: string, trimAll?: boolean): string;
+/** Helper function to trim a suffix from a string, if it exists. Returns the trimmed string. */
+export declare function trimSuffix(string: string, prefix: string): string;
+/**
+ * Helper function to truncate a string to a maximum length. If the length of the string is less
+ * than or equal to the provided maximum length, the string will be returned unmodified.
+ */
+export declare function truncateString(string: string, maxLength: number): string;
+//# sourceMappingURL=string.d.ts.map

package/dist/functions/string.d.ts

@@ -0,0 +1,122 @@
+/**
+ * Helper functions that have to do with strings.
+ *
+ * @module
+ */
+/** Helper function to capitalize the first letter of a string. */
+export declare function capitalizeFirstLetter(string: string): string;
+/**
+ * Helper function to replace all of the ampersands, less than signs, greater than signs, double
+ * quotes, and single quotes in a string with the escaped counterparts. For example, "<" will be
+ * replaced with "&lt;".
+ */
+export declare function escapeHTMLCharacters(string: string): string;
+/**
+ * Helper function to get the number of consecutive diacritics in a string.
+ *
+ * This is useful for sanitization purposes, since many subsequent diacritics can be a sign of a
+ * malicious string.
+ */
+export declare function getNumConsecutiveDiacritics(string: string): number;
+/** Helper function to check if a string has one or more diacritics in it. */
+export declare function hasDiacritic(string: string): boolean;
+/**
+ * Helper function to check if a string has one or more emoji in it.
+ *
+ * Under the hood, this uses the same regex check as the Zod library.
+ */
+export declare function hasEmoji(string: string): boolean;
+/** From: https://stackoverflow.com/questions/1731190/check-if-a-string-has-white-space */
+export declare function hasWhitespace(string: string): boolean;
+/**
+ * From:
+ * https://stackoverflow.com/questions/8334606/check-if-first-letter-of-word-is-a-capital-letter
+ */
+export declare function isFirstLetterCapitalized(string: string): boolean;
+/** Kebab case is the naming style of using all lowercase and hyphens, like "foo-bar". */
+export declare function isKebabCase(string: string): boolean;
+/**
+ * Helper function to check if a given string is a valid Semantic Version.
+ *
+ * @see https://semver.org/
+ */
+export declare function isSemanticVersion(versionString: string): boolean;
+/** Helper function to convert a string from kebab-case to camel-case. */
+export declare function kebabCaseToCamelCase(string: string): string;
+/**
+ * Helper function to normalize a string. Specifically, this performs the following steps:
+ *
+ * - Removes any non-printable characters, if any.
+ * - Normalizes all newlines to "\n".
+ * - Normalizes all spaces to " ".
+ * - Removes leading/trailing whitespace.
+ *
+ * @see
+ * https://stackoverflow.com/questions/11598786/how-to-replace-non-printable-unicode-characters-javascript
+ */
+export declare function normalizeString(string: string): string;
+/**
+ * Helper function to parse a Semantic Versioning string into its individual constituents. Returns
+ * undefined if the submitted string was not a proper Semantic Version.
+ *
+ * @see https://semver.org/
+ */
+export declare function parseSemanticVersion(versionString: string): {
+    /** The first number inside of the semantic version. */
+    majorVersion: number;
+    /** The second number inside of the semantic version. */
+    minorVersion: number;
+    /** The third number inside of the semantic version. */
+    patchVersion: number;
+} | undefined;
+/**
+ * Helper function to remove lines from a multi-line string. This function looks for a "-start" and
+ * a "-end" suffix after the marker. Lines with markets will be completely removed from the output.
+ *
+ * For example, by using a marker of "@foo":
+ *
+ * ```text
+ * line1
+ * # @foo-start
+ * line2
+ * line3
+ * # @foo-end
+ * line4
+ * ```
+ *
+ * Would return:
+ *
+ * ```text
+ * line1
+ * line4
+ * ```
+ */
+export declare function removeLinesBetweenMarkers(string: string, marker: string): string;
+/** Helper function to remove lines from a multi-line string matching a certain other string. */
+export declare function removeLinesMatching(string: string, match: string): string;
+/**
+ * Helper function to remove all non-printable characters from a string.
+ *
+ * @see
+ * https://stackoverflow.com/questions/11598786/how-to-replace-non-printable-unicode-characters-javascript
+ */
+export declare function removeNonPrintableCharacters(string: string): string;
+/** Helper function to remove all whitespace characters from a string. */
+export declare function removeWhitespace(string: string): string;
+/**
+ * Helper function to trim a prefix from a string, if it exists. Returns the trimmed string.
+ *
+ * @param string The string to trim.
+ * @param prefix The prefix to trim.
+ * @param trimAll Whether to remove multiple instances of the prefix, if they exist. If this is set
+ *                to true, the prefix must only be a single character.
+ */
+export declare function trimPrefix(string: string, prefix: string, trimAll?: boolean): string;
+/** Helper function to trim a suffix from a string, if it exists. Returns the trimmed string. */
+export declare function trimSuffix(string: string, prefix: string): string;
+/**
+ * Helper function to truncate a string to a maximum length. If the length of the string is less
+ * than or equal to the provided maximum length, the string will be returned unmodified.
+ */
+export declare function truncateString(string: string, maxLength: number): string;
+//# sourceMappingURL=string.d.ts.map

package/dist/functions/string.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../src/functions/string.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAqBH,kEAAkE;AAClE,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAU5D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAO3D;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAqBlE;AAED,6EAA6E;AAC7E,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAOpD;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEhD;AAED,0FAA0F;AAC1F,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAErD;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEhE;AAED,yFAAyF;AACzF,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAGhE;AAED,yEAAyE;AACzE,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAO3D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAiBtD;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,aAAa,EAAE,MAAM,GACtD;IACE,uDAAuD;IACvD,YAAY,EAAE,MAAM,CAAC;IAErB,wDAAwD;IACxD,YAAY,EAAE,MAAM,CAAC;IAErB,uDAAuD;IACvD,YAAY,EAAE,MAAM,CAAC;CACtB,GACD,SAAS,CAwBZ;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,GACb,MAAM,CAuBR;AAED,gGAAgG;AAChG,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAIzE;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEnE;AAED,yEAAyE;AACzE,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEvD;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CACxB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,UAAQ,GACd,MAAM,CAWR;AAED,gGAAgG;AAChG,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAOjE;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAMxE"}

package/dist/functions/string.test.d.cts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=string.test.d.ts.map

package/dist/functions/string.test.d.mts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=string.test.d.ts.map

package/dist/functions/string.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=string.test.d.ts.map

package/dist/functions/string.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"string.test.d.ts","sourceRoot":"","sources":["../../src/functions/string.test.ts"],"names":[],"mappings":""}

package/dist/functions/tuple.d.cts

@@ -0,0 +1,27 @@
+/**
+ * Helper functions that have to do with TypeScript tuples.
+ *
+ * @module
+ */
+import type { Tuple } from "../types/Tuple.js";
+type TupleKey<T extends readonly unknown[]> = {
+    [L in T["length"]]: Exclude<Partial<Tuple<unknown, L>>["length"], L>;
+}[T["length"]];
+type TupleValue<T extends readonly unknown[]> = T[0];
+type TupleEntry<T extends readonly unknown[]> = [TupleKey<T>, TupleValue<T>];
+/**
+ * Helper function to get the entries (i.e. indexes and values) of a tuple in a type-safe way.
+ *
+ * This is useful because the vanilla `Array.entries` method will always have the keys be of type
+ * `number`.
+ */
+export declare function tupleEntries<T extends readonly unknown[]>(tuple: T): Generator<TupleEntry<T>>;
+/**
+ * Helper function to get the keys (i.e. indexes) of a tuple in a type-safe way.
+ *
+ * This is useful because the vanilla `Array.keys` method will always have the keys be of type
+ * `number`.
+ */
+export declare function tupleKeys<T extends readonly unknown[]>(tuple: T): Generator<TupleKey<T>>;
+export {};
+//# sourceMappingURL=tuple.d.ts.map

package/dist/functions/tuple.d.mts

@@ -0,0 +1,27 @@
+/**
+ * Helper functions that have to do with TypeScript tuples.
+ *
+ * @module
+ */
+import type { Tuple } from "../types/Tuple.js";
+type TupleKey<T extends readonly unknown[]> = {
+    [L in T["length"]]: Exclude<Partial<Tuple<unknown, L>>["length"], L>;
+}[T["length"]];
+type TupleValue<T extends readonly unknown[]> = T[0];
+type TupleEntry<T extends readonly unknown[]> = [TupleKey<T>, TupleValue<T>];
+/**
+ * Helper function to get the entries (i.e. indexes and values) of a tuple in a type-safe way.
+ *
+ * This is useful because the vanilla `Array.entries` method will always have the keys be of type
+ * `number`.
+ */
+export declare function tupleEntries<T extends readonly unknown[]>(tuple: T): Generator<TupleEntry<T>>;
+/**
+ * Helper function to get the keys (i.e. indexes) of a tuple in a type-safe way.
+ *
+ * This is useful because the vanilla `Array.keys` method will always have the keys be of type
+ * `number`.
+ */
+export declare function tupleKeys<T extends readonly unknown[]>(tuple: T): Generator<TupleKey<T>>;
+export {};
+//# sourceMappingURL=tuple.d.ts.map

package/dist/functions/tuple.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Helper functions that have to do with TypeScript tuples.
+ *
+ * @module
+ */
+import type { Tuple } from "../types/Tuple.js";
+type TupleKey<T extends readonly unknown[]> = {
+    [L in T["length"]]: Exclude<Partial<Tuple<unknown, L>>["length"], L>;
+}[T["length"]];
+type TupleValue<T extends readonly unknown[]> = T[0];
+type TupleEntry<T extends readonly unknown[]> = [TupleKey<T>, TupleValue<T>];
+/**
+ * Helper function to get the entries (i.e. indexes and values) of a tuple in a type-safe way.
+ *
+ * This is useful because the vanilla `Array.entries` method will always have the keys be of type
+ * `number`.
+ */
+export declare function tupleEntries<T extends readonly unknown[]>(tuple: T): Generator<TupleEntry<T>>;
+/**
+ * Helper function to get the keys (i.e. indexes) of a tuple in a type-safe way.
+ *
+ * This is useful because the vanilla `Array.keys` method will always have the keys be of type
+ * `number`.
+ */
+export declare function tupleKeys<T extends readonly unknown[]>(tuple: T): Generator<TupleKey<T>>;
+export {};
+//# sourceMappingURL=tuple.d.ts.map

package/dist/functions/tuple.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tuple.d.ts","sourceRoot":"","sources":["../../src/functions/tuple.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAE/C,KAAK,QAAQ,CAAC,CAAC,SAAS,SAAS,OAAO,EAAE,IAAI;KAC3C,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;CACrE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;AACf,KAAK,UAAU,CAAC,CAAC,SAAS,SAAS,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AACrD,KAAK,UAAU,CAAC,CAAC,SAAS,SAAS,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AAE7E;;;;;GAKG;AACH,wBAAiB,YAAY,CAAC,CAAC,SAAS,SAAS,OAAO,EAAE,EACxD,KAAK,EAAE,CAAC,GACP,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAE1B;AAED;;;;;GAKG;AACH,wBAAiB,SAAS,CAAC,CAAC,SAAS,SAAS,OAAO,EAAE,EACrD,KAAK,EAAE,CAAC,GACP,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAExB"}

package/dist/functions/types.d.cts

@@ -0,0 +1,13 @@
+/**
+ * Identity functions that help with narrowing.
+ *
+ * @module
+ */
+/**
+ * Helper function to narrow an unknown value to an object (i.e. a TypeScript record).
+ *
+ * Under the hood, this checks for `typeof variable === "object"`, `variable !== null`, and
+ * `!Array.isArray(variable)`.
+ */
+export declare function isObject(variable: unknown): variable is Record<string, unknown>;
+//# sourceMappingURL=types.d.ts.map

package/dist/functions/types.d.mts

@@ -0,0 +1,13 @@
+/**
+ * Identity functions that help with narrowing.
+ *
+ * @module
+ */
+/**
+ * Helper function to narrow an unknown value to an object (i.e. a TypeScript record).
+ *
+ * Under the hood, this checks for `typeof variable === "object"`, `variable !== null`, and
+ * `!Array.isArray(variable)`.
+ */
+export declare function isObject(variable: unknown): variable is Record<string, unknown>;
+//# sourceMappingURL=types.d.ts.map

package/dist/functions/types.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Identity functions that help with narrowing.
+ *
+ * @module
+ */
+/**
+ * Helper function to narrow an unknown value to an object (i.e. a TypeScript record).
+ *
+ * Under the hood, this checks for `typeof variable === "object"`, `variable !== null`, and
+ * `!Array.isArray(variable)`.
+ */
+export declare function isObject(variable: unknown): variable is Record<string, unknown>;
+//# sourceMappingURL=types.d.ts.map

package/dist/functions/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/functions/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;GAKG;AACH,wBAAgB,QAAQ,CACtB,QAAQ,EAAE,OAAO,GAChB,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAMrC"}

package/dist/functions/utils.d.cts

@@ -0,0 +1,131 @@
+/**
+ * Helper functions that do not belong to any category in particular.
+ *
+ * @module
+ */
+/**
+ * Helper function to get an iterator of integers with the specified range, inclusive on the lower
+ * end and exclusive on the high end. (The "e" in the function name stands for exclusive.) Thus,
+ * this function works in the same way as the built-in `range` function from Python.
+ *
+ * If the end is lower than the start, then an empty range will be returned.
+ *
+ * For example:
+ *
+ * - `eRange(2)` returns `[0, 1]`.
+ * - `eRange(3)` returns `[0, 1, 2]`.
+ * - `eRange(-3)` returns `[0, -1, -2]`.
+ * - `eRange(1, 3)` returns `[1, 2]`.
+ * - `eRange(2, 5)` returns `[2, 3, 4]`.
+ * - `eRange(5, 2)` returns `[]`.
+ * - `eRange(3, 3)` returns `[]`.
+ *
+ * If you want an array instead of an iterator, use the spread operator like this:
+ *
+ * ```ts
+ * const myArray = [...eRange(1, 3)];
+ * ```
+ *
+ * @param start The integer to start at.
+ * @param end Optional. The integer to end at. If not specified, then the start will be 0 and the
+ *            first argument will be the end.
+ * @param increment Optional. The increment to use. Default is 1.
+ */
+export declare function eRange(start: number, end?: number, increment?: number): Generator<number>;
+/**
+ * Helper function to get an array of integers with the specified range, inclusive on both ends.
+ * (The "i" in the function name stands for inclusive.)
+ *
+ * If the end is lower than the start, then an empty range will be returned.
+ *
+ * For example:
+ *
+ * - `iRange(2)` returns `[0, 1, 2]`.
+ * - `iRange(3)` returns `[0, 1, 2, 3]`.
+ * - `iRange(-3)` returns `[0, -1, -2, -3]`.
+ * - `iRange(1, 3)` returns `[1, 2, 3]`.
+ * - `iRange(2, 5)` returns `[2, 3, 4, 5]`.
+ * - `iRange(5, 2)` returns `[]`.
+ * - `iRange(3, 3)` returns `[3]`.
+ *
+ * If you want an array instead of an iterator, use the spread operator like this:
+ *
+ * ```ts
+ * const myArray = [...iRange(1, 3)];
+ * ```
+ *
+ * @param start The integer to start at.
+ * @param end Optional. The integer to end at. If not specified, then the start will be 0 and the
+ *            first argument will be the end.
+ * @param increment Optional. The increment to use. Default is 1.
+ */
+export declare function iRange(start: number, end?: number, increment?: number): Generator<number>;
+/** From: https://stackoverflow.com/questions/61526746 */
+export declare function isKeyOf<T extends object>(key: PropertyKey, target: T): key is keyof T;
+/**
+ * Helper function to perform a no-op. This can be useful in order to make a trailing return valid
+ * in functions that use the early return pattern.
+ */
+export declare function noop(): void;
+/**
+ * This is a more reliable version of `Number.parseFloat`:
+ *
+ * - `undefined` is returned instead of `Number.NaN`, which is helpful in conjunction with
+ *   TypeScript type narrowing patterns.
+ * - Strings that are a mixture of numbers and letters will result in undefined instead of the part
+ *   of the string that is the number. (e.g. "1a" --> undefined instead of "1a" --> 1)
+ * - Non-strings will result in undefined instead of being coerced to a number.
+ *
+ * @param string A string to convert to an integer.
+ */
+export declare function parseFloatSafe(string: string): number | undefined;
+/**
+ * This is a more reliable version of `Number.parseInt`:
+ *
+ * - `undefined` is returned instead of `Number.NaN`, which is helpful in conjunction with
+ *   TypeScript type narrowing patterns.
+ * - Strings that are a mixture of numbers and letters will result in undefined instead of the part
+ *   of the string that is the number. (e.g. "1a" --> undefined instead of "1a" --> 1)
+ * - Non-strings will result in undefined instead of being coerced to a number.
+ *
+ * If you have to use a radix other than 10, use the vanilla `Number.parseInt` function instead,
+ * because this function ensures that the string contains no letters.
+ */
+export declare function parseIntSafe(string: string): number | undefined;
+/**
+ * Helper function to repeat code N times. This is faster to type and cleaner than using a for loop.
+ *
+ * For example:
+ *
+ * ```ts
+ * repeat(10, () => {
+ *   foo();
+ * });
+ * ```
+ *
+ * The repeated function is passed the index of the iteration, if needed:
+ *
+ * ```ts
+ * repeat(3, (i) => {
+ *   console.log(i); // Prints "0", "1", "2"
+ * });
+ * ```
+ */
+export declare function repeat(num: number, func: (i: number) => void): void;
+/**
+ * Helper function to signify that the enclosing code block is not yet complete. Using this function
+ * is similar to writing a "TODO" comment, but it has the benefit of preventing ESLint errors due to
+ * unused variables or early returns.
+ *
+ * When you see this function, it simply means that the programmer intends to add in more code to
+ * this spot later.
+ *
+ * This function is variadic, meaning that you can pass as many arguments as you want. (This is
+ * useful as a means to prevent unused variables.)
+ *
+ * This function does not actually do anything. (It is an "empty" function.)
+ *
+ * @allowEmptyVariadic
+ */
+export declare function todo(...args: readonly unknown[]): void;
+//# sourceMappingURL=utils.d.ts.map

package/dist/functions/utils.d.mts

@@ -0,0 +1,131 @@
+/**
+ * Helper functions that do not belong to any category in particular.
+ *
+ * @module
+ */
+/**
+ * Helper function to get an iterator of integers with the specified range, inclusive on the lower
+ * end and exclusive on the high end. (The "e" in the function name stands for exclusive.) Thus,
+ * this function works in the same way as the built-in `range` function from Python.
+ *
+ * If the end is lower than the start, then an empty range will be returned.
+ *
+ * For example:
+ *
+ * - `eRange(2)` returns `[0, 1]`.
+ * - `eRange(3)` returns `[0, 1, 2]`.
+ * - `eRange(-3)` returns `[0, -1, -2]`.
+ * - `eRange(1, 3)` returns `[1, 2]`.
+ * - `eRange(2, 5)` returns `[2, 3, 4]`.
+ * - `eRange(5, 2)` returns `[]`.
+ * - `eRange(3, 3)` returns `[]`.
+ *
+ * If you want an array instead of an iterator, use the spread operator like this:
+ *
+ * ```ts
+ * const myArray = [...eRange(1, 3)];
+ * ```
+ *
+ * @param start The integer to start at.
+ * @param end Optional. The integer to end at. If not specified, then the start will be 0 and the
+ *            first argument will be the end.
+ * @param increment Optional. The increment to use. Default is 1.
+ */
+export declare function eRange(start: number, end?: number, increment?: number): Generator<number>;
+/**
+ * Helper function to get an array of integers with the specified range, inclusive on both ends.
+ * (The "i" in the function name stands for inclusive.)
+ *
+ * If the end is lower than the start, then an empty range will be returned.
+ *
+ * For example:
+ *
+ * - `iRange(2)` returns `[0, 1, 2]`.
+ * - `iRange(3)` returns `[0, 1, 2, 3]`.
+ * - `iRange(-3)` returns `[0, -1, -2, -3]`.
+ * - `iRange(1, 3)` returns `[1, 2, 3]`.
+ * - `iRange(2, 5)` returns `[2, 3, 4, 5]`.
+ * - `iRange(5, 2)` returns `[]`.
+ * - `iRange(3, 3)` returns `[3]`.
+ *
+ * If you want an array instead of an iterator, use the spread operator like this:
+ *
+ * ```ts
+ * const myArray = [...iRange(1, 3)];
+ * ```
+ *
+ * @param start The integer to start at.
+ * @param end Optional. The integer to end at. If not specified, then the start will be 0 and the
+ *            first argument will be the end.
+ * @param increment Optional. The increment to use. Default is 1.
+ */
+export declare function iRange(start: number, end?: number, increment?: number): Generator<number>;
+/** From: https://stackoverflow.com/questions/61526746 */
+export declare function isKeyOf<T extends object>(key: PropertyKey, target: T): key is keyof T;
+/**
+ * Helper function to perform a no-op. This can be useful in order to make a trailing return valid
+ * in functions that use the early return pattern.
+ */
+export declare function noop(): void;
+/**
+ * This is a more reliable version of `Number.parseFloat`:
+ *
+ * - `undefined` is returned instead of `Number.NaN`, which is helpful in conjunction with
+ *   TypeScript type narrowing patterns.
+ * - Strings that are a mixture of numbers and letters will result in undefined instead of the part
+ *   of the string that is the number. (e.g. "1a" --> undefined instead of "1a" --> 1)
+ * - Non-strings will result in undefined instead of being coerced to a number.
+ *
+ * @param string A string to convert to an integer.
+ */
+export declare function parseFloatSafe(string: string): number | undefined;
+/**
+ * This is a more reliable version of `Number.parseInt`:
+ *
+ * - `undefined` is returned instead of `Number.NaN`, which is helpful in conjunction with
+ *   TypeScript type narrowing patterns.
+ * - Strings that are a mixture of numbers and letters will result in undefined instead of the part
+ *   of the string that is the number. (e.g. "1a" --> undefined instead of "1a" --> 1)
+ * - Non-strings will result in undefined instead of being coerced to a number.
+ *
+ * If you have to use a radix other than 10, use the vanilla `Number.parseInt` function instead,
+ * because this function ensures that the string contains no letters.
+ */
+export declare function parseIntSafe(string: string): number | undefined;
+/**
+ * Helper function to repeat code N times. This is faster to type and cleaner than using a for loop.
+ *
+ * For example:
+ *
+ * ```ts
+ * repeat(10, () => {
+ *   foo();
+ * });
+ * ```
+ *
+ * The repeated function is passed the index of the iteration, if needed:
+ *
+ * ```ts
+ * repeat(3, (i) => {
+ *   console.log(i); // Prints "0", "1", "2"
+ * });
+ * ```
+ */
+export declare function repeat(num: number, func: (i: number) => void): void;
+/**
+ * Helper function to signify that the enclosing code block is not yet complete. Using this function
+ * is similar to writing a "TODO" comment, but it has the benefit of preventing ESLint errors due to
+ * unused variables or early returns.
+ *
+ * When you see this function, it simply means that the programmer intends to add in more code to
+ * this spot later.
+ *
+ * This function is variadic, meaning that you can pass as many arguments as you want. (This is
+ * useful as a means to prevent unused variables.)
+ *
+ * This function does not actually do anything. (It is an "empty" function.)
+ *
+ * @allowEmptyVariadic
+ */
+export declare function todo(...args: readonly unknown[]): void;
+//# sourceMappingURL=utils.d.ts.map