rc-js-util/docs/rc-js-util.arrayreplaceone.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; [arrayReplaceOne](./rc-js-util.arrayreplaceone.md)

## arrayReplaceOne() function

Replaces the first match of itemToRemove with replaceWith.

**Signature:**

```typescript
export declare function arrayReplaceOne<TItem>(items: TItem[], itemToRemove: TItem, replaceWith: TItem): boolean;
```

## Parameters

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

Parameter


</th><th>

Type


</th><th>

Description


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

items


</td><td>

TItem\[\]


</td><td>


</td></tr>
<tr><td>

itemToRemove


</td><td>

TItem


</td><td>


</td></tr>
<tr><td>

replaceWith


</td><td>

TItem


</td><td>


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

boolean

true if an element was replaced.

## Remarks

See [arrayReplaceOne()](./rc-js-util.arrayreplaceone.md)<!-- -->.