@h3ravel/support 0.3.0 → 0.4.0

package/dist/index.d.cts

@@ -46,7 +46,7 @@ type KeysToSnakeCase<T> = {
  * @param size - Size of each chunk (default: 2)
  * @returns An array of chunks (arrays)
  */
-declare const chunk: <T>(arr: T[], size?: number) => T[][];
+declare const chunk: <T>(arr: T[], size?: number) => T[][]
 /**
  * Generates an array of sequential numbers.
  *
@@ -54,7 +54,7 @@ declare const chunk: <T>(arr: T[], size?: number) => T[][];
  * @param startAt - Starting number (default: 0)
  * @returns An array of numbers from startAt to startAt + size - 1
  */
-declare const range: (size: number, startAt?: number) => number[];
+declare const range: (size: number, startAt?: number) => number[]
 
 /**
  * Abbreviates large numbers using SI symbols (K, M, B...)
@@ -64,7 +64,7 @@ declare const range: (size: number, startAt?: number) => number[];
  * @param locale - Optional locale string (default: "en-US")
  * @returns A localized, abbreviated number string
  */
-declare const abbreviate: (value?: number, locale?: string) => string;
+declare const abbreviate: (value?: number, locale?: string) => string
 /**
  * Concverts a number into human readable string
  *
@@ -72,7 +72,7 @@ declare const abbreviate: (value?: number, locale?: string) => string;
  * @param slugify convert the ouput into a slug using this as a separator
  * @returns
  */
-declare const humanize: (num: number, slugify?: "-" | "_") => string;
+declare const humanize: (num: number, slugify?: '-' | '_') => string
 /**
  * Converts a number of bytes into a human-readable string.
  *
@@ -82,7 +82,7 @@ declare const humanize: (num: number, slugify?: "-" | "_") => string;
  *               otherwise uses 1024-based binary units (Bytes, KiB...)
  * @returns A formatted string with the appropriate unit
  */
-declare const toBytes: (bytes?: number, decimals?: number, bits?: boolean) => string;
+declare const toBytes: (bytes?: number, decimals?: number, bits?: boolean) => string
 /**
  * Formats a duration (in seconds) into a human-readable string.
  *
@@ -91,7 +91,7 @@ declare const toBytes: (bytes?: number, decimals?: number, bits?: boolean) => st
  *                 otherwise HH:MM:SS (e.g., "01:02:03")
  * @returns A formatted time string
  */
-declare const toHumanTime: (seconds?: number, worded?: boolean) => string;
+declare const toHumanTime: (seconds?: number, worded?: boolean) => string
 
 /**
  * Flattens a nested object into a single-level object
@@ -114,7 +114,7 @@ declare const toHumanTime: (seconds?: number, worded?: boolean) => string;
  * @param obj - The nested object to flatten
  * @returns A flattened object with dotted keys and inferred types
  */
-declare const dot: <T extends Record<string, any>>(obj: T) => DotFlatten<T>;
+declare const dot: <T extends Record<string, any>>(obj: T) => DotFlatten<T>
 /**
  * Extracts a subset of properties from an object.
  *
@@ -124,7 +124,7 @@ declare const dot: <T extends Record<string, any>>(obj: T) => DotFlatten<T>;
  * @param keys - Array of keys to extract
  * @returns A new object with only the specified keys
  */
-declare const extractProperties: <T extends object, K extends keyof T>(obj: T, keys?: readonly K[]) => Pick<T, K>;
+declare const extractProperties: <T extends object, K extends keyof T>(obj: T, keys?: readonly K[]) => Pick<T, K>
 /**
  * Safely retrieves a value from an object by key or nested keys.
  *
@@ -133,7 +133,7 @@ declare const extractProperties: <T extends object, K extends keyof T>(obj: T, k
  * @param item - The source object
  * @returns The found value as a string or the key itself if not found
  */
-declare const getValue: <T extends Record<string, any>>(key: string | [keyof T, keyof T[string]], item: T) => string;
+declare const getValue: <T extends Record<string, any>>(key: string | [keyof T, keyof T[string]], item: T) => string
 /**
  * Maps over an object's entries and returns a new object
  * with transformed keys and/or values.
@@ -144,7 +144,7 @@ declare const getValue: <T extends Record<string, any>>(key: string | [keyof T,
  * @param callback - Function that receives [key, value] and returns [newKey, newValue]
  * @returns A new object with transformed entries
  */
-declare const modObj: <T extends object, R>(obj: T, callback: (entry: [keyof T & string, T[keyof T]]) => [string, R]) => Record<string, R>;
+declare const modObj: <T extends object, R>(obj: T, callback: (entry: [keyof T & string, T[keyof T]]) => [string, R]) => Record<string, R>
 declare function safeDot<T extends Record<string, any>>(data: T): T;
 declare function safeDot<T extends Record<string, any>, K extends DotNestedKeys<T>>(data: T, key?: K): DotNestedValue<T, K>;
 /**
@@ -160,7 +160,7 @@ declare function safeDot<T extends Record<string, any>, K extends DotNestedKeys<
  * @param key - The dot-separated key (e.g., 'app.user.name').
  * @param value - The value to set at the specified path.
  */
-declare const setNested: (obj: Record<string, any>, key: string, value: any) => void;
+declare const setNested: (obj: Record<string, any>, key: string, value: any) => void
 /**
  * Converts object keys to a slugified format (e.g., snake_case).
  *
@@ -170,7 +170,7 @@ declare const setNested: (obj: Record<string, any>, key: string, value: any) =>
  * @param separator - Separator for slugified keys (default: "_")
  * @returns A new object with slugified keys
  */
-declare const slugifyKeys: <T extends object>(obj: T, only?: string[], separator?: string) => KeysToSnakeCase<T>;
+declare const slugifyKeys: <T extends object>(obj: T, only?: string[], separator?: string) => KeysToSnakeCase<T>
 
 /**
  * Get the portion of the string after the first occurrence of the given value.
@@ -179,7 +179,7 @@ declare const slugifyKeys: <T extends object>(obj: T, only?: string[], separator
  * @param search
  * @returns
  */
-declare const after: (value: string, search: string) => string;
+declare const after: (value: string, search: string) => string
 /**
  * Get the portion of the string after the last occurrence of the given value.
  *
@@ -187,7 +187,7 @@ declare const after: (value: string, search: string) => string;
  * @param search
  * @returns
  */
-declare const afterLast: (value: string, search: string) => string;
+declare const afterLast: (value: string, search: string) => string
 /**
  * Get the portion of the string before the first occurrence of the given value.
  *
@@ -195,7 +195,7 @@ declare const afterLast: (value: string, search: string) => string;
  * @param search
  * @returns
  */
-declare const before: (value: string, search: string) => string;
+declare const before: (value: string, search: string) => string
 /**
  * Get the portion of the string before the last occurrence of the given value.
  *
@@ -203,7 +203,7 @@ declare const before: (value: string, search: string) => string;
  * @param search
  * @returns
  */
-declare const beforeLast: (value: string, search: string) => string;
+declare const beforeLast: (value: string, search: string) => string
 /**
  * Capitalizes the first character of a string.
  *
@@ -218,14 +218,14 @@ declare function capitalize(str: string): string;
  * @param count - The number determining pluralization
  * @returns Singular if count === 1, otherwise plural form
  */
-declare const pluralize: (word: string, count: number) => string;
+declare const pluralize: (word: string, count: number) => string
 /**
  * Converts a plural English word into its singular form.
  *
  * @param word - The word to singularize
  * @returns The singular form of the word
  */
-declare const singularize: (word: string) => string;
+declare const singularize: (word: string) => string
 /**
  * Converts a string into a slug format.
  * Handles camelCase, spaces, and non-alphanumeric characters.
@@ -234,7 +234,7 @@ declare const singularize: (word: string) => string;
  * @param joiner - The character used to join words (default: "_")
  * @returns A slugified string
  */
-declare const slugify: (str: string, joiner?: string) => string;
+declare const slugify: (str: string, joiner?: string) => string
 /**
  * Truncates a string to a specified length and appends an ellipsis if needed.
  *
@@ -243,7 +243,7 @@ declare const slugify: (str: string, joiner?: string) => string;
  * @param ellipsis - String to append if truncated (default: "...")
  * @returns The truncated string
  */
-declare const subString: (str: string, len: number, ellipsis?: string) => string;
+declare const subString: (str: string, len: number, ellipsis?: string) => string
 /**
  * Replaces placeholders in a string with corresponding values from a data object.
  *
@@ -256,7 +256,7 @@ declare const subString: (str: string, len: number, ellipsis?: string) => string
  * @param def - Default value to use if a key is missing. (Optional)
  * @returns The substituted string or undefined if the input string or data is invalid.
  */
-declare const substitute: (str: string, data?: Record<string, unknown>, def?: string) => string | undefined;
+declare const substitute: (str: string, data?: Record<string, unknown>, def?: string) => string | undefined
 /**
  * Truncates a string to a specified length, removing HTML tags and
  * appending a suffix if the string exceeds the length.
@@ -266,6 +266,6 @@ declare const substitute: (str: string, data?: Record<string, unknown>, def?: st
  * @param suffix - Suffix to append if truncated (default: "...")
  * @returns The truncated string
  */
-declare const truncate: (str: string, len?: number, suffix?: string) => string;
+declare const truncate: (str: string, len?: number, suffix?: string) => string
 
-export { type CamelToSnakeCase, type DotFlatten, type DotNestedKeys, type DotNestedValue, type KeysToSnakeCase, abbreviate, after, afterLast, before, beforeLast, capitalize, chunk, dot, extractProperties, getValue, humanize, modObj, pluralize, range, safeDot, setNested, singularize, slugify, slugifyKeys, subString, substitute, toBytes, toHumanTime, truncate };
+export { type CamelToSnakeCase, type DotFlatten, type DotNestedKeys, type DotNestedValue, type KeysToSnakeCase, abbreviate, after, afterLast, before, beforeLast, capitalize, chunk, dot, extractProperties, getValue, humanize, modObj, pluralize, range, safeDot, setNested, singularize, slugify, slugifyKeys, subString, substitute, toBytes, toHumanTime, truncate }

package/dist/index.d.ts

@@ -46,7 +46,7 @@ type KeysToSnakeCase<T> = {
  * @param size - Size of each chunk (default: 2)
  * @returns An array of chunks (arrays)
  */
-declare const chunk: <T>(arr: T[], size?: number) => T[][];
+declare const chunk: <T>(arr: T[], size?: number) => T[][]
 /**
  * Generates an array of sequential numbers.
  *
@@ -54,7 +54,7 @@ declare const chunk: <T>(arr: T[], size?: number) => T[][];
  * @param startAt - Starting number (default: 0)
  * @returns An array of numbers from startAt to startAt + size - 1
  */
-declare const range: (size: number, startAt?: number) => number[];
+declare const range: (size: number, startAt?: number) => number[]
 
 /**
  * Abbreviates large numbers using SI symbols (K, M, B...)
@@ -64,7 +64,7 @@ declare const range: (size: number, startAt?: number) => number[];
  * @param locale - Optional locale string (default: "en-US")
  * @returns A localized, abbreviated number string
  */
-declare const abbreviate: (value?: number, locale?: string) => string;
+declare const abbreviate: (value?: number, locale?: string) => string
 /**
  * Concverts a number into human readable string
  *
@@ -72,7 +72,7 @@ declare const abbreviate: (value?: number, locale?: string) => string;
  * @param slugify convert the ouput into a slug using this as a separator
  * @returns
  */
-declare const humanize: (num: number, slugify?: "-" | "_") => string;
+declare const humanize: (num: number, slugify?: '-' | '_') => string
 /**
  * Converts a number of bytes into a human-readable string.
  *
@@ -82,7 +82,7 @@ declare const humanize: (num: number, slugify?: "-" | "_") => string;
  *               otherwise uses 1024-based binary units (Bytes, KiB...)
  * @returns A formatted string with the appropriate unit
  */
-declare const toBytes: (bytes?: number, decimals?: number, bits?: boolean) => string;
+declare const toBytes: (bytes?: number, decimals?: number, bits?: boolean) => string
 /**
  * Formats a duration (in seconds) into a human-readable string.
  *
@@ -91,7 +91,7 @@ declare const toBytes: (bytes?: number, decimals?: number, bits?: boolean) => st
  *                 otherwise HH:MM:SS (e.g., "01:02:03")
  * @returns A formatted time string
  */
-declare const toHumanTime: (seconds?: number, worded?: boolean) => string;
+declare const toHumanTime: (seconds?: number, worded?: boolean) => string
 
 /**
  * Flattens a nested object into a single-level object
@@ -114,7 +114,7 @@ declare const toHumanTime: (seconds?: number, worded?: boolean) => string;
  * @param obj - The nested object to flatten
  * @returns A flattened object with dotted keys and inferred types
  */
-declare const dot: <T extends Record<string, any>>(obj: T) => DotFlatten<T>;
+declare const dot: <T extends Record<string, any>>(obj: T) => DotFlatten<T>
 /**
  * Extracts a subset of properties from an object.
  *
@@ -124,7 +124,7 @@ declare const dot: <T extends Record<string, any>>(obj: T) => DotFlatten<T>;
  * @param keys - Array of keys to extract
  * @returns A new object with only the specified keys
  */
-declare const extractProperties: <T extends object, K extends keyof T>(obj: T, keys?: readonly K[]) => Pick<T, K>;
+declare const extractProperties: <T extends object, K extends keyof T>(obj: T, keys?: readonly K[]) => Pick<T, K>
 /**
  * Safely retrieves a value from an object by key or nested keys.
  *
@@ -133,7 +133,7 @@ declare const extractProperties: <T extends object, K extends keyof T>(obj: T, k
  * @param item - The source object
  * @returns The found value as a string or the key itself if not found
  */
-declare const getValue: <T extends Record<string, any>>(key: string | [keyof T, keyof T[string]], item: T) => string;
+declare const getValue: <T extends Record<string, any>>(key: string | [keyof T, keyof T[string]], item: T) => string
 /**
  * Maps over an object's entries and returns a new object
  * with transformed keys and/or values.
@@ -144,7 +144,7 @@ declare const getValue: <T extends Record<string, any>>(key: string | [keyof T,
  * @param callback - Function that receives [key, value] and returns [newKey, newValue]
  * @returns A new object with transformed entries
  */
-declare const modObj: <T extends object, R>(obj: T, callback: (entry: [keyof T & string, T[keyof T]]) => [string, R]) => Record<string, R>;
+declare const modObj: <T extends object, R>(obj: T, callback: (entry: [keyof T & string, T[keyof T]]) => [string, R]) => Record<string, R>
 declare function safeDot<T extends Record<string, any>>(data: T): T;
 declare function safeDot<T extends Record<string, any>, K extends DotNestedKeys<T>>(data: T, key?: K): DotNestedValue<T, K>;
 /**
@@ -160,7 +160,7 @@ declare function safeDot<T extends Record<string, any>, K extends DotNestedKeys<
  * @param key - The dot-separated key (e.g., 'app.user.name').
  * @param value - The value to set at the specified path.
  */
-declare const setNested: (obj: Record<string, any>, key: string, value: any) => void;
+declare const setNested: (obj: Record<string, any>, key: string, value: any) => void
 /**
  * Converts object keys to a slugified format (e.g., snake_case).
  *
@@ -170,7 +170,7 @@ declare const setNested: (obj: Record<string, any>, key: string, value: any) =>
  * @param separator - Separator for slugified keys (default: "_")
  * @returns A new object with slugified keys
  */
-declare const slugifyKeys: <T extends object>(obj: T, only?: string[], separator?: string) => KeysToSnakeCase<T>;
+declare const slugifyKeys: <T extends object>(obj: T, only?: string[], separator?: string) => KeysToSnakeCase<T>
 
 /**
  * Get the portion of the string after the first occurrence of the given value.
@@ -179,7 +179,7 @@ declare const slugifyKeys: <T extends object>(obj: T, only?: string[], separator
  * @param search
  * @returns
  */
-declare const after: (value: string, search: string) => string;
+declare const after: (value: string, search: string) => string
 /**
  * Get the portion of the string after the last occurrence of the given value.
  *
@@ -187,7 +187,7 @@ declare const after: (value: string, search: string) => string;
  * @param search
  * @returns
  */
-declare const afterLast: (value: string, search: string) => string;
+declare const afterLast: (value: string, search: string) => string
 /**
  * Get the portion of the string before the first occurrence of the given value.
  *
@@ -195,7 +195,7 @@ declare const afterLast: (value: string, search: string) => string;
  * @param search
  * @returns
  */
-declare const before: (value: string, search: string) => string;
+declare const before: (value: string, search: string) => string
 /**
  * Get the portion of the string before the last occurrence of the given value.
  *
@@ -203,7 +203,7 @@ declare const before: (value: string, search: string) => string;
  * @param search
  * @returns
  */
-declare const beforeLast: (value: string, search: string) => string;
+declare const beforeLast: (value: string, search: string) => string
 /**
  * Capitalizes the first character of a string.
  *
@@ -218,14 +218,14 @@ declare function capitalize(str: string): string;
  * @param count - The number determining pluralization
  * @returns Singular if count === 1, otherwise plural form
  */
-declare const pluralize: (word: string, count: number) => string;
+declare const pluralize: (word: string, count: number) => string
 /**
  * Converts a plural English word into its singular form.
  *
  * @param word - The word to singularize
  * @returns The singular form of the word
  */
-declare const singularize: (word: string) => string;
+declare const singularize: (word: string) => string
 /**
  * Converts a string into a slug format.
  * Handles camelCase, spaces, and non-alphanumeric characters.
@@ -234,7 +234,7 @@ declare const singularize: (word: string) => string;
  * @param joiner - The character used to join words (default: "_")
  * @returns A slugified string
  */
-declare const slugify: (str: string, joiner?: string) => string;
+declare const slugify: (str: string, joiner?: string) => string
 /**
  * Truncates a string to a specified length and appends an ellipsis if needed.
  *
@@ -243,7 +243,7 @@ declare const slugify: (str: string, joiner?: string) => string;
  * @param ellipsis - String to append if truncated (default: "...")
  * @returns The truncated string
  */
-declare const subString: (str: string, len: number, ellipsis?: string) => string;
+declare const subString: (str: string, len: number, ellipsis?: string) => string
 /**
  * Replaces placeholders in a string with corresponding values from a data object.
  *
@@ -256,7 +256,7 @@ declare const subString: (str: string, len: number, ellipsis?: string) => string
  * @param def - Default value to use if a key is missing. (Optional)
  * @returns The substituted string or undefined if the input string or data is invalid.
  */
-declare const substitute: (str: string, data?: Record<string, unknown>, def?: string) => string | undefined;
+declare const substitute: (str: string, data?: Record<string, unknown>, def?: string) => string | undefined
 /**
  * Truncates a string to a specified length, removing HTML tags and
  * appending a suffix if the string exceeds the length.
@@ -266,6 +266,6 @@ declare const substitute: (str: string, data?: Record<string, unknown>, def?: st
  * @param suffix - Suffix to append if truncated (default: "...")
  * @returns The truncated string
  */
-declare const truncate: (str: string, len?: number, suffix?: string) => string;
+declare const truncate: (str: string, len?: number, suffix?: string) => string
 
-export { type CamelToSnakeCase, type DotFlatten, type DotNestedKeys, type DotNestedValue, type KeysToSnakeCase, abbreviate, after, afterLast, before, beforeLast, capitalize, chunk, dot, extractProperties, getValue, humanize, modObj, pluralize, range, safeDot, setNested, singularize, slugify, slugifyKeys, subString, substitute, toBytes, toHumanTime, truncate };
+export { type CamelToSnakeCase, type DotFlatten, type DotNestedKeys, type DotNestedValue, type KeysToSnakeCase, abbreviate, after, afterLast, before, beforeLast, capitalize, chunk, dot, extractProperties, getValue, humanize, modObj, pluralize, range, safeDot, setNested, singularize, slugify, slugifyKeys, subString, substitute, toBytes, toHumanTime, truncate }