Skip to content
This repository has been archived by the owner on Jul 6, 2024. It is now read-only.

Commit

Permalink
docs: add JSDoc of MultithreadArray
Browse files Browse the repository at this point in the history
  • Loading branch information
piquark6046 committed Mar 28, 2024
1 parent a835cc3 commit 6e4636d
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,14 @@ function ProcessMultithreadArrayParameters(Options: MultithreadArrayOptions) {
}
}

/**
* Splits an array into multiple subarrays based on the specified options.
* The reminder elements are added into the subarrays in order.
* @template T - The type of elements in the array.
* @param ArrayPara - The array to be split.
* @param Options - The options for splitting the array.
* @returns An array of subarrays, each containing a portion of the original array.
*/
export function MultithreadArray<T>(ArrayPara: T[], Options: MultithreadArrayOptions): T[][] {
ProcessMultithreadArrayParameters(Options)

Expand Down

0 comments on commit 6e4636d

Please sign in to comment.