@alextheman/utility 4.12.3 → 4.14.0

package/dist/index.d.cts

@@ -498,6 +498,16 @@ declare function getRandomNumber(lowerBound: number, upperBound: number): number
  */
 declare function isOrdered(array: readonly number[]): boolean;
 //#endregion
+//#region src/functions/miscellaneous/sayHello.d.ts
+/**
+ * Returns a string representing the lyrics to the package's theme song, Commit To You
+ *
+ * [Pls listen!](https://www.youtube.com/watch?v=mH-Sg-8EnxM)
+ *
+ * @returns The lyrics string in markdown format.
+ */
+declare function sayHello(): string;
+//#endregion
 //#region src/functions/miscellaneous/stringifyDotenv.d.ts
 type QuoteStyle = "double" | "single" | "none";
 interface StringifyDotenvOptions {
@@ -967,6 +977,7 @@ declare function createTemplateStringsArray(strings: readonly string[]): Templat
 //#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:
  *
@@ -976,6 +987,8 @@ declare function createTemplateStringsArray(strings: readonly string[]): Templat
  *
  * @category Tagged Template
  *
+ * @deprecated Please use `getStringsAndInterpolations` instead.
+ *
  * @param strings - The strings from the template to process.
  * @param interpolations - An array of all interpolations from the template.
  *
@@ -983,6 +996,38 @@ declare function createTemplateStringsArray(strings: readonly string[]): Templat
  */
 declare function getInterpolations(strings: TemplateStringsArray, ...interpolations: unknown[]): [TemplateStringsArray, unknown[]];
 //#endregion
+//#region src/functions/taggedTemplate/getStringsAndInterpolations.d.ts
+/**
+ *
+ * Gets the strings and interpolations separately from a template string.
+ * You can pass a template string directly by doing:
+ *
+ * ```typescript
+ * getStringsAndInterpolations`Template string here`;
+ * ```
+ *
+ * @category Tagged Template
+ *
+ * @template InterpolationsType - The type of the interpolations.
+ *
+ * @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 remaining items are the interpolations.
+ *
+ * The return of this function may also be spread into any other tagged template function in the following way:
+ *
+ * ```typescript
+ * import { interpolate } from "@alextheman/utility"; // Example function
+ *
+ * const packageName = "@alextheman/utility";
+ * const packageManager = getPackageManager(packageName);
+ *
+ * interpolate(...getStringsAndInterpolations`The package ${packageName} uses the ${packageManager} package manager.`);
+ * ```
+ */
+declare function getStringsAndInterpolations<const InterpolationsType extends readonly unknown[]>(strings: TemplateStringsArray, ...interpolations: InterpolationsType): [TemplateStringsArray, ...InterpolationsType];
+//#endregion
 //#region src/functions/taggedTemplate/interpolate.d.ts
 /**
  * Returns the result of interpolating a template string when given the strings and interpolations separately.
@@ -997,12 +1042,14 @@ declare function getInterpolations(strings: TemplateStringsArray, ...interpolati
  *
  * @category Tagged Template
  *
+ * @template InterpolationsType - The type of the interpolations.
+ *
  * @param strings - The strings from the template to process.
  * @param interpolations - An array of all interpolations from the template.
  *
  * @returns A new string with the strings and interpolations from the template applied.
  */
-declare function interpolate(strings: TemplateStringsArray, ...interpolations: unknown[]): string;
+declare function interpolate<const InterpolationsType extends readonly unknown[]>(strings: TemplateStringsArray, ...interpolations: InterpolationsType): string;
 //#endregion
 //#region src/functions/taggedTemplate/interpolateObjects.d.ts
 /**
@@ -1011,17 +1058,31 @@ declare function interpolate(strings: TemplateStringsArray, ...interpolations: u
  * You can pass a template string directly by doing:
  *
  * ```typescript
- * interpolateObjects`Template string here ${{ my: "object" }}`.
+ * interpolateObjects`Template string here ${{ my: "object" }}`;
  * ```
  *
  * @category Tagged Template
  *
+ * @template InterpolationsType - The type of the interpolations.
+ *
  * @param strings - The strings from the template to process.
  * @param interpolations - An array of all interpolations from the template.
  *
  * @returns A new string with the strings and interpolations from the template applied, with objects stringified.
  */
-declare function interpolateObjects(strings: TemplateStringsArray, ...interpolations: unknown[]): string;
+declare function interpolateObjects<const InterpolationsType extends readonly unknown[]>(strings: TemplateStringsArray, ...interpolations: InterpolationsType): string;
+//#endregion
+//#region src/functions/taggedTemplate/isTemplateStringsArray.d.ts
+/**
+ * Determines whether or not the input is a valid `TemplateStringsArray`.
+ *
+ * @category Tagged Template
+ *
+ * @param input - The input to check
+ *
+ * @returns `true` if the input is a valid `TemplateStringsArray`, and false otherwise. The type of the input will also be narrowed down to `TemplateStringsArray` if `true`.
+ */
+declare function isTemplateStringsArray(input: unknown): input is TemplateStringsArray;
 //#endregion
 //#region src/functions/taggedTemplate/normaliseIndents.d.ts
 /**
@@ -1054,10 +1115,10 @@ declare function normaliseIndents(options: NormaliseIndentsOptions): NormaliseIn
  * ```typescript
  * normaliseIndents`Template string here
  *     with a new line
- *     and another new line`.
+ *     and another new line`;
  * ```
  *
- *@category Tagged Template
+ * @template InterpolationsType - The type of the interpolations.
  *
  * @param strings - The strings from the template to process.
  * @param interpolations - An array of all interpolations from the template.
@@ -1162,4 +1223,4 @@ interface ParseVersionOptions {
  */
 declare function parseVersion(input: string, options?: ParseVersionOptions): string;
 //#endregion
-export { APIError, ArrayElement, CallReturnType, CamelToKebabOptions, CreateEnumType, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DisallowUndefined, Env, FILE_PATH_REGEX, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, IncrementVersionOptions, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, OptionalOnCondition, ParallelTuple, ParseVersionOptions, PublicAndPrivateKey, RecordKey, RemoveUndefined, StringListToArrayOptions, VERSION_NUMBER_REGEX, VersionNumber, VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, determineVersionType, encryptWithKey, fillArray, formatDateAndTime, getIndividualVersionNumbers, getInterpolations, getPublicAndPrivateKey, getRandomNumber, getRecordKeys, httpErrorCodeLookup, incrementVersion, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normaliseIndents, normalizeImportPath, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFilePath, parseFormData, parseIntStrict, parseVersion, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, stringListToArray, stringifyDotenv, truncate, wait };
+export { APIError, ArrayElement, CallReturnType, CamelToKebabOptions, CreateEnumType, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DisallowUndefined, Env, FILE_PATH_REGEX, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, IncrementVersionOptions, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, OptionalOnCondition, ParallelTuple, ParseVersionOptions, PublicAndPrivateKey, RecordKey, RemoveUndefined, StringListToArrayOptions, VERSION_NUMBER_REGEX, VersionNumber, VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, determineVersionType, encryptWithKey, fillArray, formatDateAndTime, getIndividualVersionNumbers, getInterpolations, getPublicAndPrivateKey, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, incrementVersion, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseImportPath, normaliseIndents, normalizeImportPath, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFilePath, parseFormData, parseIntStrict, parseVersion, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, stringListToArray, stringifyDotenv, truncate, wait };

package/dist/index.d.ts

@@ -498,6 +498,16 @@ declare function getRandomNumber(lowerBound: number, upperBound: number): number
  */
 declare function isOrdered(array: readonly number[]): boolean;
 //#endregion
+//#region src/functions/miscellaneous/sayHello.d.ts
+/**
+ * Returns a string representing the lyrics to the package's theme song, Commit To You
+ *
+ * [Pls listen!](https://www.youtube.com/watch?v=mH-Sg-8EnxM)
+ *
+ * @returns The lyrics string in markdown format.
+ */
+declare function sayHello(): string;
+//#endregion
 //#region src/functions/miscellaneous/stringifyDotenv.d.ts
 type QuoteStyle = "double" | "single" | "none";
 interface StringifyDotenvOptions {
@@ -967,6 +977,7 @@ declare function createTemplateStringsArray(strings: readonly string[]): Templat
 //#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:
  *
@@ -976,6 +987,8 @@ declare function createTemplateStringsArray(strings: readonly string[]): Templat
  *
  * @category Tagged Template
  *
+ * @deprecated Please use `getStringsAndInterpolations` instead.
+ *
  * @param strings - The strings from the template to process.
  * @param interpolations - An array of all interpolations from the template.
  *
@@ -983,6 +996,38 @@ declare function createTemplateStringsArray(strings: readonly string[]): Templat
  */
 declare function getInterpolations(strings: TemplateStringsArray, ...interpolations: unknown[]): [TemplateStringsArray, unknown[]];
 //#endregion
+//#region src/functions/taggedTemplate/getStringsAndInterpolations.d.ts
+/**
+ *
+ * Gets the strings and interpolations separately from a template string.
+ * You can pass a template string directly by doing:
+ *
+ * ```typescript
+ * getStringsAndInterpolations`Template string here`;
+ * ```
+ *
+ * @category Tagged Template
+ *
+ * @template InterpolationsType - The type of the interpolations.
+ *
+ * @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 remaining items are the interpolations.
+ *
+ * The return of this function may also be spread into any other tagged template function in the following way:
+ *
+ * ```typescript
+ * import { interpolate } from "@alextheman/utility"; // Example function
+ *
+ * const packageName = "@alextheman/utility";
+ * const packageManager = getPackageManager(packageName);
+ *
+ * interpolate(...getStringsAndInterpolations`The package ${packageName} uses the ${packageManager} package manager.`);
+ * ```
+ */
+declare function getStringsAndInterpolations<const InterpolationsType extends readonly unknown[]>(strings: TemplateStringsArray, ...interpolations: InterpolationsType): [TemplateStringsArray, ...InterpolationsType];
+//#endregion
 //#region src/functions/taggedTemplate/interpolate.d.ts
 /**
  * Returns the result of interpolating a template string when given the strings and interpolations separately.
@@ -997,12 +1042,14 @@ declare function getInterpolations(strings: TemplateStringsArray, ...interpolati
  *
  * @category Tagged Template
  *
+ * @template InterpolationsType - The type of the interpolations.
+ *
  * @param strings - The strings from the template to process.
  * @param interpolations - An array of all interpolations from the template.
  *
  * @returns A new string with the strings and interpolations from the template applied.
  */
-declare function interpolate(strings: TemplateStringsArray, ...interpolations: unknown[]): string;
+declare function interpolate<const InterpolationsType extends readonly unknown[]>(strings: TemplateStringsArray, ...interpolations: InterpolationsType): string;
 //#endregion
 //#region src/functions/taggedTemplate/interpolateObjects.d.ts
 /**
@@ -1011,17 +1058,31 @@ declare function interpolate(strings: TemplateStringsArray, ...interpolations: u
  * You can pass a template string directly by doing:
  *
  * ```typescript
- * interpolateObjects`Template string here ${{ my: "object" }}`.
+ * interpolateObjects`Template string here ${{ my: "object" }}`;
  * ```
  *
  * @category Tagged Template
  *
+ * @template InterpolationsType - The type of the interpolations.
+ *
  * @param strings - The strings from the template to process.
  * @param interpolations - An array of all interpolations from the template.
  *
  * @returns A new string with the strings and interpolations from the template applied, with objects stringified.
  */
-declare function interpolateObjects(strings: TemplateStringsArray, ...interpolations: unknown[]): string;
+declare function interpolateObjects<const InterpolationsType extends readonly unknown[]>(strings: TemplateStringsArray, ...interpolations: InterpolationsType): string;
+//#endregion
+//#region src/functions/taggedTemplate/isTemplateStringsArray.d.ts
+/**
+ * Determines whether or not the input is a valid `TemplateStringsArray`.
+ *
+ * @category Tagged Template
+ *
+ * @param input - The input to check
+ *
+ * @returns `true` if the input is a valid `TemplateStringsArray`, and false otherwise. The type of the input will also be narrowed down to `TemplateStringsArray` if `true`.
+ */
+declare function isTemplateStringsArray(input: unknown): input is TemplateStringsArray;
 //#endregion
 //#region src/functions/taggedTemplate/normaliseIndents.d.ts
 /**
@@ -1054,10 +1115,10 @@ declare function normaliseIndents(options: NormaliseIndentsOptions): NormaliseIn
  * ```typescript
  * normaliseIndents`Template string here
  *     with a new line
- *     and another new line`.
+ *     and another new line`;
  * ```
  *
- *@category Tagged Template
+ * @template InterpolationsType - The type of the interpolations.
  *
  * @param strings - The strings from the template to process.
  * @param interpolations - An array of all interpolations from the template.
@@ -1162,4 +1223,4 @@ interface ParseVersionOptions {
  */
 declare function parseVersion(input: string, options?: ParseVersionOptions): string;
 //#endregion
-export { APIError, ArrayElement, CallReturnType, CamelToKebabOptions, CreateEnumType, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DisallowUndefined, Env, FILE_PATH_REGEX, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, type IncrementVersionOptions, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, OptionalOnCondition, ParallelTuple, type ParseVersionOptions, type PublicAndPrivateKey, RecordKey, RemoveUndefined, StringListToArrayOptions, VERSION_NUMBER_REGEX, VersionNumber, VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, determineVersionType, encryptWithKey, fillArray, formatDateAndTime, getIndividualVersionNumbers, getInterpolations, getPublicAndPrivateKey, getRandomNumber, getRecordKeys, httpErrorCodeLookup, incrementVersion, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normaliseIndents, normalizeImportPath, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFilePath, parseFormData, parseIntStrict, parseVersion, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, stringListToArray, stringifyDotenv, truncate, wait };
+export { APIError, ArrayElement, CallReturnType, CamelToKebabOptions, CreateEnumType, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DisallowUndefined, Env, FILE_PATH_REGEX, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, type IncrementVersionOptions, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, OptionalOnCondition, ParallelTuple, type ParseVersionOptions, type PublicAndPrivateKey, RecordKey, RemoveUndefined, StringListToArrayOptions, VERSION_NUMBER_REGEX, VersionNumber, VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, determineVersionType, encryptWithKey, fillArray, formatDateAndTime, getIndividualVersionNumbers, getInterpolations, getPublicAndPrivateKey, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, incrementVersion, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseImportPath, normaliseIndents, normalizeImportPath, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFilePath, parseFormData, parseIntStrict, parseVersion, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, stringListToArray, stringifyDotenv, truncate, wait };