@alextheman/utility 4.3.1 → 4.3.3

package/README.md

@@ -1,5 +1,16 @@
 # @alextheman/utility
 
+![npm version](https://img.shields.io/npm/v/@alextheman/utility)
+![npm downloads](https://img.shields.io/npm/dm/@alextheman/utility)
+![npm license](https://img.shields.io/npm/l/@alextheman/utility)
+
+[![CI](https://github.com/AlexMan123456/utility/actions/workflows/ci.yml/badge.svg)](https://github.com/AlexMan123456/utility/actions/workflows/ci.yml)
+[![Publish to NPM Registry](https://github.com/AlexMan123456/utility/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/AlexMan123456/utility/actions/workflows/npm-publish.yml)
+[![Publish to Netlify](https://github.com/AlexMan123456/utility/actions/workflows/netlify-docs-publish.yml/badge.svg)](https://github.com/AlexMan123456/utility/actions/workflows/netlify-docs-publish.yml)
+
+[![Netlify Status](https://api.netlify.com/api/v1/badges/74fd3eaf-3002-472b-ae5e-2bd0ab984b9e/deploy-status)](https://app.netlify.com/projects/alextheman-utility-docs/deploys)
+
+
 This is my personal utility package. It provides custom utility functions that can be used in more or less any TypeScript or JavaScript project, using either the browser or Node environment.
 
 ## Installation
@@ -24,3 +35,9 @@ import { formatDateAndTime } from "@alextheman/utility";
 const myVariable: NonUndefined<string> = formatDateAndTime(new Date());
 // ...
 ```
+
+## Documentation
+
+You can find the relevant documentation of all features of the package in the [docs/features/markdown](https://github.com/AlexMan123456/utility/tree/main/docs/features/markdown) directory of the repository. The hosted documentation site can be found [here](https://alextheman-utility-docs.netlify.app/).
+
+See the GitHub repository [here](https://github.com/AlexMan123456/utility).

package/dist/index.cjs

@@ -175,19 +175,6 @@ var DataError = class extends Error {
 };
 var DataError_default = DataError;
 
-//#endregion
-//#region src/types/VersionType.ts
-/**
-* Represents the three common software version types.
-*
-* @category Types
-*/
-const VersionType = {
-	MAJOR: "major",
-	MINOR: "minor",
-	PATCH: "patch"
-};
-
 //#endregion
 //#region src/types/VersionNumber.ts
 /**
@@ -834,11 +821,16 @@ var parseZodSchema_default = parseZodSchema;
 
 //#endregion
 //#region src/functions/parsers/parseEnv.ts
-const envSchema = zod.z.enum([
-	"test",
-	"development",
-	"production"
-]);
+/**
+* Represents the three common development environments.
+*
+* @category Types
+*/
+const Env = {
+	TEST: "test",
+	DEVELOPMENT: "development",
+	PRODUCTION: "production"
+};
 /**
 * Parses the input and verifies it matches one of the environments allowed by the Env types ("test" | "development" | "production").
 *
@@ -851,7 +843,7 @@ const envSchema = zod.z.enum([
 * @returns The specified environment if allowed.
 */
 function parseEnv(data) {
-	return parseZodSchema_default(envSchema, data, new DataError_default(data, "INVALID_ENV", "The provided environment type must be one of `test | development | production`"));
+	return parseZodSchema_default(zod.z.enum(Env), data, new DataError_default(data, "INVALID_ENV", "The provided environment type must be one of `test | development | production`"));
 }
 var parseEnv_default = parseEnv;
 
@@ -882,6 +874,16 @@ var parseFormData_default = parseFormData;
 //#endregion
 //#region src/functions/parsers/parseVersionType.ts
 /**
+* Represents the three common software version types.
+*
+* @category Types
+*/
+const VersionType = {
+	MAJOR: "major",
+	MINOR: "minor",
+	PATCH: "patch"
+};
+/**
 * Parses the input and verifies it is a valid software version type (i.e. `"major" | "minor" | "patch"`)
 *
 * @category Parsers
@@ -1123,6 +1125,28 @@ function createTemplateStringsArray(strings) {
 }
 var createTemplateStringsArray_default = createTemplateStringsArray;
 
+//#endregion
+//#region src/functions/taggedTemplate/getInterpolations.ts
+/**
+* Gets the strings and interpolations separately from a template string.
+* You can pass a template string directly by doing:
+*
+* ```typescript
+* getInterpolations`Template string here`.
+* ```
+*
+* @category Tagged Template
+*
+* @param strings - The strings from the template to process.
+* @param interpolations - An array of all interpolations from the template.
+*
+* @returns A tuple where the first item is the strings from the template, and the second is the interpolations.
+*/
+function getInterpolations(strings, ...interpolations) {
+	return [strings, interpolations];
+}
+var getInterpolations_default = getInterpolations;
+
 //#endregion
 //#region src/functions/taggedTemplate/interpolate.ts
 /**
@@ -1130,7 +1154,9 @@ var createTemplateStringsArray_default = createTemplateStringsArray;
 *
 * You can pass a template string directly by doing:
 *
-*      interpolate`Template string here`.
+* ```
+* interpolate`Template string here`.
+* ```
 *
 * In this case, it will be functionally the same as if you just wrote the template string by itself.
 *
@@ -1155,7 +1181,9 @@ var interpolate_default = interpolate;
 *
 * You can pass a template string directly by doing:
 *
-*      interpolateObjects`Template string here ${{ my: "object" }}`.
+* ```typescript
+* interpolateObjects`Template string here ${{ my: "object" }}`.
+* ```
 *
 * @category Tagged Template
 *
@@ -1205,15 +1233,19 @@ function reduceLines(lines, { preserveTabs = true }) {
 *
 * You can pass a template string directly by doing:
 *
-*      normaliseIndents`Template string here
-*          with a new line
-*          and another new line`.
+* ```typescript
+* normaliseIndents`Template string here
+*     with a new line
+*     and another new line`.
+* ```
 *
 * You may also pass the options first, then invoke the resulting function with a template string:
 *
-*      normaliseIndents({ preserveTabs: false })`Template string here
-*          with a new line
-*          and another new line`.
+* ```typescript
+* normaliseIndents({ preserveTabs: false })`Template string here
+*     with a new line
+*     and another new line`.
+* ```
 *
 *@category Tagged Template
 *
@@ -1238,15 +1270,19 @@ function normaliseIndents(first, ...args) {
 *
 * You can pass a template string directly by doing:
 *
-*      normalizeIndents`Template string here
-*          with a new line
-*          and another new line`.
+* ```typescript
+* normalizeIndents`Template string here
+*     with a new line
+*     and another new line`.
+* ```
 *
 * You may also pass the options first, then invoke the resulting function with a template string:
 *
-*      normalizeIndents({ preserveTabs: false })`Template string here
-*          with a new line
-*          and another new line`.
+* ```typescript
+* normalizeIndents({ preserveTabs: false })`Template string here
+*     with a new line
+*     and another new line`.
+* ```
 *
 * @param first - The strings from the template to process, or the options to apply.
 * @param args - An array of all interpolations from the template.
@@ -1351,6 +1387,7 @@ var incrementVersion_default = incrementVersion;
 //#endregion
 exports.APIError = APIError_default;
 exports.DataError = DataError_default;
+exports.Env = Env;
 exports.NAMESPACE_EXPORT_REGEX = NAMESPACE_EXPORT_REGEX_default;
 exports.VERSION_NUMBER_REGEX = VERSION_NUMBER_REGEX_default;
 exports.VersionNumber = VersionNumber_default;
@@ -1367,6 +1404,7 @@ exports.determineVersionType = determineVersionType_default;
 exports.fillArray = fillArray_default;
 exports.formatDateAndTime = formatDateAndTime_default;
 exports.getIndividualVersionNumbers = getIndividualVersionNumbers_default;
+exports.getInterpolations = getInterpolations_default;
 exports.getRandomNumber = getRandomNumber_default;
 exports.getRecordKeys = getRecordKeys_default;
 exports.httpErrorCodeLookup = httpErrorCodeLookup;

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { ZodType, core, z } from "zod";
+import { ZodType, core } from "zod";
 
 //#region src/constants/NAMESPACE_EXPORT_REGEX.d.ts
 declare const NAMESPACE_EXPORT_REGEX = "export\\s+\\*\\s+from";
@@ -252,39 +252,14 @@ declare class DataError extends Error {
   static check(input: unknown): input is DataError;
 }
 //#endregion
-//#region src/types/RecordKey.d.ts
-/**
- * Represents the native Record's possible key type.
- *
- * @category Types
- */
-type RecordKey = string | number | symbol;
-//#endregion
-//#region src/types/CreateEnumType.d.ts
-/**
- * Get the value types from a const object so the object can behave similarly to an enum.
- *
- * @category Types
- *
- * @template ObjectType - The type of the object to get the value types for.
- */
-type CreateEnumType<ObjectType extends Record<RecordKey, unknown>> = ObjectType[keyof ObjectType];
-//#endregion
-//#region src/types/VersionType.d.ts
+//#region src/types/VersionNumber.d.ts
 /**
- * Represents the three common software version types.
+ * Options to apply to the stringification of the version number.
  *
- * @category Types
+ * @category Class Options
  */
-declare const VersionType: {
-  readonly MAJOR: "major";
-  readonly MINOR: "minor";
-  readonly PATCH: "patch";
-};
-type VersionType = CreateEnumType<typeof VersionType>;
-//#endregion
-//#region src/types/VersionNumber.d.ts
-interface ToStringOptions {
+interface VersionNumberToStringOptions {
+  /** Whether you want to omit the "v" prefix or not (defaults to false). */
   omitPrefix?: boolean;
 }
 /**
@@ -338,7 +313,7 @@ declare class VersionNumber {
    *
    * @returns A stringified representation of the current version number, leaving out the prefix if `omitPrefix` option was set to true.
    */
-  toString(options?: ToStringOptions): string;
+  toString(options?: VersionNumberToStringOptions): string;
 }
 //#endregion
 //#region src/types/ArrayElement.d.ts
@@ -351,6 +326,24 @@ declare class VersionNumber {
  */
 type ArrayElement<ArrayType extends readonly unknown[]> = ArrayType extends readonly (infer ElementType)[] ? ElementType : never;
 //#endregion
+//#region src/types/RecordKey.d.ts
+/**
+ * Represents the native Record's possible key type.
+ *
+ * @category Types
+ */
+type RecordKey = string | number | symbol;
+//#endregion
+//#region src/types/CreateEnumType.d.ts
+/**
+ * Get the value types from a const object so the object can behave similarly to an enum.
+ *
+ * @category Types
+ *
+ * @template ObjectType - The type of the object to get the value types for.
+ */
+type CreateEnumType<ObjectType extends Record<RecordKey, unknown>> = ObjectType[keyof ObjectType];
+//#endregion
 //#region src/types/DisallowUndefined.d.ts
 /**
  * Resolves to an error message type if the type argument could potentially be undefined.
@@ -395,10 +388,24 @@ type OptionalOnCondition<Condition extends boolean, ResolvedTypeIfTrue> = Condit
 //#region src/functions/miscellaneous/createFormData.d.ts
 type FormDataNullableResolutionStrategy = "stringify" | "empty" | "omit";
 type FormDataArrayResolutionStrategy = "stringify" | "multiple";
+/**
+ * Base options for resolving form data.
+ *
+ * @category Function Options
+ *
+ * @template Key - The type of the key of the input record.
+ */
 interface CreateFormDataOptionsBase<Key extends RecordKey> {
   /** How to resolve any arrays provided in the data (can either stringify them or add them multiple times). */
   arrayResolution?: FormDataArrayResolutionStrategy | Partial<Record<Key, FormDataArrayResolutionStrategy>>;
 }
+/**
+ * Options for resolving form data when it may be undefined or null, but not both.
+ *
+ * @category Function Options
+ *
+ * @template Key - The type of the key of the input record.
+ */
 interface CreateFormDataOptionsUndefinedOrNullResolution<Key extends RecordKey> extends CreateFormDataOptionsBase<Key> {
   /** How to resolve undefined data (May either stringify to 'undefined', resolve to an empty string, or omit entirely). */
   undefinedResolution?: FormDataNullableResolutionStrategy | Partial<Record<Key, FormDataNullableResolutionStrategy>>;
@@ -407,6 +414,13 @@ interface CreateFormDataOptionsUndefinedOrNullResolution<Key extends RecordKey>
   /** @note This must not be provided at the same time as undefinedResolution and/or nullResolution. */
   nullableResolution?: never;
 }
+/**
+ * Options for resolving form data when it may be nullable, but not both.
+ *
+ * @category Function Options
+ *
+ * @template Key - The type of the key of the input record.
+ */
 interface CreateFormDataOptionsNullableResolution<Key extends RecordKey> extends CreateFormDataOptionsBase<Key> {
   /** @note This must not be provided at the same time as nullableResolution. */
   undefinedResolution?: never;
@@ -415,6 +429,13 @@ interface CreateFormDataOptionsNullableResolution<Key extends RecordKey> extends
   /** How to resolve nullable data (May either stringify to 'undefined | null', resolve to an empty string, or omit entirely). */
   nullableResolution: FormDataNullableResolutionStrategy | Partial<Record<Key, FormDataNullableResolutionStrategy>>;
 }
+/**
+ * Options for resolving form data.
+ *
+ * @category Function Options
+ *
+ * @template Key - The type of the key of the input record.
+ */
 type CreateFormDataOptions<Key extends RecordKey> = CreateFormDataOptionsUndefinedOrNullResolution<Key> | CreateFormDataOptionsNullableResolution<Key>;
 /**
  * Creates FormData from a given object, resolving non-string types as appropriate.
@@ -456,6 +477,11 @@ declare function getRandomNumber(lowerBound: number, upperBound: number): number
 declare function isOrdered(array: readonly number[]): boolean;
 //#endregion
 //#region src/functions/miscellaneous/stringListToArray.d.ts
+/**
+ * Options to apply to the conversion of a string list to an array.
+ *
+ * @category Function Options
+ */
 interface StringListToArrayOptions {
   /** What each item in the list is separated by. */
   separator?: string;
@@ -536,17 +562,17 @@ declare function omitProperties<ObjectType extends Record<string, unknown> | Rea
 declare function parseBoolean(inputString: string): boolean;
 //#endregion
 //#region src/functions/parsers/parseEnv.d.ts
-declare const envSchema: z.ZodEnum<{
-  test: "test";
-  development: "development";
-  production: "production";
-}>;
 /**
- * Represents the most common development environments
+ * Represents the three common development environments.
  *
  * @category Types
  */
-type Env = z.infer<typeof envSchema>;
+declare const Env: {
+  TEST: string;
+  DEVELOPMENT: string;
+  PRODUCTION: string;
+};
+type Env = CreateEnumType<typeof Env>;
 /**
  * Parses the input and verifies it matches one of the environments allowed by the Env types ("test" | "development" | "production").
  *
@@ -597,6 +623,17 @@ declare function parseFormData(formData: FormData): Record<string, string | Blob
 declare function parseIntStrict(string: string, radix?: number): number;
 //#endregion
 //#region src/functions/parsers/parseVersionType.d.ts
+/**
+ * Represents the three common software version types.
+ *
+ * @category Types
+ */
+declare const VersionType: {
+  readonly MAJOR: "major";
+  readonly MINOR: "minor";
+  readonly PATCH: "patch";
+};
+type VersionType = CreateEnumType<typeof VersionType>;
 /**
  * Parses the input and verifies it is a valid software version type (i.e. `"major" | "minor" | "patch"`)
  *
@@ -677,6 +714,11 @@ declare function deepFreeze<ObjectType extends object>(object: ObjectType): Read
 declare function appendSemicolon(stringToAppendTo: string): string;
 //#endregion
 //#region src/functions/stringHelpers/camelToKebab.d.ts
+/**
+ * Options to apply to the conversion from camelCase to kebab-case
+ *
+ * @category Function Options
+ */
 interface CamelToKebabOptions {
   /** Whether to leave consecutive capitals alone in the conversion or not (e.g. `validateAPIUser` becomes `validate-a-p-i-user` if `false`, and `validate-api-user` if `true`) */
   preserveConsecutiveCapitals?: boolean;
@@ -694,6 +736,11 @@ interface CamelToKebabOptions {
 declare function camelToKebab(string: string, options?: CamelToKebabOptions): string;
 //#endregion
 //#region src/functions/stringHelpers/kebabToCamel.d.ts
+/**
+ * Options to apply to the conversion from kebab-case to camelCase
+ *
+ * @category Function Options
+ */
 interface KebabToCamelOptions {
   /** Whether or not the converted string should start with an uppercase (e.g. CamelCase instead of camelCase). */
   startWithUpper?: boolean;
@@ -767,13 +814,33 @@ declare function truncate(stringToTruncate: string, maxLength?: number): string;
  */
 declare function createTemplateStringsArray(strings: readonly string[]): TemplateStringsArray;
 //#endregion
+//#region src/functions/taggedTemplate/getInterpolations.d.ts
+/**
+ * Gets the strings and interpolations separately from a template string.
+ * You can pass a template string directly by doing:
+ *
+ * ```typescript
+ * getInterpolations`Template string here`.
+ * ```
+ *
+ * @category Tagged Template
+ *
+ * @param strings - The strings from the template to process.
+ * @param interpolations - An array of all interpolations from the template.
+ *
+ * @returns A tuple where the first item is the strings from the template, and the second is the interpolations.
+ */
+declare function getInterpolations(strings: TemplateStringsArray, ...interpolations: unknown[]): [TemplateStringsArray, unknown[]];
+//#endregion
 //#region src/functions/taggedTemplate/interpolate.d.ts
 /**
  * Returns the result of interpolating a template string when given the strings and interpolations separately.
  *
  * You can pass a template string directly by doing:
  *
- *      interpolate`Template string here`.
+ * ```
+ * interpolate`Template string here`.
+ * ```
  *
  * In this case, it will be functionally the same as if you just wrote the template string by itself.
  *
@@ -792,7 +859,9 @@ declare function interpolate(strings: TemplateStringsArray, ...interpolations: u
  *
  * You can pass a template string directly by doing:
  *
- *      interpolateObjects`Template string here ${{ my: "object" }}`.
+ * ```typescript
+ * interpolateObjects`Template string here ${{ my: "object" }}`.
+ * ```
  *
  * @category Tagged Template
  *
@@ -804,6 +873,11 @@ declare function interpolate(strings: TemplateStringsArray, ...interpolations: u
 declare function interpolateObjects(strings: TemplateStringsArray, ...interpolations: unknown[]): string;
 //#endregion
 //#region src/functions/taggedTemplate/normaliseIndents.d.ts
+/**
+ * Options to apply to the normalisation of indents in multi-line template strings
+ *
+ * @category Function Options
+ */
 interface NormaliseIndentsOptions {
   /** Whether to preserve extra tabs or not (defaults to true) */
   preserveTabs?: boolean;
@@ -826,9 +900,11 @@ declare function normaliseIndents(options: NormaliseIndentsOptions): NormaliseIn
  *
  * You can pass a template string directly by doing:
  *
- *      normaliseIndents`Template string here
- *          with a new line
- *          and another new line`.
+ * ```typescript
+ * normaliseIndents`Template string here
+ *     with a new line
+ *     and another new line`.
+ * ```
  *
  *@category Tagged Template
  *
@@ -843,15 +919,19 @@ declare function normaliseIndents(strings: TemplateStringsArray, ...interpolatio
  *
  * You can pass a template string directly by doing:
  *
- *      normalizeIndents`Template string here
- *          with a new line
- *          and another new line`.
+ * ```typescript
+ * normalizeIndents`Template string here
+ *     with a new line
+ *     and another new line`.
+ * ```
  *
  * You may also pass the options first, then invoke the resulting function with a template string:
  *
- *      normalizeIndents({ preserveTabs: false })`Template string here
- *          with a new line
- *          and another new line`.
+ * ```typescript
+ * normalizeIndents({ preserveTabs: false })`Template string here
+ *     with a new line
+ *     and another new line`.
+ * ```
  *
  * @param first - The strings from the template to process, or the options to apply.
  * @param args - An array of all interpolations from the template.
@@ -931,4 +1011,4 @@ interface ParseVersionOptions {
  */
 declare function parseVersion(input: string, options?: ParseVersionOptions): string;
 //#endregion
-export { APIError, ArrayElement, CamelToKebabOptions, CreateEnumType, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DisallowUndefined, Env, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, IncrementVersionOptions, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, OptionalOnCondition, ParseVersionOptions, RecordKey, StringListToArrayOptions, VERSION_NUMBER_REGEX, VersionNumber, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, determineVersionType, fillArray, formatDateAndTime, getIndividualVersionNumbers, getRandomNumber, getRecordKeys, httpErrorCodeLookup, incrementVersion, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normaliseIndents, normalizeImportPath, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseVersion, parseVersionType, parseZodSchema, randomiseArray, range, removeDuplicates, stringListToArray, truncate, wait };
+export { APIError, ArrayElement, CamelToKebabOptions, CreateEnumType, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DisallowUndefined, Env, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, IncrementVersionOptions, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, OptionalOnCondition, ParallelTuple, ParseVersionOptions, RecordKey, StringListToArrayOptions, VERSION_NUMBER_REGEX, VersionNumber, VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, determineVersionType, fillArray, formatDateAndTime, getIndividualVersionNumbers, getInterpolations, getRandomNumber, getRecordKeys, httpErrorCodeLookup, incrementVersion, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normaliseIndents, normalizeImportPath, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseVersion, parseVersionType, parseZodSchema, randomiseArray, range, removeDuplicates, stringListToArray, truncate, wait };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ZodType, core, z as z$1 } from "zod";
+import { ZodType, core } from "zod";
 
 //#region src/constants/NAMESPACE_EXPORT_REGEX.d.ts
 declare const NAMESPACE_EXPORT_REGEX = "export\\s+\\*\\s+from";
@@ -252,39 +252,14 @@ declare class DataError extends Error {
   static check(input: unknown): input is DataError;
 }
 //#endregion
-//#region src/types/RecordKey.d.ts
-/**
- * Represents the native Record's possible key type.
- *
- * @category Types
- */
-type RecordKey = string | number | symbol;
-//#endregion
-//#region src/types/CreateEnumType.d.ts
-/**
- * Get the value types from a const object so the object can behave similarly to an enum.
- *
- * @category Types
- *
- * @template ObjectType - The type of the object to get the value types for.
- */
-type CreateEnumType<ObjectType extends Record<RecordKey, unknown>> = ObjectType[keyof ObjectType];
-//#endregion
-//#region src/types/VersionType.d.ts
+//#region src/types/VersionNumber.d.ts
 /**
- * Represents the three common software version types.
+ * Options to apply to the stringification of the version number.
  *
- * @category Types
+ * @category Class Options
  */
-declare const VersionType: {
-  readonly MAJOR: "major";
-  readonly MINOR: "minor";
-  readonly PATCH: "patch";
-};
-type VersionType = CreateEnumType<typeof VersionType>;
-//#endregion
-//#region src/types/VersionNumber.d.ts
-interface ToStringOptions {
+interface VersionNumberToStringOptions {
+  /** Whether you want to omit the "v" prefix or not (defaults to false). */
   omitPrefix?: boolean;
 }
 /**
@@ -338,7 +313,7 @@ declare class VersionNumber {
    *
    * @returns A stringified representation of the current version number, leaving out the prefix if `omitPrefix` option was set to true.
    */
-  toString(options?: ToStringOptions): string;
+  toString(options?: VersionNumberToStringOptions): string;
 }
 //#endregion
 //#region src/types/ArrayElement.d.ts
@@ -351,6 +326,24 @@ declare class VersionNumber {
  */
 type ArrayElement<ArrayType extends readonly unknown[]> = ArrayType extends readonly (infer ElementType)[] ? ElementType : never;
 //#endregion
+//#region src/types/RecordKey.d.ts
+/**
+ * Represents the native Record's possible key type.
+ *
+ * @category Types
+ */
+type RecordKey = string | number | symbol;
+//#endregion
+//#region src/types/CreateEnumType.d.ts
+/**
+ * Get the value types from a const object so the object can behave similarly to an enum.
+ *
+ * @category Types
+ *
+ * @template ObjectType - The type of the object to get the value types for.
+ */
+type CreateEnumType<ObjectType extends Record<RecordKey, unknown>> = ObjectType[keyof ObjectType];
+//#endregion
 //#region src/types/DisallowUndefined.d.ts
 /**
  * Resolves to an error message type if the type argument could potentially be undefined.
@@ -395,10 +388,24 @@ type OptionalOnCondition<Condition extends boolean, ResolvedTypeIfTrue> = Condit
 //#region src/functions/miscellaneous/createFormData.d.ts
 type FormDataNullableResolutionStrategy = "stringify" | "empty" | "omit";
 type FormDataArrayResolutionStrategy = "stringify" | "multiple";
+/**
+ * Base options for resolving form data.
+ *
+ * @category Function Options
+ *
+ * @template Key - The type of the key of the input record.
+ */
 interface CreateFormDataOptionsBase<Key extends RecordKey> {
   /** How to resolve any arrays provided in the data (can either stringify them or add them multiple times). */
   arrayResolution?: FormDataArrayResolutionStrategy | Partial<Record<Key, FormDataArrayResolutionStrategy>>;
 }
+/**
+ * Options for resolving form data when it may be undefined or null, but not both.
+ *
+ * @category Function Options
+ *
+ * @template Key - The type of the key of the input record.
+ */
 interface CreateFormDataOptionsUndefinedOrNullResolution<Key extends RecordKey> extends CreateFormDataOptionsBase<Key> {
   /** How to resolve undefined data (May either stringify to 'undefined', resolve to an empty string, or omit entirely). */
   undefinedResolution?: FormDataNullableResolutionStrategy | Partial<Record<Key, FormDataNullableResolutionStrategy>>;
@@ -407,6 +414,13 @@ interface CreateFormDataOptionsUndefinedOrNullResolution<Key extends RecordKey>
   /** @note This must not be provided at the same time as undefinedResolution and/or nullResolution. */
   nullableResolution?: never;
 }
+/**
+ * Options for resolving form data when it may be nullable, but not both.
+ *
+ * @category Function Options
+ *
+ * @template Key - The type of the key of the input record.
+ */
 interface CreateFormDataOptionsNullableResolution<Key extends RecordKey> extends CreateFormDataOptionsBase<Key> {
   /** @note This must not be provided at the same time as nullableResolution. */
   undefinedResolution?: never;
@@ -415,6 +429,13 @@ interface CreateFormDataOptionsNullableResolution<Key extends RecordKey> extends
   /** How to resolve nullable data (May either stringify to 'undefined | null', resolve to an empty string, or omit entirely). */
   nullableResolution: FormDataNullableResolutionStrategy | Partial<Record<Key, FormDataNullableResolutionStrategy>>;
 }
+/**
+ * Options for resolving form data.
+ *
+ * @category Function Options
+ *
+ * @template Key - The type of the key of the input record.
+ */
 type CreateFormDataOptions<Key extends RecordKey> = CreateFormDataOptionsUndefinedOrNullResolution<Key> | CreateFormDataOptionsNullableResolution<Key>;
 /**
  * Creates FormData from a given object, resolving non-string types as appropriate.
@@ -456,6 +477,11 @@ declare function getRandomNumber(lowerBound: number, upperBound: number): number
 declare function isOrdered(array: readonly number[]): boolean;
 //#endregion
 //#region src/functions/miscellaneous/stringListToArray.d.ts
+/**
+ * Options to apply to the conversion of a string list to an array.
+ *
+ * @category Function Options
+ */
 interface StringListToArrayOptions {
   /** What each item in the list is separated by. */
   separator?: string;
@@ -536,17 +562,17 @@ declare function omitProperties<ObjectType extends Record<string, unknown> | Rea
 declare function parseBoolean(inputString: string): boolean;
 //#endregion
 //#region src/functions/parsers/parseEnv.d.ts
-declare const envSchema: z$1.ZodEnum<{
-  test: "test";
-  development: "development";
-  production: "production";
-}>;
 /**
- * Represents the most common development environments
+ * Represents the three common development environments.
  *
  * @category Types
  */
-type Env = z$1.infer<typeof envSchema>;
+declare const Env: {
+  TEST: string;
+  DEVELOPMENT: string;
+  PRODUCTION: string;
+};
+type Env = CreateEnumType<typeof Env>;
 /**
  * Parses the input and verifies it matches one of the environments allowed by the Env types ("test" | "development" | "production").
  *
@@ -597,6 +623,17 @@ declare function parseFormData(formData: FormData): Record<string, string | Blob
 declare function parseIntStrict(string: string, radix?: number): number;
 //#endregion
 //#region src/functions/parsers/parseVersionType.d.ts
+/**
+ * Represents the three common software version types.
+ *
+ * @category Types
+ */
+declare const VersionType: {
+  readonly MAJOR: "major";
+  readonly MINOR: "minor";
+  readonly PATCH: "patch";
+};
+type VersionType = CreateEnumType<typeof VersionType>;
 /**
  * Parses the input and verifies it is a valid software version type (i.e. `"major" | "minor" | "patch"`)
  *
@@ -677,6 +714,11 @@ declare function deepFreeze<ObjectType extends object>(object: ObjectType): Read
 declare function appendSemicolon(stringToAppendTo: string): string;
 //#endregion
 //#region src/functions/stringHelpers/camelToKebab.d.ts
+/**
+ * Options to apply to the conversion from camelCase to kebab-case
+ *
+ * @category Function Options
+ */
 interface CamelToKebabOptions {
   /** Whether to leave consecutive capitals alone in the conversion or not (e.g. `validateAPIUser` becomes `validate-a-p-i-user` if `false`, and `validate-api-user` if `true`) */
   preserveConsecutiveCapitals?: boolean;
@@ -694,6 +736,11 @@ interface CamelToKebabOptions {
 declare function camelToKebab(string: string, options?: CamelToKebabOptions): string;
 //#endregion
 //#region src/functions/stringHelpers/kebabToCamel.d.ts
+/**
+ * Options to apply to the conversion from kebab-case to camelCase
+ *
+ * @category Function Options
+ */
 interface KebabToCamelOptions {
   /** Whether or not the converted string should start with an uppercase (e.g. CamelCase instead of camelCase). */
   startWithUpper?: boolean;
@@ -767,13 +814,33 @@ declare function truncate(stringToTruncate: string, maxLength?: number): string;
  */
 declare function createTemplateStringsArray(strings: readonly string[]): TemplateStringsArray;
 //#endregion
+//#region src/functions/taggedTemplate/getInterpolations.d.ts
+/**
+ * Gets the strings and interpolations separately from a template string.
+ * You can pass a template string directly by doing:
+ *
+ * ```typescript
+ * getInterpolations`Template string here`.
+ * ```
+ *
+ * @category Tagged Template
+ *
+ * @param strings - The strings from the template to process.
+ * @param interpolations - An array of all interpolations from the template.
+ *
+ * @returns A tuple where the first item is the strings from the template, and the second is the interpolations.
+ */
+declare function getInterpolations(strings: TemplateStringsArray, ...interpolations: unknown[]): [TemplateStringsArray, unknown[]];
+//#endregion
 //#region src/functions/taggedTemplate/interpolate.d.ts
 /**
  * Returns the result of interpolating a template string when given the strings and interpolations separately.
  *
  * You can pass a template string directly by doing:
  *
- *      interpolate`Template string here`.
+ * ```
+ * interpolate`Template string here`.
+ * ```
  *
  * In this case, it will be functionally the same as if you just wrote the template string by itself.
  *
@@ -792,7 +859,9 @@ declare function interpolate(strings: TemplateStringsArray, ...interpolations: u
  *
  * You can pass a template string directly by doing:
  *
- *      interpolateObjects`Template string here ${{ my: "object" }}`.
+ * ```typescript
+ * interpolateObjects`Template string here ${{ my: "object" }}`.
+ * ```
  *
  * @category Tagged Template
  *
@@ -804,6 +873,11 @@ declare function interpolate(strings: TemplateStringsArray, ...interpolations: u
 declare function interpolateObjects(strings: TemplateStringsArray, ...interpolations: unknown[]): string;
 //#endregion
 //#region src/functions/taggedTemplate/normaliseIndents.d.ts
+/**
+ * Options to apply to the normalisation of indents in multi-line template strings
+ *
+ * @category Function Options
+ */
 interface NormaliseIndentsOptions {
   /** Whether to preserve extra tabs or not (defaults to true) */
   preserveTabs?: boolean;
@@ -826,9 +900,11 @@ declare function normaliseIndents(options: NormaliseIndentsOptions): NormaliseIn
  *
  * You can pass a template string directly by doing:
  *
- *      normaliseIndents`Template string here
- *          with a new line
- *          and another new line`.
+ * ```typescript
+ * normaliseIndents`Template string here
+ *     with a new line
+ *     and another new line`.
+ * ```
  *
  *@category Tagged Template
  *
@@ -843,15 +919,19 @@ declare function normaliseIndents(strings: TemplateStringsArray, ...interpolatio
  *
  * You can pass a template string directly by doing:
  *
- *      normalizeIndents`Template string here
- *          with a new line
- *          and another new line`.
+ * ```typescript
+ * normalizeIndents`Template string here
+ *     with a new line
+ *     and another new line`.
+ * ```
  *
  * You may also pass the options first, then invoke the resulting function with a template string:
  *
- *      normalizeIndents({ preserveTabs: false })`Template string here
- *          with a new line
- *          and another new line`.
+ * ```typescript
+ * normalizeIndents({ preserveTabs: false })`Template string here
+ *     with a new line
+ *     and another new line`.
+ * ```
  *
  * @param first - The strings from the template to process, or the options to apply.
  * @param args - An array of all interpolations from the template.
@@ -931,4 +1011,4 @@ interface ParseVersionOptions {
  */
 declare function parseVersion(input: string, options?: ParseVersionOptions): string;
 //#endregion
-export { APIError, ArrayElement, CamelToKebabOptions, CreateEnumType, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DisallowUndefined, type Env, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, IncrementVersionOptions, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, OptionalOnCondition, ParseVersionOptions, RecordKey, StringListToArrayOptions, VERSION_NUMBER_REGEX, VersionNumber, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, determineVersionType, fillArray, formatDateAndTime, getIndividualVersionNumbers, getRandomNumber, getRecordKeys, httpErrorCodeLookup, incrementVersion, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normaliseIndents, normalizeImportPath, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseVersion, parseVersionType, parseZodSchema, randomiseArray, range, removeDuplicates, stringListToArray, truncate, wait };
+export { APIError, ArrayElement, CamelToKebabOptions, CreateEnumType, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DisallowUndefined, Env, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, type IncrementVersionOptions, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, OptionalOnCondition, ParallelTuple, type ParseVersionOptions, RecordKey, StringListToArrayOptions, VERSION_NUMBER_REGEX, VersionNumber, VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, determineVersionType, fillArray, formatDateAndTime, getIndividualVersionNumbers, getInterpolations, getRandomNumber, getRecordKeys, httpErrorCodeLookup, incrementVersion, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normaliseIndents, normalizeImportPath, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseVersion, parseVersionType, parseZodSchema, randomiseArray, range, removeDuplicates, stringListToArray, truncate, wait };

package/dist/index.js

@@ -146,19 +146,6 @@ var DataError = class extends Error {
 };
 var DataError_default = DataError;
 
-//#endregion
-//#region src/types/VersionType.ts
-/**
-* Represents the three common software version types.
-*
-* @category Types
-*/
-const VersionType = {
-	MAJOR: "major",
-	MINOR: "minor",
-	PATCH: "patch"
-};
-
 //#endregion
 //#region src/types/VersionNumber.ts
 /**
@@ -805,11 +792,16 @@ var parseZodSchema_default = parseZodSchema;
 
 //#endregion
 //#region src/functions/parsers/parseEnv.ts
-const envSchema = z$1.enum([
-	"test",
-	"development",
-	"production"
-]);
+/**
+* Represents the three common development environments.
+*
+* @category Types
+*/
+const Env = {
+	TEST: "test",
+	DEVELOPMENT: "development",
+	PRODUCTION: "production"
+};
 /**
 * Parses the input and verifies it matches one of the environments allowed by the Env types ("test" | "development" | "production").
 *
@@ -822,7 +814,7 @@ const envSchema = z$1.enum([
 * @returns The specified environment if allowed.
 */
 function parseEnv(data) {
-	return parseZodSchema_default(envSchema, data, new DataError_default(data, "INVALID_ENV", "The provided environment type must be one of `test | development | production`"));
+	return parseZodSchema_default(z$1.enum(Env), data, new DataError_default(data, "INVALID_ENV", "The provided environment type must be one of `test | development | production`"));
 }
 var parseEnv_default = parseEnv;
 
@@ -853,6 +845,16 @@ var parseFormData_default = parseFormData;
 //#endregion
 //#region src/functions/parsers/parseVersionType.ts
 /**
+* Represents the three common software version types.
+*
+* @category Types
+*/
+const VersionType = {
+	MAJOR: "major",
+	MINOR: "minor",
+	PATCH: "patch"
+};
+/**
 * Parses the input and verifies it is a valid software version type (i.e. `"major" | "minor" | "patch"`)
 *
 * @category Parsers
@@ -1094,6 +1096,28 @@ function createTemplateStringsArray(strings) {
 }
 var createTemplateStringsArray_default = createTemplateStringsArray;
 
+//#endregion
+//#region src/functions/taggedTemplate/getInterpolations.ts
+/**
+* Gets the strings and interpolations separately from a template string.
+* You can pass a template string directly by doing:
+*
+* ```typescript
+* getInterpolations`Template string here`.
+* ```
+*
+* @category Tagged Template
+*
+* @param strings - The strings from the template to process.
+* @param interpolations - An array of all interpolations from the template.
+*
+* @returns A tuple where the first item is the strings from the template, and the second is the interpolations.
+*/
+function getInterpolations(strings, ...interpolations) {
+	return [strings, interpolations];
+}
+var getInterpolations_default = getInterpolations;
+
 //#endregion
 //#region src/functions/taggedTemplate/interpolate.ts
 /**
@@ -1101,7 +1125,9 @@ var createTemplateStringsArray_default = createTemplateStringsArray;
 *
 * You can pass a template string directly by doing:
 *
-*      interpolate`Template string here`.
+* ```
+* interpolate`Template string here`.
+* ```
 *
 * In this case, it will be functionally the same as if you just wrote the template string by itself.
 *
@@ -1126,7 +1152,9 @@ var interpolate_default = interpolate;
 *
 * You can pass a template string directly by doing:
 *
-*      interpolateObjects`Template string here ${{ my: "object" }}`.
+* ```typescript
+* interpolateObjects`Template string here ${{ my: "object" }}`.
+* ```
 *
 * @category Tagged Template
 *
@@ -1176,15 +1204,19 @@ function reduceLines(lines, { preserveTabs = true }) {
 *
 * You can pass a template string directly by doing:
 *
-*      normaliseIndents`Template string here
-*          with a new line
-*          and another new line`.
+* ```typescript
+* normaliseIndents`Template string here
+*     with a new line
+*     and another new line`.
+* ```
 *
 * You may also pass the options first, then invoke the resulting function with a template string:
 *
-*      normaliseIndents({ preserveTabs: false })`Template string here
-*          with a new line
-*          and another new line`.
+* ```typescript
+* normaliseIndents({ preserveTabs: false })`Template string here
+*     with a new line
+*     and another new line`.
+* ```
 *
 *@category Tagged Template
 *
@@ -1209,15 +1241,19 @@ function normaliseIndents(first, ...args) {
 *
 * You can pass a template string directly by doing:
 *
-*      normalizeIndents`Template string here
-*          with a new line
-*          and another new line`.
+* ```typescript
+* normalizeIndents`Template string here
+*     with a new line
+*     and another new line`.
+* ```
 *
 * You may also pass the options first, then invoke the resulting function with a template string:
 *
-*      normalizeIndents({ preserveTabs: false })`Template string here
-*          with a new line
-*          and another new line`.
+* ```typescript
+* normalizeIndents({ preserveTabs: false })`Template string here
+*     with a new line
+*     and another new line`.
+* ```
 *
 * @param first - The strings from the template to process, or the options to apply.
 * @param args - An array of all interpolations from the template.
@@ -1320,4 +1356,4 @@ function incrementVersion(version, incrementType, options) {
 var incrementVersion_default = incrementVersion;
 
 //#endregion
-export { APIError_default as APIError, DataError_default as DataError, NAMESPACE_EXPORT_REGEX_default as NAMESPACE_EXPORT_REGEX, VERSION_NUMBER_REGEX_default as VERSION_NUMBER_REGEX, VersionNumber_default as VersionNumber, VersionType, addDaysToDate_default as addDaysToDate, appendSemicolon_default as appendSemicolon, camelToKebab_default as camelToKebab, convertFileToBase64_default as convertFileToBase64, createFormData_default as createFormData, createTemplateStringsArray_default as createTemplateStringsArray, deepCopy_default as deepCopy, deepFreeze_default as deepFreeze, determineVersionType_default as determineVersionType, fillArray_default as fillArray, formatDateAndTime_default as formatDateAndTime, getIndividualVersionNumbers_default as getIndividualVersionNumbers, getRandomNumber_default as getRandomNumber, getRecordKeys_default as getRecordKeys, httpErrorCodeLookup, incrementVersion_default as incrementVersion, interpolate_default as interpolate, interpolateObjects_default as interpolateObjects, isAnniversary_default as isAnniversary, isLeapYear_default as isLeapYear, isMonthlyMultiple_default as isMonthlyMultiple, isOrdered_default as isOrdered, isSameDate_default as isSameDate, kebabToCamel_default as kebabToCamel, normaliseImportPath, normaliseIndents_default as normaliseIndents, normalizeImportPath_default as normalizeImportPath, normalizeIndents, omitProperties_default as omitProperties, paralleliseArrays_default as paralleliseArrays, parseBoolean_default as parseBoolean, parseEnv_default as parseEnv, parseFormData_default as parseFormData, parseIntStrict_default as parseIntStrict, parseVersion_default as parseVersion, parseVersionType_default as parseVersionType, parseZodSchema_default as parseZodSchema, randomiseArray_default as randomiseArray, range_default as range, removeDuplicates_default as removeDuplicates, stringListToArray_default as stringListToArray, truncate_default as truncate, wait_default as wait };
+export { APIError_default as APIError, DataError_default as DataError, Env, NAMESPACE_EXPORT_REGEX_default as NAMESPACE_EXPORT_REGEX, VERSION_NUMBER_REGEX_default as VERSION_NUMBER_REGEX, VersionNumber_default as VersionNumber, VersionType, addDaysToDate_default as addDaysToDate, appendSemicolon_default as appendSemicolon, camelToKebab_default as camelToKebab, convertFileToBase64_default as convertFileToBase64, createFormData_default as createFormData, createTemplateStringsArray_default as createTemplateStringsArray, deepCopy_default as deepCopy, deepFreeze_default as deepFreeze, determineVersionType_default as determineVersionType, fillArray_default as fillArray, formatDateAndTime_default as formatDateAndTime, getIndividualVersionNumbers_default as getIndividualVersionNumbers, getInterpolations_default as getInterpolations, getRandomNumber_default as getRandomNumber, getRecordKeys_default as getRecordKeys, httpErrorCodeLookup, incrementVersion_default as incrementVersion, interpolate_default as interpolate, interpolateObjects_default as interpolateObjects, isAnniversary_default as isAnniversary, isLeapYear_default as isLeapYear, isMonthlyMultiple_default as isMonthlyMultiple, isOrdered_default as isOrdered, isSameDate_default as isSameDate, kebabToCamel_default as kebabToCamel, normaliseImportPath, normaliseIndents_default as normaliseIndents, normalizeImportPath_default as normalizeImportPath, normalizeIndents, omitProperties_default as omitProperties, paralleliseArrays_default as paralleliseArrays, parseBoolean_default as parseBoolean, parseEnv_default as parseEnv, parseFormData_default as parseFormData, parseIntStrict_default as parseIntStrict, parseVersion_default as parseVersion, parseVersionType_default as parseVersionType, parseZodSchema_default as parseZodSchema, randomiseArray_default as randomiseArray, range_default as range, removeDuplicates_default as removeDuplicates, stringListToArray_default as stringListToArray, truncate_default as truncate, wait_default as wait };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alextheman/utility",
-  "version": "4.3.1",
+  "version": "4.3.3",
   "description": "Helpful utility functions",
   "repository": {
     "type": "git",
@@ -19,7 +19,7 @@
     "zod": "^4.2.1"
   },
   "devDependencies": {
-    "@alextheman/eslint-plugin": "^5.2.0",
+    "@alextheman/eslint-plugin": "^5.2.1",
     "@types/node": "^25.0.3",
     "alex-c-line": "^1.10.0",
     "dotenv-cli": "^11.0.0",