Class PersistApi

Index

Constructors

Methods

delete find findById isConnected save

Constructors

constructor

new PersistApi(): PersistApi
Returns PersistApi

Methods

`Static`delete

delete(collection: string, id: string): Promise<void>
Delete the document with id from collection.
Parameters
- collection: string
- id: string
Returns Promise<void>
- Defined in packages/server/src/mud/api/persist.ts:62

`Static`find

find(
collection: string,
query: Record<string, unknown>,
): Promise<Record<string, unknown>[]>
Documents in collection matching query.
Parameters
- collection: string
- query: Record<string, unknown>
Returns Promise<Record<string, unknown>[]>
- Defined in packages/server/src/mud/api/persist.ts:38

`Static`findById

findById(
collection: string,
id: string,
): Promise<Record<string, unknown> | null>
One document by Mongo _id, or null.
Parameters
- collection: string
- id: string
Returns Promise<Record<string, unknown> | null>
- Defined in packages/server/src/mud/api/persist.ts:46

`Static`isConnected

isConnected(): boolean
Whether the Mongo connection is live (the no-op-when-offline guard).

Returns boolean
- Defined in packages/server/src/mud/api/persist.ts:33

`Static`save

save(collection: string, doc: Record<string, unknown>): Promise<string>
Upsert doc into collection; returns its id.
Parameters
- collection: string
- doc: Record<string, unknown>
Returns Promise<string>
- Defined in packages/server/src/mud/api/persist.ts:54