diff --git a/CHANGELOG.md b/CHANGELOG.md index ab87bd4f1..bd32f14df 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # CHANGELOG +## 5.2.1 + +Changes: + +- Add `arrayFlatten` to merge a series of arrays into a single +- Add `arrayChunk` to chunk an array into multiples of defined size + + ## 5.1.1 Dec 19, 2020 Changes: diff --git a/packages/util/src/array/chunk.spec.ts b/packages/util/src/array/chunk.spec.ts new file mode 100644 index 000000000..76d839fc2 --- /dev/null +++ b/packages/util/src/array/chunk.spec.ts @@ -0,0 +1,12 @@ +// Copyright 2017-2020 @polkadot/util authors & contributors +// SPDX-License-Identifier: Apache-2.0 + +import { arrayChunk } from '.'; + +describe('arrayChunk', (): void => { + it('chunks arrays', (): void => { + expect( + arrayChunk([1, 2, 3, 4, 5, 6, 7], 3) + ).toEqual([[1, 2, 3], [4, 5, 6], [7]]); + }); +}); diff --git a/packages/util/src/array/chunk.ts b/packages/util/src/array/chunk.ts new file mode 100644 index 000000000..cbf2f5757 --- /dev/null +++ b/packages/util/src/array/chunk.ts @@ -0,0 +1,29 @@ +// Copyright 2017-2020 @polkadot/util authors & contributors +// SPDX-License-Identifier: Apache-2.0 + +/** + * @name arrayChunk + * @summary Split T[] into T[][] based on the defind size + * @description + * Returns a set ao arrays based on the chunksize + * @example + *
+ * + * ```javascript + * import { arrayChunk } from '@polkadot/util'; + * + * arrayChunk([1, 2, 3, 4, 5]); // [[1, 2], [3, 4], [5]] + * ``` + */ +export function arrayChunk (array: T[], chunkSize: number): T[][] { + const outputSize = Math.ceil(array.length / chunkSize); + const output = Array(outputSize); + + for (let index = 0; index < outputSize; index++) { + const offset = index * chunkSize; + + output[index] = array.slice(offset, offset + chunkSize); + } + + return output; +} diff --git a/packages/util/src/array/flatten.spec.ts b/packages/util/src/array/flatten.spec.ts new file mode 100644 index 000000000..94ddf0f7e --- /dev/null +++ b/packages/util/src/array/flatten.spec.ts @@ -0,0 +1,12 @@ +// Copyright 2017-2020 @polkadot/util authors & contributors +// SPDX-License-Identifier: Apache-2.0 + +import { arrayFlatten } from '.'; + +describe('arrayFlatten', (): void => { + it('flattens arrays', (): void => { + expect( + arrayFlatten([[0], [1, 2, 3], [4, 5], [6], [], [7, 8]]) + ).toEqual([0, 1, 2, 3, 4, 5, 6, 7, 8]); + }); +}); diff --git a/packages/util/src/array/flatten.ts b/packages/util/src/array/flatten.ts new file mode 100644 index 000000000..ef80a51f4 --- /dev/null +++ b/packages/util/src/array/flatten.ts @@ -0,0 +1,36 @@ +// Copyright 2017-2020 @polkadot/util authors & contributors +// SPDX-License-Identifier: Apache-2.0 + +// This is supposed to be a faster concat... +// https://dev.to/uilicious/javascript-array-push-is-945x-faster-than-array-concat-1oki + +/** + * @name arrayFlatten + * @summary Merge T[][] into T[] + * @description + * Returns a new array with all arrays merged into one + * @example + *
+ * + * ```javascript + * import { arrayFlatten } from '@polkadot/util'; + * + * arrayFlatten([[1, 2], [3, 4], [5]]); // [1, 2, 3, 4, 5] + * ``` + */ +export function arrayFlatten (arrays: T[][]): T[] { + // pre-allocate based on the combined size + const output = new Array(arrays.reduce((length, array) => length + array.length, 0)); + let index = -1; + + for (let a = 0; a < arrays.length; a++) { + const array = arrays[a]; + + // instead of pushing, we just set the entries + for (let e = 0; e < array.length; e++) { + output[++index] = array[e]; + } + } + + return output; +} diff --git a/packages/util/src/array/index.ts b/packages/util/src/array/index.ts index 1c46734c5..b6c37ad77 100644 --- a/packages/util/src/array/index.ts +++ b/packages/util/src/array/index.ts @@ -5,4 +5,6 @@ * @summary Utility methods that operates on arrays */ +export { arrayChunk } from './chunk'; export { arrayFilter } from './filter'; +export { arrayFlatten } from './flatten';