@augment-vir/common 31.21.1 → 31.23.0

package/dist/augments/array/array-pagination.d.ts

@@ -0,0 +1,72 @@
+import { type RequireExactlyOne } from 'type-fest';
+/**
+ * Options for {@link getArrayPage}.
+ *
+ * @category Internal
+ */
+export type ArrayPaginationOptions = {
+    /** Split the array into pages of this size. */
+    countPerPage: number;
+    /** Get this page number. This is 0 indexed. */
+    getPage: number;
+};
+/**
+ * Split an array into pages of size `countPerPage` and then get the `getPage` page from that split.
+ * `getPage` is `0` indexed.
+ *
+ * @category Array
+ * @example
+ *
+ * ```ts
+ * import {getArrayPage} from '@augment-vir/common';
+ *
+ * const result = getArrayPage(
+ *     [
+ *         'a',
+ *         'b',
+ *         'c',
+ *     ],
+ *     {
+ *         countPerPage: 2,
+ *         getPage: 1,
+ *     },
+ * );
+ * // result is `['c']`
+ * ```
+ */
+export declare function getArrayPage<ArrayEntry>(originalArray: ReadonlyArray<ArrayEntry>, options: Readonly<ArrayPaginationOptions>): ArrayEntry[] | undefined;
+/**
+ * Options for {@link chunkArray}. Only set one property (`chunkCount` or `chunkSize`). If the value
+ * given is `0`, the array will not be chunked at all.
+ *
+ * @category Internal
+ */
+export type ChunkArrayOptions = RequireExactlyOne<{
+    /** Split the array into this many chunks. */
+    chunkCount: number;
+    /** Split the array into chunks of this size. */
+    chunkSize: number;
+}>;
+/**
+ * Split an array into multiple sub array "chunks" based on the given options.
+ *
+ * @category Array
+ * @example
+ *
+ * ```ts
+ * import {chunkArray} from '@augment-vir/common';
+ *
+ * const result = chunkArray(
+ *     [
+ *         'a',
+ *         'b',
+ *         'c',
+ *     ],
+ *     {
+ *         chunkSize: 2,
+ *     },
+ * );
+ * // result is `[['a', 'b'], ['c']]`
+ * ```
+ */
+export declare function chunkArray<ArrayEntry>(originalArray: ReadonlyArray<ArrayEntry>, options: Readonly<ChunkArrayOptions>): ArrayEntry[][];

package/dist/augments/array/array-pagination.js

@@ -0,0 +1,62 @@
+/**
+ * Split an array into pages of size `countPerPage` and then get the `getPage` page from that split.
+ * `getPage` is `0` indexed.
+ *
+ * @category Array
+ * @example
+ *
+ * ```ts
+ * import {getArrayPage} from '@augment-vir/common';
+ *
+ * const result = getArrayPage(
+ *     [
+ *         'a',
+ *         'b',
+ *         'c',
+ *     ],
+ *     {
+ *         countPerPage: 2,
+ *         getPage: 1,
+ *     },
+ * );
+ * // result is `['c']`
+ * ```
+ */
+export function getArrayPage(originalArray, options) {
+    const chunks = chunkArray(originalArray, { chunkSize: options.countPerPage });
+    return chunks[options.getPage];
+}
+/**
+ * Split an array into multiple sub array "chunks" based on the given options.
+ *
+ * @category Array
+ * @example
+ *
+ * ```ts
+ * import {chunkArray} from '@augment-vir/common';
+ *
+ * const result = chunkArray(
+ *     [
+ *         'a',
+ *         'b',
+ *         'c',
+ *     ],
+ *     {
+ *         chunkSize: 2,
+ *     },
+ * );
+ * // result is `[['a', 'b'], ['c']]`
+ * ```
+ */
+export function chunkArray(originalArray, options) {
+    const chunkSize = options.chunkSize ||
+        (options.chunkCount ? Math.ceil(originalArray.length / options.chunkCount) : 0);
+    if (!chunkSize) {
+        return [[...originalArray]];
+    }
+    const chunkedArray = [];
+    for (let i = 0; i < originalArray.length; i += chunkSize) {
+        chunkedArray.push(originalArray.slice(i, i + chunkSize));
+    }
+    return chunkedArray;
+}

package/dist/augments/object/deep-copy.d.ts

@@ -0,0 +1 @@
+export { deepCopy, type CustomCopy, type DeepCopyOptions } from 'deepcopy-esm';

package/dist/augments/object/deep-copy.js

@@ -0,0 +1 @@
+export { deepCopy } from 'deepcopy-esm';

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from './augments/array/array-map.js';
+export * from './augments/array/array-pagination.js';
 export * from './augments/array/array-to-object.js';
 export * from './augments/array/awaited/awaited-filter.js';
 export * from './augments/array/awaited/awaited-for-each.js';
@@ -36,6 +37,7 @@ export * from './augments/number/round.js';
 export * from './augments/number/scientific.js';
 export * from './augments/number/truncate-number.js';
 export * from './augments/number/wrap-number.js';
+export * from './augments/object/deep-copy.js';
 export * from './augments/object/diff.js';
 export * from './augments/object/empty.js';
 export * from './augments/object/get-or-set.js';

package/dist/index.js

@@ -1,4 +1,5 @@
 export * from './augments/array/array-map.js';
+export * from './augments/array/array-pagination.js';
 export * from './augments/array/array-to-object.js';
 export * from './augments/array/awaited/awaited-filter.js';
 export * from './augments/array/awaited/awaited-for-each.js';
@@ -36,6 +37,7 @@ export * from './augments/number/round.js';
 export * from './augments/number/scientific.js';
 export * from './augments/number/truncate-number.js';
 export * from './augments/number/wrap-number.js';
+export * from './augments/object/deep-copy.js';
 export * from './augments/object/diff.js';
 export * from './augments/object/empty.js';
 export * from './augments/object/get-or-set.js';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "31.21.1",
+    "version": "31.23.0",
     "description": "A collection of augments, helpers types, functions, and classes for any JavaScript environment.",
     "keywords": [
         "augment",
@@ -40,10 +40,12 @@
         "test:web": "virmator --no-deps test web"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.21.1",
-        "@augment-vir/core": "^31.21.1",
+        "@augment-vir/assert": "^31.23.0",
+        "@augment-vir/core": "^31.23.0",
         "@date-vir/duration": "^7.3.1",
         "ansi-styles": "^6.2.1",
+        "deepcopy": "^2.1.0",
+        "deepcopy-esm": "^2.1.0",
         "json5": "^2.2.3",
         "type-fest": "^4.41.0",
         "typed-event-target": "^4.1.0"