voluptasmollitia/docs-exp/firestore_lite.arrayremove.md

Monorepo for the Firebase JavaScript SDK

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

[Home](./index.md) &gt; [@firebase/firestore](./firestore.md) &gt; [lite](./firestore_lite.md) &gt; [arrayRemove](./firestore_lite.arrayremove.md)

## arrayRemove() function

Returns a special value that can be used with [setDoc()](./firestore_.setdoc.md) or  that tells the server to remove the given elements from any array value that already exists on the server. All instances of each element specified will be removed from the array. If the field being modified is not already an array it will be overwritten with an empty array.

<b>Signature:</b>

```typescript
export declare function arrayRemove(...elements: unknown[]): FieldValue;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  elements | unknown\[\] | The elements to remove from the array. |

<b>Returns:</b>

[FieldValue](./firestore_lite.fieldvalue.md)

The `FieldValue` sentinel for use in a call to `setDoc()` or `updateDoc()`