complete-common 1.0.0 → 1.1.0

package/dist/functions/enums.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Helper functions that have to do with TypeScript enums.
+ *
+ * @module
+ */
+type TranspiledEnum = Record<string, string | number>;
+/**
+ * Helper function to get the entries of an enum.
+ *
+ * (By default, TypeScript will put the keys inside of the values of a number-based enum, so those
+ * have to be filtered out.)
+ *
+ * This function will work properly for both number and string enums.
+ */
+export declare function getEnumEntries<T extends TranspiledEnum>(transpiledEnum: T): ReadonlyArray<[key: string, value: T[keyof T]]>;
+/**
+ * Helper function to get the keys of an enum.
+ *
+ * (By default, TypeScript will put the keys inside of the values of a number-based enum, so those
+ * have to be filtered out.)
+ *
+ * This function will work properly for both number and string enums.
+ */
+export declare function getEnumKeys(transpiledEnum: TranspiledEnum): readonly string[];
+/**
+ * Helper function to get the only the values of an enum.
+ *
+ * (By default, TypeScript will put the keys inside of the values of a number-based enum, so those
+ * have to be filtered out.)
+ *
+ * This function will work properly for both number and string enums.
+ */
+export declare function getEnumValues<T extends TranspiledEnum>(transpiledEnum: T): ReadonlyArray<T[keyof T]>;
+/**
+ * Helper function to validate that an interface contains all of the keys of an enum. You must
+ * specify both generic parameters in order for this to work properly (i.e. the interface and then
+ * the enum).
+ *
+ * For example:
+ *
+ * ```ts
+ * enum MyEnum {
+ *   Value1,
+ *   Value2,
+ *   Value3,
+ * }
+ *
+ * interface MyEnumToType {
+ *   [MyEnum.Value1]: boolean;
+ *   [MyEnum.Value2]: number;
+ *   [MyEnum.Value3]: string;
+ * }
+ *
+ * interfaceSatisfiesEnum<MyEnumToType, MyEnum>();
+ * ```
+ *
+ * This function is only meant to be used with interfaces (i.e. types that will not exist at
+ * run-time). If you are generating an object that will contain all of the keys of an enum, use the
+ * `satisfies` operator with the `Record` type instead.
+ */
+export declare function interfaceSatisfiesEnum<T extends Record<Enum, unknown>, Enum extends string | number>(): void;
+/**
+ * Helper function to validate that a particular value exists inside of an enum.
+ *
+ * @param value The value to check.
+ * @param transpiledEnum The enum to check against.
+ * @param set Optional. A set that contains all of the values of an enum. If provided, this function
+ *            will check for existence using the set (instead of the enum itself). Using a set
+ *            should be more performant for enums with around 52 or more elements.
+ */
+export declare function isEnumValue<T extends TranspiledEnum>(value: number | string, transpiledEnum: T, set?: ReadonlySet<string | number>): value is T[keyof T];
+export {};
+//# sourceMappingURL=enums.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../src/functions/enums.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,KAAK,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;AAEtD;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,cAAc,EACrD,cAAc,EAAE,CAAC,GAChB,aAAa,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CASjD;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,cAAc,EAAE,cAAc,GAAG,SAAS,MAAM,EAAE,CAG7E;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,cAAc,EACpD,cAAc,EAAE,CAAC,GAChB,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAG3B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,sBAAsB,CAEpC,CAAC,SAAS,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,EAC/B,IAAI,SAAS,MAAM,GAAG,MAAM,KACzB,IAAI,CAAG;AAEZ;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,cAAc,EAClD,KAAK,EAAE,MAAM,GAAG,MAAM,EACtB,cAAc,EAAE,CAAC,EACjB,GAAG,CAAC,EAAE,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC,GACjC,KAAK,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAOrB"}

package/dist/functions/map.d.cts

@@ -0,0 +1,24 @@
+/**
+ * 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;
+//# sourceMappingURL=map.d.ts.map

package/dist/functions/map.d.mts

@@ -0,0 +1,24 @@
+/**
+ * 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;
+//# sourceMappingURL=map.d.ts.map

package/dist/functions/map.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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;
+//# 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"}

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,60 @@
+/**
+ * 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[];
+/**
+ * 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 converted map will only have string keys, due to the nature of JavaScript objects
+ * only having string keys 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 converted map will only have string keys, due to the nature of JavaScript objects
+ * only having string keys 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>;
+/**
+ * Helper function to convert an object to a reverse map.
+ *
+ * Note that the converted map will only have string keys, due to the nature of JavaScript objects
+ * only having string keys under the hood.
+ *
+ * Also see the `objectToReverseReadonlyMap` function.
+ */
+export declare function objectToReverseMap<K extends string | number | symbol, V extends string | number | symbol>(object: Record<K, V>): Map<V, K>;
+/**
+ * Helper function to convert an object to a reverse read-only map.
+ *
+ * Note that the converted map will only have string keys, due to the nature of JavaScript objects
+ * only having string keys under the hood.
+ *
+ * Also see the `objectToReverseMap` function.
+ */
+export declare function objectToReverseReadonlyMap<K extends string | number | symbol, V extends string | number | symbol>(object: Record<K, V>): ReadonlyMap<V, K>;
+//# sourceMappingURL=object.d.ts.map

package/dist/functions/object.d.mts

@@ -0,0 +1,60 @@
+/**
+ * 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[];
+/**
+ * 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 converted map will only have string keys, due to the nature of JavaScript objects
+ * only having string keys 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 converted map will only have string keys, due to the nature of JavaScript objects
+ * only having string keys 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>;
+/**
+ * Helper function to convert an object to a reverse map.
+ *
+ * Note that the converted map will only have string keys, due to the nature of JavaScript objects
+ * only having string keys under the hood.
+ *
+ * Also see the `objectToReverseReadonlyMap` function.
+ */
+export declare function objectToReverseMap<K extends string | number | symbol, V extends string | number | symbol>(object: Record<K, V>): Map<V, K>;
+/**
+ * Helper function to convert an object to a reverse read-only map.
+ *
+ * Note that the converted map will only have string keys, due to the nature of JavaScript objects
+ * only having string keys under the hood.
+ *
+ * Also see the `objectToReverseMap` function.
+ */
+export declare function objectToReverseReadonlyMap<K extends string | number | symbol, V extends string | number | symbol>(object: Record<K, V>): ReadonlyMap<V, K>;
+//# sourceMappingURL=object.d.ts.map

package/dist/functions/object.d.ts

@@ -0,0 +1,60 @@
+/**
+ * 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[];
+/**
+ * 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 converted map will only have string keys, due to the nature of JavaScript objects
+ * only having string keys 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 converted map will only have string keys, due to the nature of JavaScript objects
+ * only having string keys 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>;
+/**
+ * Helper function to convert an object to a reverse map.
+ *
+ * Note that the converted map will only have string keys, due to the nature of JavaScript objects
+ * only having string keys under the hood.
+ *
+ * Also see the `objectToReverseReadonlyMap` function.
+ */
+export declare function objectToReverseMap<K extends string | number | symbol, V extends string | number | symbol>(object: Record<K, V>): Map<V, K>;
+/**
+ * Helper function to convert an object to a reverse read-only map.
+ *
+ * Note that the converted map will only have string keys, due to the nature of JavaScript objects
+ * only having string keys under the hood.
+ *
+ * Also see the `objectToReverseMap` function.
+ */
+export declare function objectToReverseReadonlyMap<K extends string | number | symbol, V extends string | number | symbol>(object: Record<K, V>): ReadonlyMap<V, K>;
+//# 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;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;AAED;;;;;;;GAOG;AAEH,wBAAgB,kBAAkB,CAChC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAClC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAClC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAQjC;AAED;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CACxC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAClC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAClC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAEzC"}

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"}