@zairakai/js-utils 1.0.0

package/dist/php-arrays.d.cts

@@ -0,0 +1,256 @@
+import { EnhancedArray } from './collections.cjs';
+
+/**
+ * PHP-like array functions for JavaScript
+ * Provides exact API compatibility between PHP arrays and JavaScript arrays
+ */
+
+/**
+ * Split an array into chunks.
+ *
+ * @param {T[]} array The array to chunk
+ * @param {number} size The size of each chunk
+ * @returns {T[][]} An array of chunks
+ */
+declare const array_chunk: <T>(array: T[], size: number) => T[][];
+/**
+ * Filter elements of an array using a callback function.
+ *
+ * @param {T[]} array The array to filter
+ * @param {Function} [callback] The callback function to use
+ * @returns {T[]} The filtered array
+ */
+declare const array_filter: <T>(array: T[], callback?: (value: T, index: number) => boolean) => T[];
+/**
+ * Apply a callback to the elements of the given arrays.
+ *
+ * @param {Function} callback The callback function to apply
+ * @param {T[]} array The array to map over
+ * @returns {U[]} The mapped array
+ */
+declare const array_map: <T, U>(callback: (value: T, index: number) => U, array: T[]) => U[];
+/**
+ * Iteratively reduce the array to a single value using a callback function.
+ *
+ * @param {T[]} array The source array
+ * @param {Function} callback The callback function
+ * @param {U} initial The initial value
+ * @returns {U} The reduced value
+ */
+declare const array_reduce: <T, U>(array: T[], callback: (carry: U, item: T, index: number) => U, initial: U) => U;
+/**
+ * Merge one or more arrays.
+ *
+ * @param {...T[][]} arrays The arrays to merge
+ * @returns {T[]} The merged array
+ */
+declare const array_merge: <T>(...arrays: T[][]) => T[];
+/**
+ * Remove duplicate values from an array.
+ *
+ * @param {T[]} array The source array
+ * @returns {T[]} The array with unique values
+ */
+declare const array_unique: <T>(array: T[]) => T[];
+/**
+ * Return an array with elements in reverse order.
+ *
+ * @param {T[]} array The source array
+ * @param {boolean} [_preserveKeys=false] Whether to preserve keys (ignored for JS arrays)
+ * @returns {T[]} The reversed array
+ */
+declare const array_reverse: <T>(array: T[], _preserveKeys?: boolean) => T[];
+/**
+ * Extract a slice of the array.
+ *
+ * @param {T[]} array The source array
+ * @param {number} offset The starting offset
+ * @param {number} [length] The length of the slice
+ * @returns {T[]} The sliced portion of the array
+ */
+declare const array_slice: <T>(array: T[], offset: number, length?: number) => T[];
+/**
+ * Remove a portion of the array and replace it with something else.
+ *
+ * @param {T[]} array The source array
+ * @param {number} offset The starting offset
+ * @param {number} [length] The number of elements to remove
+ * @param {...T[]} replacement The elements to replace with
+ * @returns {T[]} The modified array (copy)
+ */
+declare const array_splice: <T>(array: T[], offset: number, length?: number, ...replacement: T[]) => T[];
+/**
+ * Return all the keys or a subset of the keys of an array.
+ *
+ * @param {T[]} array The source array
+ * @returns {number[]} The array keys (indices)
+ */
+declare const array_keys: <T>(array: T[]) => number[];
+/**
+ * Search an array for a given value and return the corresponding key if successful.
+ *
+ * @param {T} needle The value to search for
+ * @param {T[]} haystack The array to search in
+ * @returns {number | false} The key if found, false otherwise
+ */
+declare const array_search: <T>(needle: T, haystack: T[]) => number | false;
+/**
+ * Check if the given key or index exists in the array.
+ *
+ * @param {number} key The key to check
+ * @param {T[]} array The source array
+ * @returns {boolean} True if the key exists
+ */
+declare const array_key_exists: <T>(key: number, array: T[]) => boolean;
+/**
+ * Pop the element off the end of array.
+ *
+ * @param {T[]} array The source array
+ * @returns {T | undefined} The popped element
+ */
+declare const array_pop: <T>(array: T[]) => T | undefined;
+/**
+ * Push one or more elements onto the end of array.
+ *
+ * @param {T[]} array The source array
+ * @param {...T[]} values The values to push
+ * @returns {T[]} The modified array (copy)
+ */
+declare const array_push: <T>(array: T[], ...values: T[]) => T[];
+/**
+ * Shift an element off the beginning of array.
+ *
+ * @param {T[]} array The source array
+ * @returns {T | undefined} The shifted element
+ */
+declare const array_shift: <T>(array: T[]) => T | undefined;
+/**
+ * Prepend one or more elements to the beginning of an array.
+ *
+ * @param {T[]} array The source array
+ * @param {...T[]} values The values to prepend
+ * @returns {T[]} The modified array (copy)
+ */
+declare const array_unshift: <T>(array: T[], ...values: T[]) => T[];
+/**
+ * Calculate the sum of values in an array.
+ *
+ * @param {number[]} array The source array
+ * @returns {number} The sum of values
+ */
+declare const array_sum: (array: number[]) => number;
+/**
+ * Calculate the product of values in an array.
+ *
+ * @param {number[]} array The source array
+ * @returns {number} The product of values
+ */
+declare const array_product: (array: number[]) => number;
+/**
+ * Pick one or more random entries out of an array.
+ *
+ * @param {T[]} array The source array
+ * @param {number} [num=1] The number of entries to pick
+ * @returns {T | T[] | undefined} The random entry or entries
+ */
+declare const array_rand: <T>(array: T[], num?: number) => T | T[] | undefined;
+/**
+ * Exchange all keys with their associated values in an array.
+ *
+ * @param {T[]} array The source array
+ * @returns {Record<string, number>} The flipped record
+ */
+declare const array_flip: <T extends string | number>(array: T[]) => Record<string, number>;
+/**
+ * Count all the values of an array.
+ *
+ * @param {T[]} array The source array
+ * @returns {Record<string, number>} A record of values and their counts
+ */
+declare const array_count_values: <T extends string | number>(array: T[]) => Record<string, number>;
+/**
+ * Compute the intersection of arrays.
+ *
+ * @param {...T[][]} arrays The arrays to intersect
+ * @returns {T[]} The intersection of the arrays
+ */
+declare const array_intersect: <T>(...arrays: T[][]) => T[];
+/**
+ * Compute the difference of arrays.
+ *
+ * @param {T[]} array1 The array to compare from
+ * @param {...T[][]} arrays The arrays to compare against
+ * @returns {T[]} The difference of the arrays
+ */
+declare const array_diff: <T>(array1: T[], ...arrays: T[][]) => T[];
+/**
+ * Return the values from a single column in the input array.
+ *
+ * @param {T[]} array The source array of objects
+ * @param {K} column The column to retrieve
+ * @returns {T[K][]} The array of column values
+ */
+declare const array_column: <T, K extends keyof T>(array: T[], column: K) => T[K][];
+/**
+ * Sort an array.
+ *
+ * @param {T[]} array The source array
+ * @returns {T[]} The sorted array (copy)
+ */
+declare const sort: <T>(array: T[]) => T[];
+/**
+ * Sort an array in reverse order.
+ *
+ * @param {T[]} array The source array
+ * @returns {T[]} The sorted array (copy)
+ */
+declare const rsort: <T>(array: T[]) => T[];
+/**
+ * Sort an array with a user-defined comparison function.
+ *
+ * @param {T[]} array The source array
+ * @param {Function} compareFunction The comparison function
+ * @returns {T[]} The sorted array (copy)
+ */
+declare const usort: <T>(array: T[], compareFunction: (a: T, b: T) => number) => T[];
+/**
+ * Sort an array with a user-defined comparison function and maintain index association.
+ *
+ * @param {T[]} array The source array
+ * @param {Function} compareFunction The comparison function
+ * @returns {T[]} The sorted array (copy)
+ */
+declare const uasort: <T>(array: T[], compareFunction: (a: T, b: T) => number) => T[];
+/**
+ * Sort an array by keys using a user-defined comparison function.
+ *
+ * @param {T[]} array The source array
+ * @param {Function} compareFunction The comparison function
+ * @returns {T[]} The sorted array (copy)
+ */
+declare const uksort: <T>(array: T[], compareFunction: (a: number, b: number) => number) => T[];
+/**
+ * Shuffle an array.
+ *
+ * @param {T[]} array The source array
+ * @returns {T[]} The shuffled array (copy)
+ */
+declare const shuffle: <T>(array: T[]) => T[];
+/**
+ * Create an array containing a range of elements.
+ *
+ * @param {number} start First value of the sequence
+ * @param {number} end The sequence is stopped when end is reached
+ * @param {number} [step=1] The increment used in the range
+ * @returns {number[]} The array of elements
+ */
+declare const range: (start: number, end: number, step?: number) => number[];
+/**
+ * Create an EnhancedArray with PHP-like methods.
+ *
+ * @param {T[]} items The source items
+ * @returns {EnhancedArray<T>} The enhanced array
+ */
+declare const php_array: <T>(items: T[]) => EnhancedArray<T>;
+
+export { array_chunk, array_column, array_count_values, array_diff, array_filter, array_flip, array_intersect, array_key_exists, array_keys, array_map, array_merge, array_pop, array_product, array_push, array_rand, array_reduce, array_reverse, array_search, array_shift, array_slice, array_splice, array_sum, array_unique, array_unshift, php_array, range, rsort, shuffle, sort, uasort, uksort, usort };

package/dist/php-arrays.d.ts

@@ -0,0 +1,256 @@
+import { EnhancedArray } from './collections.js';
+
+/**
+ * PHP-like array functions for JavaScript
+ * Provides exact API compatibility between PHP arrays and JavaScript arrays
+ */
+
+/**
+ * Split an array into chunks.
+ *
+ * @param {T[]} array The array to chunk
+ * @param {number} size The size of each chunk
+ * @returns {T[][]} An array of chunks
+ */
+declare const array_chunk: <T>(array: T[], size: number) => T[][];
+/**
+ * Filter elements of an array using a callback function.
+ *
+ * @param {T[]} array The array to filter
+ * @param {Function} [callback] The callback function to use
+ * @returns {T[]} The filtered array
+ */
+declare const array_filter: <T>(array: T[], callback?: (value: T, index: number) => boolean) => T[];
+/**
+ * Apply a callback to the elements of the given arrays.
+ *
+ * @param {Function} callback The callback function to apply
+ * @param {T[]} array The array to map over
+ * @returns {U[]} The mapped array
+ */
+declare const array_map: <T, U>(callback: (value: T, index: number) => U, array: T[]) => U[];
+/**
+ * Iteratively reduce the array to a single value using a callback function.
+ *
+ * @param {T[]} array The source array
+ * @param {Function} callback The callback function
+ * @param {U} initial The initial value
+ * @returns {U} The reduced value
+ */
+declare const array_reduce: <T, U>(array: T[], callback: (carry: U, item: T, index: number) => U, initial: U) => U;
+/**
+ * Merge one or more arrays.
+ *
+ * @param {...T[][]} arrays The arrays to merge
+ * @returns {T[]} The merged array
+ */
+declare const array_merge: <T>(...arrays: T[][]) => T[];
+/**
+ * Remove duplicate values from an array.
+ *
+ * @param {T[]} array The source array
+ * @returns {T[]} The array with unique values
+ */
+declare const array_unique: <T>(array: T[]) => T[];
+/**
+ * Return an array with elements in reverse order.
+ *
+ * @param {T[]} array The source array
+ * @param {boolean} [_preserveKeys=false] Whether to preserve keys (ignored for JS arrays)
+ * @returns {T[]} The reversed array
+ */
+declare const array_reverse: <T>(array: T[], _preserveKeys?: boolean) => T[];
+/**
+ * Extract a slice of the array.
+ *
+ * @param {T[]} array The source array
+ * @param {number} offset The starting offset
+ * @param {number} [length] The length of the slice
+ * @returns {T[]} The sliced portion of the array
+ */
+declare const array_slice: <T>(array: T[], offset: number, length?: number) => T[];
+/**
+ * Remove a portion of the array and replace it with something else.
+ *
+ * @param {T[]} array The source array
+ * @param {number} offset The starting offset
+ * @param {number} [length] The number of elements to remove
+ * @param {...T[]} replacement The elements to replace with
+ * @returns {T[]} The modified array (copy)
+ */
+declare const array_splice: <T>(array: T[], offset: number, length?: number, ...replacement: T[]) => T[];
+/**
+ * Return all the keys or a subset of the keys of an array.
+ *
+ * @param {T[]} array The source array
+ * @returns {number[]} The array keys (indices)
+ */
+declare const array_keys: <T>(array: T[]) => number[];
+/**
+ * Search an array for a given value and return the corresponding key if successful.
+ *
+ * @param {T} needle The value to search for
+ * @param {T[]} haystack The array to search in
+ * @returns {number | false} The key if found, false otherwise
+ */
+declare const array_search: <T>(needle: T, haystack: T[]) => number | false;
+/**
+ * Check if the given key or index exists in the array.
+ *
+ * @param {number} key The key to check
+ * @param {T[]} array The source array
+ * @returns {boolean} True if the key exists
+ */
+declare const array_key_exists: <T>(key: number, array: T[]) => boolean;
+/**
+ * Pop the element off the end of array.
+ *
+ * @param {T[]} array The source array
+ * @returns {T | undefined} The popped element
+ */
+declare const array_pop: <T>(array: T[]) => T | undefined;
+/**
+ * Push one or more elements onto the end of array.
+ *
+ * @param {T[]} array The source array
+ * @param {...T[]} values The values to push
+ * @returns {T[]} The modified array (copy)
+ */
+declare const array_push: <T>(array: T[], ...values: T[]) => T[];
+/**
+ * Shift an element off the beginning of array.
+ *
+ * @param {T[]} array The source array
+ * @returns {T | undefined} The shifted element
+ */
+declare const array_shift: <T>(array: T[]) => T | undefined;
+/**
+ * Prepend one or more elements to the beginning of an array.
+ *
+ * @param {T[]} array The source array
+ * @param {...T[]} values The values to prepend
+ * @returns {T[]} The modified array (copy)
+ */
+declare const array_unshift: <T>(array: T[], ...values: T[]) => T[];
+/**
+ * Calculate the sum of values in an array.
+ *
+ * @param {number[]} array The source array
+ * @returns {number} The sum of values
+ */
+declare const array_sum: (array: number[]) => number;
+/**
+ * Calculate the product of values in an array.
+ *
+ * @param {number[]} array The source array
+ * @returns {number} The product of values
+ */
+declare const array_product: (array: number[]) => number;
+/**
+ * Pick one or more random entries out of an array.
+ *
+ * @param {T[]} array The source array
+ * @param {number} [num=1] The number of entries to pick
+ * @returns {T | T[] | undefined} The random entry or entries
+ */
+declare const array_rand: <T>(array: T[], num?: number) => T | T[] | undefined;
+/**
+ * Exchange all keys with their associated values in an array.
+ *
+ * @param {T[]} array The source array
+ * @returns {Record<string, number>} The flipped record
+ */
+declare const array_flip: <T extends string | number>(array: T[]) => Record<string, number>;
+/**
+ * Count all the values of an array.
+ *
+ * @param {T[]} array The source array
+ * @returns {Record<string, number>} A record of values and their counts
+ */
+declare const array_count_values: <T extends string | number>(array: T[]) => Record<string, number>;
+/**
+ * Compute the intersection of arrays.
+ *
+ * @param {...T[][]} arrays The arrays to intersect
+ * @returns {T[]} The intersection of the arrays
+ */
+declare const array_intersect: <T>(...arrays: T[][]) => T[];
+/**
+ * Compute the difference of arrays.
+ *
+ * @param {T[]} array1 The array to compare from
+ * @param {...T[][]} arrays The arrays to compare against
+ * @returns {T[]} The difference of the arrays
+ */
+declare const array_diff: <T>(array1: T[], ...arrays: T[][]) => T[];
+/**
+ * Return the values from a single column in the input array.
+ *
+ * @param {T[]} array The source array of objects
+ * @param {K} column The column to retrieve
+ * @returns {T[K][]} The array of column values
+ */
+declare const array_column: <T, K extends keyof T>(array: T[], column: K) => T[K][];
+/**
+ * Sort an array.
+ *
+ * @param {T[]} array The source array
+ * @returns {T[]} The sorted array (copy)
+ */
+declare const sort: <T>(array: T[]) => T[];
+/**
+ * Sort an array in reverse order.
+ *
+ * @param {T[]} array The source array
+ * @returns {T[]} The sorted array (copy)
+ */
+declare const rsort: <T>(array: T[]) => T[];
+/**
+ * Sort an array with a user-defined comparison function.
+ *
+ * @param {T[]} array The source array
+ * @param {Function} compareFunction The comparison function
+ * @returns {T[]} The sorted array (copy)
+ */
+declare const usort: <T>(array: T[], compareFunction: (a: T, b: T) => number) => T[];
+/**
+ * Sort an array with a user-defined comparison function and maintain index association.
+ *
+ * @param {T[]} array The source array
+ * @param {Function} compareFunction The comparison function
+ * @returns {T[]} The sorted array (copy)
+ */
+declare const uasort: <T>(array: T[], compareFunction: (a: T, b: T) => number) => T[];
+/**
+ * Sort an array by keys using a user-defined comparison function.
+ *
+ * @param {T[]} array The source array
+ * @param {Function} compareFunction The comparison function
+ * @returns {T[]} The sorted array (copy)
+ */
+declare const uksort: <T>(array: T[], compareFunction: (a: number, b: number) => number) => T[];
+/**
+ * Shuffle an array.
+ *
+ * @param {T[]} array The source array
+ * @returns {T[]} The shuffled array (copy)
+ */
+declare const shuffle: <T>(array: T[]) => T[];
+/**
+ * Create an array containing a range of elements.
+ *
+ * @param {number} start First value of the sequence
+ * @param {number} end The sequence is stopped when end is reached
+ * @param {number} [step=1] The increment used in the range
+ * @returns {number[]} The array of elements
+ */
+declare const range: (start: number, end: number, step?: number) => number[];
+/**
+ * Create an EnhancedArray with PHP-like methods.
+ *
+ * @param {T[]} items The source items
+ * @returns {EnhancedArray<T>} The enhanced array
+ */
+declare const php_array: <T>(items: T[]) => EnhancedArray<T>;
+
+export { array_chunk, array_column, array_count_values, array_diff, array_filter, array_flip, array_intersect, array_key_exists, array_keys, array_map, array_merge, array_pop, array_product, array_push, array_rand, array_reduce, array_reverse, array_search, array_shift, array_slice, array_splice, array_sum, array_unique, array_unshift, php_array, range, rsort, shuffle, sort, uasort, uksort, usort };

package/dist/php-arrays.js

@@ -0,0 +1,70 @@
+import {
+  array_chunk,
+  array_column,
+  array_count_values,
+  array_diff,
+  array_filter,
+  array_flip,
+  array_intersect,
+  array_key_exists,
+  array_keys,
+  array_map,
+  array_merge,
+  array_pop,
+  array_product,
+  array_push,
+  array_rand,
+  array_reduce,
+  array_reverse,
+  array_search,
+  array_shift,
+  array_slice,
+  array_splice,
+  array_sum,
+  array_unique,
+  array_unshift,
+  php_array,
+  range,
+  rsort,
+  shuffle,
+  sort,
+  uasort,
+  uksort,
+  usort
+} from "./chunk-42CHLXT7.js";
+import "./chunk-TY75OOIQ.js";
+import "./chunk-LDSWHSRX.js";
+export {
+  array_chunk,
+  array_column,
+  array_count_values,
+  array_diff,
+  array_filter,
+  array_flip,
+  array_intersect,
+  array_key_exists,
+  array_keys,
+  array_map,
+  array_merge,
+  array_pop,
+  array_product,
+  array_push,
+  array_rand,
+  array_reduce,
+  array_reverse,
+  array_search,
+  array_shift,
+  array_slice,
+  array_splice,
+  array_sum,
+  array_unique,
+  array_unshift,
+  php_array,
+  range,
+  rsort,
+  shuffle,
+  sort,
+  uasort,
+  uksort,
+  usort
+};