Skip to content

Commit ed125f5

Browse files
authored
Merge pull request #1031 from julianfssen/add-delete-all-to-createentityadapter-docs
2 parents 4d74ce2 + ef81335 commit ed125f5

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

docs/api/createEntityAdapter.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,7 @@ The primary content of an entity adapter is a set of generated reducer functions
206206
- `setAll`: accepts an array of entities or an object in the shape of `Record<EntityId, T>`, and replaces the existing entity contents with the values in the array.
207207
- `removeOne`: accepts a single entity ID value, and removes the entity with that ID if it exists.
208208
- `removeMany`: accepts an array of entity ID values, and removes each entity with those IDs if they exist.
209+
- `removeAll`: removes all entities from the entity state object.
209210
- `updateOne`: accepts an "update object" containing an entity ID and an object containing one or more new field values to update inside a `changes` field, and performs a shallow update on the corresponding entity.
210211
- `updateMany`: accepts an array of update objects, and performs shallow updates on all corresponding entities.
211212
- `upsertOne`: accepts a single entity. If an entity with that ID exists, it will perform a shallow update and the specified fields will be merged into the existing entity, with any matching fields overwriting the existing values. If the entity does not exist, it will be added.

0 commit comments

Comments
 (0)