DatastoreEditor

datastore.DatastoreEditor

Mutable batch view of a datastore: queue set / remove / clear calls inside Datastore.edit / editSync. Changes are persisted when that callback returns (async edit waits for the returned Promise if any).

Table of contents

Methods

• clear
• remove
• set

Methods

clear

clear(): DatastoreEditor

Marks every key for deletion when the edit is committed.

Returns

DatastoreEditor — this for chaining.

remove

remove(key: string): DatastoreEditor

Queues key for removal on commit.

Parameters

• key: Key to remove.

Returns

DatastoreEditor — this for chaining.

set

set<T>(key: string, value: T): DatastoreEditor

Queues value for key; values are serialized when the edit is flushed to disk.

Parameters

• key: Key to write.
• value: Value to store (must be compatible with the datastore serializer).

Returns

DatastoreEditor — this for chaining.