@alextheman/utility 5.21.1 → 5.23.0

package/dist/index.cjs

@@ -1110,6 +1110,27 @@ function omitProperties(object, keysToOmit) {
 	return outputObject;
 }
 //#endregion
+//#region src/root/functions/objectHelpers/pickProperties.ts
+/**
+* Picks properties from a given object.
+*
+* @category Object Helpers
+*
+* @template ObjectType - The type of the input object.
+* @template KeysToPick - A type representing the keys to pick from the object.
+*
+* @param object - The object to pick properties from.
+* @param keysToPick - The keys to pick from the object. Can either be a single string to pick one, or an array to pick multiple.
+*
+* @returns An object with a new reference in memory, with the chosen properties present.
+*/
+function pickProperties(object, keysToPick) {
+	const keysArray = Array.isArray(keysToPick) ? keysToPick : [keysToPick];
+	const outputObject = {};
+	for (const key of keysArray) outputObject[key] = object[key];
+	return outputObject;
+}
+//#endregion
 //#region src/root/functions/objectHelpers/removeUndefinedFromObject.ts
 /**
 * Removes entries whose values are `undefined` from a given object (not including null etc.).
@@ -1611,6 +1632,18 @@ function camelToKebab(string, options = { preserveConsecutiveCapitals: true }) {
 	return result;
 }
 //#endregion
+//#region src/root/functions/stringHelpers/escapeHTML.ts
+/**
+* Escapes a raw HTML string so it can be safely used in HTML templates.
+*
+* @param rawString - The raw string to escape
+*
+* @returns A new string, with the contents of the original string but with HTML characters safely encoded.
+*/
+function escapeHTML(rawString) {
+	return rawString.replaceAll(/&/g, "&amp;").replaceAll(/</g, "&lt;").replaceAll(/>/g, "&gt;").replaceAll(/"/g, "&quot;").replaceAll(/'/g, "&#39;");
+}
+//#endregion
 //#region src/root/functions/stringHelpers/escapeRegexPattern.ts
 /**
 * A function to properly handle escape sequences in a Regex pattern string, so it can be safely used with the `RegExp` constructor.
@@ -2034,6 +2067,7 @@ exports.createFormData = createFormData;
 exports.createTemplateStringsArray = createTemplateStringsArray;
 exports.deepCopy = deepCopy;
 exports.deepFreeze = deepFreeze;
+exports.escapeHTML = escapeHTML;
 exports.escapeRegexPattern = escapeRegexPattern;
 exports.fillArray = fillArray;
 exports.formatDateAndTime = formatDateAndTime;
@@ -2065,6 +2099,7 @@ exports.parseUUID = parseUUID;
 exports.parseVersionType = parseVersionType;
 exports.parseZodSchema = parseZodSchema;
 exports.parseZodSchemaAsync = parseZodSchemaAsync;
+exports.pickProperties = pickProperties;
 exports.randomiseArray = randomiseArray;
 exports.range = range;
 exports.removeDuplicates = removeDuplicates;

package/dist/index.d.cts

@@ -732,6 +732,22 @@ declare function getRecordKeys<InputRecordType extends Record<PropertyKey, unkno
  */
 declare function omitProperties<ObjectType extends object, KeysToOmit extends keyof ObjectType>(object: ObjectType, keysToOmit: KeysToOmit | ReadonlyArray<KeysToOmit>): Omit<ObjectType, KeysToOmit>;
 //#endregion
+//#region src/root/functions/objectHelpers/pickProperties.d.ts
+/**
+ * Picks properties from a given object.
+ *
+ * @category Object Helpers
+ *
+ * @template ObjectType - The type of the input object.
+ * @template KeysToPick - A type representing the keys to pick from the object.
+ *
+ * @param object - The object to pick properties from.
+ * @param keysToPick - The keys to pick from the object. Can either be a single string to pick one, or an array to pick multiple.
+ *
+ * @returns An object with a new reference in memory, with the chosen properties present.
+ */
+declare function pickProperties<ObjectType extends object, KeysToPick extends keyof ObjectType>(object: ObjectType, keysToPick: KeysToPick | ReadonlyArray<KeysToPick>): Pick<ObjectType, KeysToPick>;
+//#endregion
 //#region src/root/functions/objectHelpers/removeUndefinedFromObject.d.ts
 type RemoveUndefined<RecordType extends Record<PropertyKey, unknown>> = { [Key in keyof RecordType]: Exclude<RecordType[Key], undefined> };
 /**
@@ -924,6 +940,16 @@ interface CamelToKebabOptions {
  */
 declare function camelToKebab(string: string, options?: CamelToKebabOptions): string;
 //#endregion
+//#region src/root/functions/stringHelpers/escapeHTML.d.ts
+/**
+ * Escapes a raw HTML string so it can be safely used in HTML templates.
+ *
+ * @param rawString - The raw string to escape
+ *
+ * @returns A new string, with the contents of the original string but with HTML characters safely encoded.
+ */
+declare function escapeHTML(rawString: string): string;
+//#endregion
 //#region src/root/functions/stringHelpers/escapeRegexPattern.d.ts
 /**
  * A function to properly handle escape sequences in a Regex pattern string, so it can be safely used with the `RegExp` constructor.
@@ -1457,4 +1483,4 @@ interface ZodParsingErrorData {
   issues: Array<z.core.$ZodIssue>;
 }
 //#endregion
-export { APIError, type ArrayElement, type CallReturnType, type CamelToKebabOptions, type CreateEnumType, type CreateFormDataOptions, type CreateFormDataOptionsNullableResolution, type CreateFormDataOptionsUndefinedOrNullResolution, DataError, type DisallowUndefined, Env, FILE_PATH_PATTERN, FILE_PATH_REGEX, type FormDataArrayResolutionStrategy, type FormDataNullableResolutionStrategy, type HTTPErrorCode, type IgnoreCase, type IsTypeArgumentString, type KebabToCamelOptions, type NonNull, type NonUndefined, type NormaliseIndentsFunction, type NormaliseIndentsOptions, type NormalizeIndentsFunction, type NormalizeIndentsOptions, type NullableOnCondition, ONE_DAY_IN_MILLISECONDS, type OptionalOnCondition, type ParallelTuple, type RecordKey, type RemoveUndefined, SortDirection, type StringListToArrayOptions, type ToTitleCaseOptions, UUID_PATTERN, UUID_REGEX, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VersionNumber, type FormatOptionsBase as VersionNumberToStringOptions, VersionType, type ZodParsingErrorData, addDaysToDate, appendSemicolon, assertNotNull, assertNotNullable, assertNotUndefined, az, calculateMonthlyDifference, camelToKebab, containsKeys, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, escapeRegexPattern, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, identity, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isNonNullableObject, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, objectContainsKeys, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, sortBy, stringListToArray, stringifyDotenv, toTitleCase, truncate, wait, zodVersionNumber };
+export { APIError, type ArrayElement, type CallReturnType, type CamelToKebabOptions, type CreateEnumType, type CreateFormDataOptions, type CreateFormDataOptionsNullableResolution, type CreateFormDataOptionsUndefinedOrNullResolution, DataError, type DisallowUndefined, Env, FILE_PATH_PATTERN, FILE_PATH_REGEX, type FormDataArrayResolutionStrategy, type FormDataNullableResolutionStrategy, type HTTPErrorCode, type IgnoreCase, type IsTypeArgumentString, type KebabToCamelOptions, type NonNull, type NonUndefined, type NormaliseIndentsFunction, type NormaliseIndentsOptions, type NormalizeIndentsFunction, type NormalizeIndentsOptions, type NullableOnCondition, ONE_DAY_IN_MILLISECONDS, type OptionalOnCondition, type ParallelTuple, type RecordKey, type RemoveUndefined, SortDirection, type StringListToArrayOptions, type ToTitleCaseOptions, UUID_PATTERN, UUID_REGEX, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VersionNumber, type FormatOptionsBase as VersionNumberToStringOptions, VersionType, type ZodParsingErrorData, addDaysToDate, appendSemicolon, assertNotNull, assertNotNullable, assertNotUndefined, az, calculateMonthlyDifference, camelToKebab, containsKeys, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, escapeHTML, escapeRegexPattern, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, identity, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isNonNullableObject, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, objectContainsKeys, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersionType, parseZodSchema, parseZodSchemaAsync, pickProperties, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, sortBy, stringListToArray, stringifyDotenv, toTitleCase, truncate, wait, zodVersionNumber };

package/dist/index.d.ts

@@ -732,6 +732,22 @@ declare function getRecordKeys<InputRecordType extends Record<PropertyKey, unkno
  */
 declare function omitProperties<ObjectType extends object, KeysToOmit extends keyof ObjectType>(object: ObjectType, keysToOmit: KeysToOmit | ReadonlyArray<KeysToOmit>): Omit<ObjectType, KeysToOmit>;
 //#endregion
+//#region src/root/functions/objectHelpers/pickProperties.d.ts
+/**
+ * Picks properties from a given object.
+ *
+ * @category Object Helpers
+ *
+ * @template ObjectType - The type of the input object.
+ * @template KeysToPick - A type representing the keys to pick from the object.
+ *
+ * @param object - The object to pick properties from.
+ * @param keysToPick - The keys to pick from the object. Can either be a single string to pick one, or an array to pick multiple.
+ *
+ * @returns An object with a new reference in memory, with the chosen properties present.
+ */
+declare function pickProperties<ObjectType extends object, KeysToPick extends keyof ObjectType>(object: ObjectType, keysToPick: KeysToPick | ReadonlyArray<KeysToPick>): Pick<ObjectType, KeysToPick>;
+//#endregion
 //#region src/root/functions/objectHelpers/removeUndefinedFromObject.d.ts
 type RemoveUndefined<RecordType extends Record<PropertyKey, unknown>> = { [Key in keyof RecordType]: Exclude<RecordType[Key], undefined> };
 /**
@@ -924,6 +940,16 @@ interface CamelToKebabOptions {
  */
 declare function camelToKebab(string: string, options?: CamelToKebabOptions): string;
 //#endregion
+//#region src/root/functions/stringHelpers/escapeHTML.d.ts
+/**
+ * Escapes a raw HTML string so it can be safely used in HTML templates.
+ *
+ * @param rawString - The raw string to escape
+ *
+ * @returns A new string, with the contents of the original string but with HTML characters safely encoded.
+ */
+declare function escapeHTML(rawString: string): string;
+//#endregion
 //#region src/root/functions/stringHelpers/escapeRegexPattern.d.ts
 /**
  * A function to properly handle escape sequences in a Regex pattern string, so it can be safely used with the `RegExp` constructor.
@@ -1457,4 +1483,4 @@ interface ZodParsingErrorData {
   issues: Array<z$1.core.$ZodIssue>;
 }
 //#endregion
-export { APIError, type ArrayElement, type CallReturnType, type CamelToKebabOptions, type CreateEnumType, type CreateFormDataOptions, type CreateFormDataOptionsNullableResolution, type CreateFormDataOptionsUndefinedOrNullResolution, DataError, type DisallowUndefined, Env, FILE_PATH_PATTERN, FILE_PATH_REGEX, type FormDataArrayResolutionStrategy, type FormDataNullableResolutionStrategy, type HTTPErrorCode, type IgnoreCase, type IsTypeArgumentString, type KebabToCamelOptions, type NonNull, type NonUndefined, type NormaliseIndentsFunction, type NormaliseIndentsOptions, type NormalizeIndentsFunction, type NormalizeIndentsOptions, type NullableOnCondition, ONE_DAY_IN_MILLISECONDS, type OptionalOnCondition, type ParallelTuple, type RecordKey, type RemoveUndefined, SortDirection, type StringListToArrayOptions, type ToTitleCaseOptions, UUID_PATTERN, UUID_REGEX, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VersionNumber, type FormatOptionsBase as VersionNumberToStringOptions, VersionType, type ZodParsingErrorData, addDaysToDate, appendSemicolon, assertNotNull, assertNotNullable, assertNotUndefined, az, calculateMonthlyDifference, camelToKebab, containsKeys, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, escapeRegexPattern, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, identity, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isNonNullableObject, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, objectContainsKeys, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, sortBy, stringListToArray, stringifyDotenv, toTitleCase, truncate, wait, zodVersionNumber };
+export { APIError, type ArrayElement, type CallReturnType, type CamelToKebabOptions, type CreateEnumType, type CreateFormDataOptions, type CreateFormDataOptionsNullableResolution, type CreateFormDataOptionsUndefinedOrNullResolution, DataError, type DisallowUndefined, Env, FILE_PATH_PATTERN, FILE_PATH_REGEX, type FormDataArrayResolutionStrategy, type FormDataNullableResolutionStrategy, type HTTPErrorCode, type IgnoreCase, type IsTypeArgumentString, type KebabToCamelOptions, type NonNull, type NonUndefined, type NormaliseIndentsFunction, type NormaliseIndentsOptions, type NormalizeIndentsFunction, type NormalizeIndentsOptions, type NullableOnCondition, ONE_DAY_IN_MILLISECONDS, type OptionalOnCondition, type ParallelTuple, type RecordKey, type RemoveUndefined, SortDirection, type StringListToArrayOptions, type ToTitleCaseOptions, UUID_PATTERN, UUID_REGEX, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VersionNumber, type FormatOptionsBase as VersionNumberToStringOptions, VersionType, type ZodParsingErrorData, addDaysToDate, appendSemicolon, assertNotNull, assertNotNullable, assertNotUndefined, az, calculateMonthlyDifference, camelToKebab, containsKeys, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, escapeHTML, escapeRegexPattern, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, identity, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isNonNullableObject, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, objectContainsKeys, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersionType, parseZodSchema, parseZodSchemaAsync, pickProperties, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, sortBy, stringListToArray, stringifyDotenv, toTitleCase, truncate, wait, zodVersionNumber };

package/dist/index.js

@@ -1086,6 +1086,27 @@ function omitProperties(object, keysToOmit) {
 	return outputObject;
 }
 //#endregion
+//#region src/root/functions/objectHelpers/pickProperties.ts
+/**
+* Picks properties from a given object.
+*
+* @category Object Helpers
+*
+* @template ObjectType - The type of the input object.
+* @template KeysToPick - A type representing the keys to pick from the object.
+*
+* @param object - The object to pick properties from.
+* @param keysToPick - The keys to pick from the object. Can either be a single string to pick one, or an array to pick multiple.
+*
+* @returns An object with a new reference in memory, with the chosen properties present.
+*/
+function pickProperties(object, keysToPick) {
+	const keysArray = Array.isArray(keysToPick) ? keysToPick : [keysToPick];
+	const outputObject = {};
+	for (const key of keysArray) outputObject[key] = object[key];
+	return outputObject;
+}
+//#endregion
 //#region src/root/functions/objectHelpers/removeUndefinedFromObject.ts
 /**
 * Removes entries whose values are `undefined` from a given object (not including null etc.).
@@ -1587,6 +1608,18 @@ function camelToKebab(string, options = { preserveConsecutiveCapitals: true }) {
 	return result;
 }
 //#endregion
+//#region src/root/functions/stringHelpers/escapeHTML.ts
+/**
+* Escapes a raw HTML string so it can be safely used in HTML templates.
+*
+* @param rawString - The raw string to escape
+*
+* @returns A new string, with the contents of the original string but with HTML characters safely encoded.
+*/
+function escapeHTML(rawString) {
+	return rawString.replaceAll(/&/g, "&amp;").replaceAll(/</g, "&lt;").replaceAll(/>/g, "&gt;").replaceAll(/"/g, "&quot;").replaceAll(/'/g, "&#39;");
+}
+//#endregion
 //#region src/root/functions/stringHelpers/escapeRegexPattern.ts
 /**
 * A function to properly handle escape sequences in a Regex pattern string, so it can be safely used with the `RegExp` constructor.
@@ -1983,4 +2016,4 @@ var DataError = class DataError extends Error {
 	}
 };
 //#endregion
-export { APIError, DataError, Env, FILE_PATH_PATTERN, FILE_PATH_REGEX, ONE_DAY_IN_MILLISECONDS, SortDirection, UUID_PATTERN, UUID_REGEX, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VersionNumber, VersionType, addDaysToDate, appendSemicolon, assertNotNull, assertNotNullable, assertNotUndefined, az, calculateMonthlyDifference, camelToKebab, containsKeys, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, escapeRegexPattern, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, identity, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isNonNullableObject, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, objectContainsKeys, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, sortBy, stringListToArray, stringifyDotenv, toTitleCase, truncate, wait, zodVersionNumber };
+export { APIError, DataError, Env, FILE_PATH_PATTERN, FILE_PATH_REGEX, ONE_DAY_IN_MILLISECONDS, SortDirection, UUID_PATTERN, UUID_REGEX, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VersionNumber, VersionType, addDaysToDate, appendSemicolon, assertNotNull, assertNotNullable, assertNotUndefined, az, calculateMonthlyDifference, camelToKebab, containsKeys, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, escapeHTML, escapeRegexPattern, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, identity, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isNonNullableObject, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, objectContainsKeys, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersionType, parseZodSchema, parseZodSchemaAsync, pickProperties, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, sortBy, stringListToArray, stringifyDotenv, toTitleCase, truncate, wait, zodVersionNumber };

package/package.json

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