@alextheman/utility 4.3.2 → 4.3.4

package/dist/index.cjs

@@ -244,7 +244,7 @@ var VersionNumber = class VersionNumber {
 		return firstVersion.major === secondVersion.major && firstVersion.minor === secondVersion.minor && firstVersion.patch === secondVersion.patch;
 	}
 	/**
-	* Determines whether the current instance of `VersionNumber` is a major, minor, or patch version.
+	* Increments the current version number by the given increment type, returning the result as a new reference in memory.
 	*
 	* @param incrementType - The type of increment. Can be one of the following:
 	* - `"major"`: Change the major version `v1.2.3` → `v2.0.0`
@@ -273,6 +273,25 @@ var VersionNumber = class VersionNumber {
 		}[incrementType];
 	}
 	/**
+	* Ensures that the VersionNumber behaves correctly when attempted to be coerced to a string.
+	*
+	* @param hint - Not used as of now, but generally used to help with numeric coercion, I think (which we most likely do not need for version numbers).
+	*
+	* @returns A stringified representation of the current version number, prefixed with `v`.
+	*/
+	[Symbol.toPrimitive](hint) {
+		if (hint === "number") throw new DataError_default(this.toString(), "INVALID_COERCION", "VersionNumber cannot be coerced to a number type.");
+		return this.toString();
+	}
+	/**
+	* Ensures that the VersionNumber behaves correctly when attempted to be converted to JSON.
+	*
+	* @returns A stringified representation of the current version number, prefixed with `v`.
+	*/
+	toJSON() {
+		return this.toString();
+	}
+	/**
 	* Get a string representation of the current version number.
 	*
 	* @param options - Extra additional options to apply.
@@ -1125,6 +1144,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
 /**
@@ -1382,6 +1423,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

@@ -296,7 +296,7 @@ declare class VersionNumber {
    */
   static isEqual(firstVersion: VersionNumber, secondVersion: VersionNumber): boolean;
   /**
-   * Determines whether the current instance of `VersionNumber` is a major, minor, or patch version.
+   * Increments the current version number by the given increment type, returning the result as a new reference in memory.
    *
    * @param incrementType - The type of increment. Can be one of the following:
    * - `"major"`: Change the major version `v1.2.3` → `v2.0.0`
@@ -306,6 +306,20 @@ declare class VersionNumber {
    * @returns A new instance of `VersionNumber` with the increment applied.
    */
   increment(incrementType: VersionType): VersionNumber;
+  /**
+   * Ensures that the VersionNumber behaves correctly when attempted to be coerced to a string.
+   *
+   * @param hint - Not used as of now, but generally used to help with numeric coercion, I think (which we most likely do not need for version numbers).
+   *
+   * @returns A stringified representation of the current version number, prefixed with `v`.
+   */
+  [Symbol.toPrimitive](hint: "default" | "string" | "number"): string;
+  /**
+   * Ensures that the VersionNumber behaves correctly when attempted to be converted to JSON.
+   *
+   * @returns A stringified representation of the current version number, prefixed with `v`.
+   */
+  toJSON(): string;
   /**
    * Get a string representation of the current version number.
    *
@@ -814,6 +828,24 @@ 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.
@@ -993,4 +1025,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, ParallelTuple, ParseVersionOptions, RecordKey, StringListToArrayOptions, VERSION_NUMBER_REGEX, VersionNumber, VersionNumberToStringOptions, 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

@@ -296,7 +296,7 @@ declare class VersionNumber {
    */
   static isEqual(firstVersion: VersionNumber, secondVersion: VersionNumber): boolean;
   /**
-   * Determines whether the current instance of `VersionNumber` is a major, minor, or patch version.
+   * Increments the current version number by the given increment type, returning the result as a new reference in memory.
    *
    * @param incrementType - The type of increment. Can be one of the following:
    * - `"major"`: Change the major version `v1.2.3` → `v2.0.0`
@@ -306,6 +306,20 @@ declare class VersionNumber {
    * @returns A new instance of `VersionNumber` with the increment applied.
    */
   increment(incrementType: VersionType): VersionNumber;
+  /**
+   * Ensures that the VersionNumber behaves correctly when attempted to be coerced to a string.
+   *
+   * @param hint - Not used as of now, but generally used to help with numeric coercion, I think (which we most likely do not need for version numbers).
+   *
+   * @returns A stringified representation of the current version number, prefixed with `v`.
+   */
+  [Symbol.toPrimitive](hint: "default" | "string" | "number"): string;
+  /**
+   * Ensures that the VersionNumber behaves correctly when attempted to be converted to JSON.
+   *
+   * @returns A stringified representation of the current version number, prefixed with `v`.
+   */
+  toJSON(): string;
   /**
    * Get a string representation of the current version number.
    *
@@ -814,6 +828,24 @@ 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.
@@ -993,4 +1025,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, 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, 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

@@ -215,7 +215,7 @@ var VersionNumber = class VersionNumber {
 		return firstVersion.major === secondVersion.major && firstVersion.minor === secondVersion.minor && firstVersion.patch === secondVersion.patch;
 	}
 	/**
-	* Determines whether the current instance of `VersionNumber` is a major, minor, or patch version.
+	* Increments the current version number by the given increment type, returning the result as a new reference in memory.
 	*
 	* @param incrementType - The type of increment. Can be one of the following:
 	* - `"major"`: Change the major version `v1.2.3` → `v2.0.0`
@@ -244,6 +244,25 @@ var VersionNumber = class VersionNumber {
 		}[incrementType];
 	}
 	/**
+	* Ensures that the VersionNumber behaves correctly when attempted to be coerced to a string.
+	*
+	* @param hint - Not used as of now, but generally used to help with numeric coercion, I think (which we most likely do not need for version numbers).
+	*
+	* @returns A stringified representation of the current version number, prefixed with `v`.
+	*/
+	[Symbol.toPrimitive](hint) {
+		if (hint === "number") throw new DataError_default(this.toString(), "INVALID_COERCION", "VersionNumber cannot be coerced to a number type.");
+		return this.toString();
+	}
+	/**
+	* Ensures that the VersionNumber behaves correctly when attempted to be converted to JSON.
+	*
+	* @returns A stringified representation of the current version number, prefixed with `v`.
+	*/
+	toJSON() {
+		return this.toString();
+	}
+	/**
 	* Get a string representation of the current version number.
 	*
 	* @param options - Extra additional options to apply.
@@ -1096,6 +1115,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
 /**
@@ -1334,4 +1375,4 @@ function incrementVersion(version, incrementType, options) {
 var incrementVersion_default = incrementVersion;
 
 //#endregion
-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, 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.2",
+  "version": "4.3.4",
   "description": "Helpful utility functions",
   "repository": {
     "type": "git",