Class NedbStore

constructor

• new NedbStore(options?: NedbStoreOptions): NedbStore

  Parameters

  • options: NedbStoreOptions = {}

  Returns NedbStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): NedbClientLike

  Returns the underlying nedb Datastore for anything not wrapped here.

  Returns NedbClientLike

put

• put(key: string, value: Record<string, unknown>): Promise<NedbDoc>

  Writes a document keyed by _id = key. Maps onto NeDB's insert, merging key into the document as its _id.

  Parameters

  • key: string
  • value: Record<string, unknown>

  Returns Promise<NedbDoc>

get

• get(key: string): Promise<NedbDoc | null>

  Reads a document by _id (NeDB findOne({ _id })). Returns null if absent.

  Parameters

  • key: string

  Returns Promise<NedbDoc | null>

del

• del(key: string): Promise<number>

  Deletes a document by _id (NeDB remove({ _id })). Returns the number removed.

  Parameters

  • key: string

  Returns Promise<number>

insert

• insert(doc: NedbDoc): Promise<NedbDoc>

  Native insert: adds a document (NeDB assigns an _id if omitted).

  Parameters

  • doc: NedbDoc

  Returns Promise<NedbDoc>

find

• find(query?: Record<string, unknown>): Promise<NedbDoc[]>

  Native find: returns every document matching the Mongo-style query.

  Parameters

  • query: Record<string, unknown> = {}

  Returns Promise<NedbDoc[]>

batch

• batch(ops: NedbBatchOp[]): Promise<void>

  Applies a list of put/del operations sequentially.

  Parameters

  • ops: NedbBatchOp[]

  Returns Promise<void>

list

• list(): Promise<string[]>

  Lists all document _ids (via find({})).

  Returns Promise<string[]>