rc-js-util/docs/rc-js-util.arraymax.md

A collection of TS and C++ utilities to help writing performant and correct applications, achieved through strict typing and (removable) invariant checking.

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [rc-js-util](./rc-js-util.md) &gt; [arrayMax](./rc-js-util.arraymax.md)

## arrayMax() function

Find the largest number in an array, if the array is empty the return is -Infinity.

**Signature:**

```typescript
export declare function arrayMax(numbers: ArrayLike<number>): number;
```

## Parameters

<table><thead><tr><th>

Parameter


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

numbers


</td><td>

ArrayLike&lt;number&gt;


</td><td>


</td></tr>
</tbody></table>
**Returns:**

number

## Remarks

See [arrayMax()](./rc-js-util.arraymax.md)<!-- -->.