complete-common 1.0.0 → 1.0.1

package/dist/functions/map.d.mts

@@ -0,0 +1,52 @@
+/**
+ * Helper functions that have to do with
+ * [maps](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map).
+ *
+ * @module
+ */
+/**
+ * Helper function to get the values in a `Map` that match an arbitrary condition. Similar to the
+ * `Array.map` method, but works for maps.
+ *
+ * This is efficient such that it avoids converting the map values into an array.
+ *
+ * If you want to perform a filter and a map at the same time on an array, use the `filterMap`
+ * helper function instead.
+ */
+export declare function mapFilter<K, V>(map: ReadonlyMap<K, V>, predicate: (value: V) => boolean): V[];
+/**
+ * Helper function to find a value in a `Map`. Similar to the `Array.find` method, but works for
+ * maps.
+ *
+ * This is efficient such that it avoids converting the map values into an array.
+ */
+export declare function mapFind<K, V>(map: ReadonlyMap<K, V>, predicate: (value: V) => boolean): V | undefined;
+/**
+ * Helper function to convert an object to a map.
+ *
+ * This is useful when you need to construct a type safe object with the `satisfies` operator, but
+ * then later on you need to query it in a way where you expect the return value to be T or
+ * undefined. In this situation, by converting the object to a map, you can avoid unsafe type
+ * assertions.
+ *
+ * Note that the map values will be inserted in a random order, due to how `pairs` works under the
+ * hood.
+ *
+ * Also see the `objectToReadonlyMap` function.
+ */
+export declare function objectToMap<K extends string | number | symbol, V>(object: Record<K, V>): Map<K, V>;
+/**
+ * Helper function to convert an object to a read-only map.
+ *
+ * This is useful when you need to construct a type safe object with the `satisfies` operator, but
+ * then later on you need to query it in a way where you expect the return value to be T or
+ * undefined. In this situation, by converting the object to a map, you can avoid unsafe type
+ * assertions.
+ *
+ * Note that the map values will be inserted in a random order, due to how `pairs` works under the
+ * hood.
+ *
+ * Also see the `objectToMap` function.
+ */
+export declare function objectToReadonlyMap<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlyMap<K, V>;
+//# sourceMappingURL=map.d.ts.map

package/dist/functions/map.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Helper functions that have to do with
+ * [maps](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map).
+ *
+ * @module
+ */
+/**
+ * Helper function to get the values in a `Map` that match an arbitrary condition. Similar to the
+ * `Array.map` method, but works for maps.
+ *
+ * This is efficient such that it avoids converting the map values into an array.
+ *
+ * If you want to perform a filter and a map at the same time on an array, use the `filterMap`
+ * helper function instead.
+ */
+export declare function mapFilter<K, V>(map: ReadonlyMap<K, V>, predicate: (value: V) => boolean): V[];
+/**
+ * Helper function to find a value in a `Map`. Similar to the `Array.find` method, but works for
+ * maps.
+ *
+ * This is efficient such that it avoids converting the map values into an array.
+ */
+export declare function mapFind<K, V>(map: ReadonlyMap<K, V>, predicate: (value: V) => boolean): V | undefined;
+/**
+ * Helper function to convert an object to a map.
+ *
+ * This is useful when you need to construct a type safe object with the `satisfies` operator, but
+ * then later on you need to query it in a way where you expect the return value to be T or
+ * undefined. In this situation, by converting the object to a map, you can avoid unsafe type
+ * assertions.
+ *
+ * Note that the map values will be inserted in a random order, due to how `pairs` works under the
+ * hood.
+ *
+ * Also see the `objectToReadonlyMap` function.
+ */
+export declare function objectToMap<K extends string | number | symbol, V>(object: Record<K, V>): Map<K, V>;
+/**
+ * Helper function to convert an object to a read-only map.
+ *
+ * This is useful when you need to construct a type safe object with the `satisfies` operator, but
+ * then later on you need to query it in a way where you expect the return value to be T or
+ * undefined. In this situation, by converting the object to a map, you can avoid unsafe type
+ * assertions.
+ *
+ * Note that the map values will be inserted in a random order, due to how `pairs` works under the
+ * hood.
+ *
+ * Also see the `objectToMap` function.
+ */
+export declare function objectToReadonlyMap<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlyMap<K, V>;
+//# sourceMappingURL=map.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"map.d.ts","sourceRoot":"","sources":["../../src/functions/map.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;;;;GAQG;AAEH,wBAAgB,SAAS,CAAC,CAAC,EAAE,CAAC,EAC5B,GAAG,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,EACtB,SAAS,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,GAC/B,CAAC,EAAE,CAWL;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,CAAC,EAC1B,GAAG,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,EACtB,SAAS,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,GAC/B,CAAC,GAAG,SAAS,CASf;AAED;;;;;;;;;;;;GAYG;AAEH,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,EAC/D,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GACnB,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAQX;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,EACvE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GACnB,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAEnB"}

package/dist/functions/math.d.cts

@@ -0,0 +1,13 @@
+/**
+ * Helper functions that have to do with math.
+ *
+ * @module
+ */
+/**
+ * Helper function to normalize a number, ensuring that it is within a certain range.
+ *
+ * - If `num` is less than `min`, then it will be clamped to `min`.
+ * - If `num` is greater than `max`, then it will be clamped to `max`.
+ */
+export declare function clamp(num: number, min: number, max: number): number;
+//# sourceMappingURL=math.d.ts.map

package/dist/functions/math.d.mts

@@ -0,0 +1,13 @@
+/**
+ * Helper functions that have to do with math.
+ *
+ * @module
+ */
+/**
+ * Helper function to normalize a number, ensuring that it is within a certain range.
+ *
+ * - If `num` is less than `min`, then it will be clamped to `min`.
+ * - If `num` is greater than `max`, then it will be clamped to `max`.
+ */
+export declare function clamp(num: number, min: number, max: number): number;
+//# sourceMappingURL=math.d.ts.map

package/dist/functions/math.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Helper functions that have to do with math.
+ *
+ * @module
+ */
+/**
+ * Helper function to normalize a number, ensuring that it is within a certain range.
+ *
+ * - If `num` is less than `min`, then it will be clamped to `min`.
+ * - If `num` is greater than `max`, then it will be clamped to `max`.
+ */
+export declare function clamp(num: number, min: number, max: number): number;
+//# sourceMappingURL=math.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"math.d.ts","sourceRoot":"","sources":["../../src/functions/math.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAEnE"}

package/dist/functions/object.d.cts

@@ -0,0 +1,14 @@
+/**
+ * Helper functions that have to do with objects.
+ *
+ * @module
+ */
+import type { ReadonlyRecord } from "../types/ReadonlyRecord.js";
+/**
+ * Helper function to get the values in an object that match an arbitrary condition. Similar to the
+ * `Array.map` method, but works for objects.
+ *
+ * This is efficient such that it avoids converting the object values into an array.
+ */
+export declare function objectFilter<K extends string | number | symbol, V>(object: ReadonlyRecord<K, V>, predicate: (value: V) => boolean): V[];
+//# sourceMappingURL=object.d.ts.map

package/dist/functions/object.d.mts

@@ -0,0 +1,14 @@
+/**
+ * Helper functions that have to do with objects.
+ *
+ * @module
+ */
+import type { ReadonlyRecord } from "../types/ReadonlyRecord.js";
+/**
+ * Helper function to get the values in an object that match an arbitrary condition. Similar to the
+ * `Array.map` method, but works for objects.
+ *
+ * This is efficient such that it avoids converting the object values into an array.
+ */
+export declare function objectFilter<K extends string | number | symbol, V>(object: ReadonlyRecord<K, V>, predicate: (value: V) => boolean): V[];
+//# sourceMappingURL=object.d.ts.map

package/dist/functions/object.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Helper functions that have to do with objects.
+ *
+ * @module
+ */
+import type { ReadonlyRecord } from "../types/ReadonlyRecord.js";
+/**
+ * Helper function to get the values in an object that match an arbitrary condition. Similar to the
+ * `Array.map` method, but works for objects.
+ *
+ * This is efficient such that it avoids converting the object values into an array.
+ */
+export declare function objectFilter<K extends string | number | symbol, V>(object: ReadonlyRecord<K, V>, predicate: (value: V) => boolean): V[];
+//# sourceMappingURL=object.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../../src/functions/object.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAEjE;;;;;GAKG;AAEH,wBAAgB,YAAY,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,EAChE,MAAM,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAC5B,SAAS,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,GAC/B,CAAC,EAAE,CAaL"}

package/dist/functions/random.d.cts

@@ -0,0 +1,23 @@
+/**
+ * Helper functions that have to do with getting random values.
+ *
+ * @module
+ */
+/**
+ * This returns a random integer between min and max. It is inclusive on both ends.
+ *
+ * For example:
+ *
+ * ```ts
+ * const oneTwoOrThree = getRandomInt(1, 3);
+ * ```
+ *
+ * @param min The lower bound for the random number (inclusive).
+ * @param max The upper bound for the random number (inclusive).
+ * @param exceptions Optional. An array of elements that will be skipped over when getting the
+ *                   random integer. For example, a min of 1, a max of 4, and an exceptions array of
+ *                   `[2]` would cause the function to return either 1, 3, or 4. Default is an empty
+ *                   array.
+ */
+export declare function getRandomInt(min: number, max: number, exceptions?: readonly number[]): number;
+//# sourceMappingURL=random.d.ts.map

package/dist/functions/random.d.mts

@@ -0,0 +1,23 @@
+/**
+ * Helper functions that have to do with getting random values.
+ *
+ * @module
+ */
+/**
+ * This returns a random integer between min and max. It is inclusive on both ends.
+ *
+ * For example:
+ *
+ * ```ts
+ * const oneTwoOrThree = getRandomInt(1, 3);
+ * ```
+ *
+ * @param min The lower bound for the random number (inclusive).
+ * @param max The upper bound for the random number (inclusive).
+ * @param exceptions Optional. An array of elements that will be skipped over when getting the
+ *                   random integer. For example, a min of 1, a max of 4, and an exceptions array of
+ *                   `[2]` would cause the function to return either 1, 3, or 4. Default is an empty
+ *                   array.
+ */
+export declare function getRandomInt(min: number, max: number, exceptions?: readonly number[]): number;
+//# sourceMappingURL=random.d.ts.map

package/dist/functions/random.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Helper functions that have to do with getting random values.
+ *
+ * @module
+ */
+/**
+ * This returns a random integer between min and max. It is inclusive on both ends.
+ *
+ * For example:
+ *
+ * ```ts
+ * const oneTwoOrThree = getRandomInt(1, 3);
+ * ```
+ *
+ * @param min The lower bound for the random number (inclusive).
+ * @param max The upper bound for the random number (inclusive).
+ * @param exceptions Optional. An array of elements that will be skipped over when getting the
+ *                   random integer. For example, a min of 1, a max of 4, and an exceptions array of
+ *                   `[2]` would cause the function to return either 1, 3, or 4. Default is an empty
+ *                   array.
+ */
+export declare function getRandomInt(min: number, max: number, exceptions?: readonly number[]): number;
+//# sourceMappingURL=random.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"random.d.ts","sourceRoot":"","sources":["../../src/functions/random.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,YAAY,CAC1B,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,UAAU,GAAE,SAAS,MAAM,EAAO,GACjC,MAAM,CAoBR"}

package/dist/functions/set.d.cts

@@ -0,0 +1,61 @@
+/**
+ * Helper functions that have to do with
+ * [sets](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set).
+ *
+ * @module
+ */
+/**
+ * Helper function to add all of the values in one set to another set. The first set passed will be
+ * modified in place.
+ *
+ * This function is variadic, meaning that you can specify N sets to add to the first set.
+ */
+export declare function addSetsToSet<T>(mainSet: Set<T>, ...setsToAdd: ReadonlyArray<ReadonlySet<T>>): void;
+/**
+ * Helper function to create a new set that is the composition of two or more sets.
+ *
+ * This function is variadic, meaning that you can specify N sets.
+ */
+export declare function combineSets<T>(...sets: ReadonlyArray<ReadonlySet<T>>): Set<T>;
+/** Helper function to copy a set. (You can also use a Set constructor to accomplish this task.) */
+export declare function copySet<T>(oldSet: ReadonlySet<T>): Set<T>;
+/**
+ * Helper function to convert the keys of an object to a read-only set.
+ *
+ * Also see the `objectKeysToSet` function.
+ */
+export declare function objectKeysToReadonlySet<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlySet<K>;
+/**
+ * Helper function to convert the keys of an object to a set.
+ *
+ * Also see the `objectKeysToReadonlySet` function.
+ */
+export declare function objectKeysToSet<K extends string | number | symbol, V>(object: Record<K, V>): Set<K>;
+/**
+ * Helper function to convert the values of an object to a read-only set.
+ *
+ * Also see the `objectValuesToSet` function.
+ */
+export declare function objectValuesToReadonlySet<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlySet<V>;
+/**
+ * Helper function to convert the values of an object to a set.
+ *
+ * Also see the `objectValuesToReadonlySet` function.
+ */
+export declare function objectValuesToSet<K extends string | number | symbol, V>(object: Record<K, V>): Set<V>;
+/**
+ * Helper function to add one or more elements to a set at once without having to repeatedly call
+ * the `Set.add` method.
+ *
+ * This function is variadic, meaning that you can pass as many things as you want to add.
+ */
+export declare function setAdd<T>(set: Set<T>, ...elements: readonly T[]): void;
+/**
+ * Helper function to check for one or more elements in a set at once without having to repeatedly
+ * call the `Set.has` method.
+ *
+ * This function is variadic, meaning that you can pass as many things as you want to check for. It
+ * will return true if one or more elements are found.
+ */
+export declare function setHas<T>(set: ReadonlySet<T>, ...elements: readonly T[]): boolean;
+//# sourceMappingURL=set.d.ts.map

package/dist/functions/set.d.mts

@@ -0,0 +1,61 @@
+/**
+ * Helper functions that have to do with
+ * [sets](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set).
+ *
+ * @module
+ */
+/**
+ * Helper function to add all of the values in one set to another set. The first set passed will be
+ * modified in place.
+ *
+ * This function is variadic, meaning that you can specify N sets to add to the first set.
+ */
+export declare function addSetsToSet<T>(mainSet: Set<T>, ...setsToAdd: ReadonlyArray<ReadonlySet<T>>): void;
+/**
+ * Helper function to create a new set that is the composition of two or more sets.
+ *
+ * This function is variadic, meaning that you can specify N sets.
+ */
+export declare function combineSets<T>(...sets: ReadonlyArray<ReadonlySet<T>>): Set<T>;
+/** Helper function to copy a set. (You can also use a Set constructor to accomplish this task.) */
+export declare function copySet<T>(oldSet: ReadonlySet<T>): Set<T>;
+/**
+ * Helper function to convert the keys of an object to a read-only set.
+ *
+ * Also see the `objectKeysToSet` function.
+ */
+export declare function objectKeysToReadonlySet<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlySet<K>;
+/**
+ * Helper function to convert the keys of an object to a set.
+ *
+ * Also see the `objectKeysToReadonlySet` function.
+ */
+export declare function objectKeysToSet<K extends string | number | symbol, V>(object: Record<K, V>): Set<K>;
+/**
+ * Helper function to convert the values of an object to a read-only set.
+ *
+ * Also see the `objectValuesToSet` function.
+ */
+export declare function objectValuesToReadonlySet<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlySet<V>;
+/**
+ * Helper function to convert the values of an object to a set.
+ *
+ * Also see the `objectValuesToReadonlySet` function.
+ */
+export declare function objectValuesToSet<K extends string | number | symbol, V>(object: Record<K, V>): Set<V>;
+/**
+ * Helper function to add one or more elements to a set at once without having to repeatedly call
+ * the `Set.add` method.
+ *
+ * This function is variadic, meaning that you can pass as many things as you want to add.
+ */
+export declare function setAdd<T>(set: Set<T>, ...elements: readonly T[]): void;
+/**
+ * Helper function to check for one or more elements in a set at once without having to repeatedly
+ * call the `Set.has` method.
+ *
+ * This function is variadic, meaning that you can pass as many things as you want to check for. It
+ * will return true if one or more elements are found.
+ */
+export declare function setHas<T>(set: ReadonlySet<T>, ...elements: readonly T[]): boolean;
+//# sourceMappingURL=set.d.ts.map

package/dist/functions/set.d.ts

@@ -0,0 +1,61 @@
+/**
+ * Helper functions that have to do with
+ * [sets](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set).
+ *
+ * @module
+ */
+/**
+ * Helper function to add all of the values in one set to another set. The first set passed will be
+ * modified in place.
+ *
+ * This function is variadic, meaning that you can specify N sets to add to the first set.
+ */
+export declare function addSetsToSet<T>(mainSet: Set<T>, ...setsToAdd: ReadonlyArray<ReadonlySet<T>>): void;
+/**
+ * Helper function to create a new set that is the composition of two or more sets.
+ *
+ * This function is variadic, meaning that you can specify N sets.
+ */
+export declare function combineSets<T>(...sets: ReadonlyArray<ReadonlySet<T>>): Set<T>;
+/** Helper function to copy a set. (You can also use a Set constructor to accomplish this task.) */
+export declare function copySet<T>(oldSet: ReadonlySet<T>): Set<T>;
+/**
+ * Helper function to convert the keys of an object to a read-only set.
+ *
+ * Also see the `objectKeysToSet` function.
+ */
+export declare function objectKeysToReadonlySet<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlySet<K>;
+/**
+ * Helper function to convert the keys of an object to a set.
+ *
+ * Also see the `objectKeysToReadonlySet` function.
+ */
+export declare function objectKeysToSet<K extends string | number | symbol, V>(object: Record<K, V>): Set<K>;
+/**
+ * Helper function to convert the values of an object to a read-only set.
+ *
+ * Also see the `objectValuesToSet` function.
+ */
+export declare function objectValuesToReadonlySet<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlySet<V>;
+/**
+ * Helper function to convert the values of an object to a set.
+ *
+ * Also see the `objectValuesToReadonlySet` function.
+ */
+export declare function objectValuesToSet<K extends string | number | symbol, V>(object: Record<K, V>): Set<V>;
+/**
+ * Helper function to add one or more elements to a set at once without having to repeatedly call
+ * the `Set.add` method.
+ *
+ * This function is variadic, meaning that you can pass as many things as you want to add.
+ */
+export declare function setAdd<T>(set: Set<T>, ...elements: readonly T[]): void;
+/**
+ * Helper function to check for one or more elements in a set at once without having to repeatedly
+ * call the `Set.has` method.
+ *
+ * This function is variadic, meaning that you can pass as many things as you want to check for. It
+ * will return true if one or more elements are found.
+ */
+export declare function setHas<T>(set: ReadonlySet<T>, ...elements: readonly T[]): boolean;
+//# sourceMappingURL=set.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"set.d.ts","sourceRoot":"","sources":["../../src/functions/set.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAE5B,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,EACf,GAAG,SAAS,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAC1C,IAAI,CAMN;AAED;;;;GAIG;AAEH,wBAAgB,WAAW,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAS7E;AAED,mGAAmG;AAEnG,wBAAgB,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAOzD;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,EAC3E,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GACnB,WAAW,CAAC,CAAC,CAAC,CAEhB;AAED;;;;GAIG;AAEH,wBAAgB,eAAe,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,EACnE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GACnB,GAAG,CAAC,CAAC,CAAC,CAQR;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CACvC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAClC,CAAC,EACD,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAEtC;AAED;;;;GAIG;AAEH,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,EACrE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GACnB,GAAG,CAAC,CAAC,CAAC,CAQR;AAED;;;;;GAKG;AAEH,wBAAgB,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,QAAQ,EAAE,SAAS,CAAC,EAAE,GAAG,IAAI,CAItE;AAED;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,CAAC,EACtB,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC,EACnB,GAAG,QAAQ,EAAE,SAAS,CAAC,EAAE,GACxB,OAAO,CAET"}

package/dist/functions/sort.d.cts

@@ -0,0 +1,14 @@
+/**
+ * Helper functions that have to do with sorting.
+ *
+ * @module
+ */
+/**
+ * Helper function to perform a case insensitive sort. This will copy the provided array and return
+ * the sorted copy.
+ *
+ * From:
+ * https://stackoverflow.com/questions/8996963/how-to-perform-case-insensitive-sorting-array-of-string-in-javascript
+ */
+export declare function sortCaseInsensitive(array: readonly string[]): string[];
+//# sourceMappingURL=sort.d.ts.map

package/dist/functions/sort.d.mts

@@ -0,0 +1,14 @@
+/**
+ * Helper functions that have to do with sorting.
+ *
+ * @module
+ */
+/**
+ * Helper function to perform a case insensitive sort. This will copy the provided array and return
+ * the sorted copy.
+ *
+ * From:
+ * https://stackoverflow.com/questions/8996963/how-to-perform-case-insensitive-sorting-array-of-string-in-javascript
+ */
+export declare function sortCaseInsensitive(array: readonly string[]): string[];
+//# sourceMappingURL=sort.d.ts.map

package/dist/functions/sort.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Helper functions that have to do with sorting.
+ *
+ * @module
+ */
+/**
+ * Helper function to perform a case insensitive sort. This will copy the provided array and return
+ * the sorted copy.
+ *
+ * From:
+ * https://stackoverflow.com/questions/8996963/how-to-perform-case-insensitive-sorting-array-of-string-in-javascript
+ */
+export declare function sortCaseInsensitive(array: readonly string[]): string[];
+//# sourceMappingURL=sort.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sort.d.ts","sourceRoot":"","sources":["../../src/functions/sort.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;;GAMG;AAEH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,EAAE,CAStE"}

package/dist/functions/string.d.cts

@@ -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