@alextheman/utility 4.9.0 → 4.10.0

package/dist/index.cjs

@@ -830,6 +830,22 @@ function omitProperties(object, keysToOmit) {
 }
 var omitProperties_default = omitProperties;
 
+//#endregion
+//#region src/functions/objectHelpers/removeUndefinedFromObject.ts
+/**
+* Removes entries whose values are `undefined` from a given object (not including null etc.).
+*
+* @param object - The object to remove undefined entries from.
+*
+* @returns An object with a new reference in memory, with undefined entries removed.
+*/
+function removeUndefinedFromObject(object) {
+	return Object.fromEntries(Object.entries(object).filter(([_, value]) => {
+		return value !== void 0;
+	}));
+}
+var removeUndefinedFromObject_default = removeUndefinedFromObject;
+
 //#endregion
 //#region src/functions/parsers/parseBoolean.ts
 /**
@@ -1562,6 +1578,7 @@ exports.parseZodSchemaAsync = parseZodSchemaAsync_default;
 exports.randomiseArray = randomiseArray_default;
 exports.range = range_default;
 exports.removeDuplicates = removeDuplicates_default;
+exports.removeUndefinedFromObject = removeUndefinedFromObject_default;
 exports.stringListToArray = stringListToArray_default;
 exports.stringifyDotenv = stringifyDotenv_default;
 exports.truncate = truncate_default;

package/dist/index.d.cts

@@ -410,9 +410,9 @@ type FormDataArrayResolutionStrategy = "stringify" | "multiple";
  *
  * @template Key - The type of the key of the input record.
  */
-interface CreateFormDataOptionsBase<Key extends RecordKey> {
+interface CreateFormDataOptionsBase<Key$1 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>>;
+  arrayResolution?: FormDataArrayResolutionStrategy | Partial<Record<Key$1, FormDataArrayResolutionStrategy>>;
 }
 /**
  * Options for resolving form data when it may be undefined or null, but not both.
@@ -421,11 +421,11 @@ interface CreateFormDataOptionsBase<Key extends RecordKey> {
  *
  * @template Key - The type of the key of the input record.
  */
-interface CreateFormDataOptionsUndefinedOrNullResolution<Key extends RecordKey> extends CreateFormDataOptionsBase<Key> {
+interface CreateFormDataOptionsUndefinedOrNullResolution<Key$1 extends RecordKey> extends CreateFormDataOptionsBase<Key$1> {
   /** How to resolve undefined data (May either stringify to 'undefined', resolve to an empty string, or omit entirely). */
-  undefinedResolution?: FormDataNullableResolutionStrategy | Partial<Record<Key, FormDataNullableResolutionStrategy>>;
+  undefinedResolution?: FormDataNullableResolutionStrategy | Partial<Record<Key$1, FormDataNullableResolutionStrategy>>;
   /** How to resolve null data (May either stringify to 'null', resolve to an empty string, or omit entirely). */
-  nullResolution?: FormDataNullableResolutionStrategy | Partial<Record<Key, FormDataNullableResolutionStrategy>>;
+  nullResolution?: FormDataNullableResolutionStrategy | Partial<Record<Key$1, FormDataNullableResolutionStrategy>>;
   /** @note This must not be provided at the same time as undefinedResolution and/or nullResolution. */
   nullableResolution?: never;
 }
@@ -436,13 +436,13 @@ interface CreateFormDataOptionsUndefinedOrNullResolution<Key extends RecordKey>
  *
  * @template Key - The type of the key of the input record.
  */
-interface CreateFormDataOptionsNullableResolution<Key extends RecordKey> extends CreateFormDataOptionsBase<Key> {
+interface CreateFormDataOptionsNullableResolution<Key$1 extends RecordKey> extends CreateFormDataOptionsBase<Key$1> {
   /** @note This must not be provided at the same time as nullableResolution. */
   undefinedResolution?: never;
   /** @note This must not be provided at the same time as nullableResolution. */
   nullResolution?: never;
   /** 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>>;
+  nullableResolution: FormDataNullableResolutionStrategy | Partial<Record<Key$1, FormDataNullableResolutionStrategy>>;
 }
 /**
  * Options for resolving form data.
@@ -451,7 +451,7 @@ interface CreateFormDataOptionsNullableResolution<Key extends RecordKey> extends
  *
  * @template Key - The type of the key of the input record.
  */
-type CreateFormDataOptions<Key extends RecordKey> = CreateFormDataOptionsUndefinedOrNullResolution<Key> | CreateFormDataOptionsNullableResolution<Key>;
+type CreateFormDataOptions<Key$1 extends RecordKey> = CreateFormDataOptionsUndefinedOrNullResolution<Key$1> | CreateFormDataOptionsNullableResolution<Key$1>;
 /**
  * Creates FormData from a given object, resolving non-string types as appropriate.
  *
@@ -578,6 +578,17 @@ declare function getRecordKeys<InputRecordType extends Record<RecordKey, unknown
  */
 declare function omitProperties<ObjectType extends Record<string, unknown> | Readonly<Record<string, unknown>>, KeysToOmit extends keyof ObjectType>(object: ObjectType, keysToOmit: KeysToOmit | readonly KeysToOmit[]): Omit<ObjectType, KeysToOmit>;
 //#endregion
+//#region src/functions/objectHelpers/removeUndefinedFromObject.d.ts
+type RemoveUndefined<RecordType extends Record<RecordKey, unknown>> = { [Key in keyof RecordType]: Exclude<RecordType[Key], undefined> };
+/**
+ * Removes entries whose values are `undefined` from a given object (not including null etc.).
+ *
+ * @param object - The object to remove undefined entries from.
+ *
+ * @returns An object with a new reference in memory, with undefined entries removed.
+ */
+declare function removeUndefinedFromObject<RecordType extends Record<RecordKey, unknown>>(object: RecordType): RemoveUndefined<RecordType>;
+//#endregion
 //#region src/functions/parsers/parseBoolean.d.ts
 /**
  * Takes a stringly-typed boolean and converts it to an actual boolean type.
@@ -1072,4 +1083,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, encryptWithKey, 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, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, stringListToArray, stringifyDotenv, 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, RemoveUndefined, StringListToArrayOptions, VERSION_NUMBER_REGEX, VersionNumber, VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, determineVersionType, encryptWithKey, 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, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, stringListToArray, stringifyDotenv, truncate, wait };

package/dist/index.d.ts

@@ -410,9 +410,9 @@ type FormDataArrayResolutionStrategy = "stringify" | "multiple";
  *
  * @template Key - The type of the key of the input record.
  */
-interface CreateFormDataOptionsBase<Key extends RecordKey> {
+interface CreateFormDataOptionsBase<Key$1 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>>;
+  arrayResolution?: FormDataArrayResolutionStrategy | Partial<Record<Key$1, FormDataArrayResolutionStrategy>>;
 }
 /**
  * Options for resolving form data when it may be undefined or null, but not both.
@@ -421,11 +421,11 @@ interface CreateFormDataOptionsBase<Key extends RecordKey> {
  *
  * @template Key - The type of the key of the input record.
  */
-interface CreateFormDataOptionsUndefinedOrNullResolution<Key extends RecordKey> extends CreateFormDataOptionsBase<Key> {
+interface CreateFormDataOptionsUndefinedOrNullResolution<Key$1 extends RecordKey> extends CreateFormDataOptionsBase<Key$1> {
   /** How to resolve undefined data (May either stringify to 'undefined', resolve to an empty string, or omit entirely). */
-  undefinedResolution?: FormDataNullableResolutionStrategy | Partial<Record<Key, FormDataNullableResolutionStrategy>>;
+  undefinedResolution?: FormDataNullableResolutionStrategy | Partial<Record<Key$1, FormDataNullableResolutionStrategy>>;
   /** How to resolve null data (May either stringify to 'null', resolve to an empty string, or omit entirely). */
-  nullResolution?: FormDataNullableResolutionStrategy | Partial<Record<Key, FormDataNullableResolutionStrategy>>;
+  nullResolution?: FormDataNullableResolutionStrategy | Partial<Record<Key$1, FormDataNullableResolutionStrategy>>;
   /** @note This must not be provided at the same time as undefinedResolution and/or nullResolution. */
   nullableResolution?: never;
 }
@@ -436,13 +436,13 @@ interface CreateFormDataOptionsUndefinedOrNullResolution<Key extends RecordKey>
  *
  * @template Key - The type of the key of the input record.
  */
-interface CreateFormDataOptionsNullableResolution<Key extends RecordKey> extends CreateFormDataOptionsBase<Key> {
+interface CreateFormDataOptionsNullableResolution<Key$1 extends RecordKey> extends CreateFormDataOptionsBase<Key$1> {
   /** @note This must not be provided at the same time as nullableResolution. */
   undefinedResolution?: never;
   /** @note This must not be provided at the same time as nullableResolution. */
   nullResolution?: never;
   /** 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>>;
+  nullableResolution: FormDataNullableResolutionStrategy | Partial<Record<Key$1, FormDataNullableResolutionStrategy>>;
 }
 /**
  * Options for resolving form data.
@@ -451,7 +451,7 @@ interface CreateFormDataOptionsNullableResolution<Key extends RecordKey> extends
  *
  * @template Key - The type of the key of the input record.
  */
-type CreateFormDataOptions<Key extends RecordKey> = CreateFormDataOptionsUndefinedOrNullResolution<Key> | CreateFormDataOptionsNullableResolution<Key>;
+type CreateFormDataOptions<Key$1 extends RecordKey> = CreateFormDataOptionsUndefinedOrNullResolution<Key$1> | CreateFormDataOptionsNullableResolution<Key$1>;
 /**
  * Creates FormData from a given object, resolving non-string types as appropriate.
  *
@@ -578,6 +578,17 @@ declare function getRecordKeys<InputRecordType extends Record<RecordKey, unknown
  */
 declare function omitProperties<ObjectType extends Record<string, unknown> | Readonly<Record<string, unknown>>, KeysToOmit extends keyof ObjectType>(object: ObjectType, keysToOmit: KeysToOmit | readonly KeysToOmit[]): Omit<ObjectType, KeysToOmit>;
 //#endregion
+//#region src/functions/objectHelpers/removeUndefinedFromObject.d.ts
+type RemoveUndefined<RecordType extends Record<RecordKey, unknown>> = { [Key in keyof RecordType]: Exclude<RecordType[Key], undefined> };
+/**
+ * Removes entries whose values are `undefined` from a given object (not including null etc.).
+ *
+ * @param object - The object to remove undefined entries from.
+ *
+ * @returns An object with a new reference in memory, with undefined entries removed.
+ */
+declare function removeUndefinedFromObject<RecordType extends Record<RecordKey, unknown>>(object: RecordType): RemoveUndefined<RecordType>;
+//#endregion
 //#region src/functions/parsers/parseBoolean.d.ts
 /**
  * Takes a stringly-typed boolean and converts it to an actual boolean type.
@@ -1072,4 +1083,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, encryptWithKey, 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, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, stringListToArray, stringifyDotenv, 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, RemoveUndefined, StringListToArrayOptions, VERSION_NUMBER_REGEX, VersionNumber, VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, determineVersionType, encryptWithKey, 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, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, stringListToArray, stringifyDotenv, truncate, wait };

package/dist/index.js

@@ -800,6 +800,22 @@ function omitProperties(object, keysToOmit) {
 }
 var omitProperties_default = omitProperties;
 
+//#endregion
+//#region src/functions/objectHelpers/removeUndefinedFromObject.ts
+/**
+* Removes entries whose values are `undefined` from a given object (not including null etc.).
+*
+* @param object - The object to remove undefined entries from.
+*
+* @returns An object with a new reference in memory, with undefined entries removed.
+*/
+function removeUndefinedFromObject(object) {
+	return Object.fromEntries(Object.entries(object).filter(([_, value]) => {
+		return value !== void 0;
+	}));
+}
+var removeUndefinedFromObject_default = removeUndefinedFromObject;
+
 //#endregion
 //#region src/functions/parsers/parseBoolean.ts
 /**
@@ -1482,4 +1498,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, encryptWithKey_default as encryptWithKey, 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, parseZodSchemaAsync_default as parseZodSchemaAsync, randomiseArray_default as randomiseArray, range_default as range, removeDuplicates_default as removeDuplicates, stringListToArray_default as stringListToArray, stringifyDotenv_default as stringifyDotenv, 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, encryptWithKey_default as encryptWithKey, 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, parseZodSchemaAsync_default as parseZodSchemaAsync, randomiseArray_default as randomiseArray, range_default as range, removeDuplicates_default as removeDuplicates, removeUndefinedFromObject_default as removeUndefinedFromObject, stringListToArray_default as stringListToArray, stringifyDotenv_default as stringifyDotenv, truncate_default as truncate, wait_default as wait };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alextheman/utility",
-  "version": "4.9.0",
+  "version": "4.10.0",
   "description": "Helpful utility functions.",
   "repository": {
     "type": "git",