2020-03-29 14:10:40 +00:00
|
|
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
|
|
|
|
|
|
[Home](./index.md) > [@apextoaster/js-utils](./js-utils.md) > [getHead](./js-utils.gethead.md)
|
|
|
|
|
|
|
|
|
|
## getHead() function
|
|
|
|
|
|
2020-03-31 13:29:47 +00:00
|
|
|
Get the first element from the specified key within a map of lists.
|
|
|
|
|
|
2020-03-29 14:10:40 +00:00
|
|
|
<b>Signature:</b>
|
|
|
|
|
|
|
|
|
|
```typescript
|
|
|
|
|
export declare function getHead<TKey, TVal>(map: Map<TKey, Array<TVal>>, key: TKey): TVal;
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Parameters
|
|
|
|
|
|
|
|
|
|
| Parameter | Type | Description |
|
|
|
|
|
| --- | --- | --- |
|
|
|
|
|
| map | <code>Map<TKey, Array<TVal>></code> | |
|
|
|
|
|
| key | <code>TKey</code> | |
|
|
|
|
|
|
|
|
|
|
<b>Returns:</b>
|
|
|
|
|
|
|
|
|
|
`TVal`
|
|
|
|
|
|
