2020-03-29 13:43:52 +00:00
|
|
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
|
|
|
|
[Home](./index.md) > [@apextoaster/js-utils](./js-utils.md) > [ArrayMapper](./js-utils.arraymapper.md)
|
|
|
|
|
|
|
|
## ArrayMapper class
|
|
|
|
|
2020-03-31 13:29:47 +00:00
|
|
|
Map an array of items into a map of arrays using the specified keys, able to `skip` initial items and gather remaining items into a `rest` key.
|
|
|
|
|
2020-03-29 13:43:52 +00:00
|
|
|
<b>Signature:</b>
|
|
|
|
|
|
|
|
```typescript
|
|
|
|
export declare class ArrayMapper
|
|
|
|
```
|
|
|
|
|
|
|
|
## Constructors
|
|
|
|
|
|
|
|
| Constructor | Modifiers | Description |
|
|
|
|
| --- | --- | --- |
|
|
|
|
| [(constructor)(options)](./js-utils.arraymapper._constructor_.md) | | Constructs a new instance of the <code>ArrayMapper</code> class |
|
|
|
|
|
|
|
|
## Properties
|
|
|
|
|
|
|
|
| Property | Modifiers | Type | Description |
|
|
|
|
| --- | --- | --- | --- |
|
2022-10-08 19:52:35 +00:00
|
|
|
| [rest](./js-utils.arraymapper.rest.md) | <code>readonly</code> | string | |
|
|
|
|
| [skip](./js-utils.arraymapper.skip.md) | <code>readonly</code> | number | |
|
|
|
|
| [take](./js-utils.arraymapper.take.md) | <code>readonly</code> | Array<string> | |
|
2020-03-29 13:43:52 +00:00
|
|
|
|
|
|
|
## Methods
|
|
|
|
|
|
|
|
| Method | Modifiers | Description |
|
|
|
|
| --- | --- | --- |
|
2020-03-31 13:49:18 +00:00
|
|
|
| [map(input)](./js-utils.arraymapper.map.md) | | Transform the input list into a map, extracting elements using the mapper's options. |
|
2020-03-29 13:43:52 +00:00
|
|
|
|