@rivyn/db

---

@rivyn/db / RivynClient

Class: RivynClient

Constructors

Constructor

new RivynClient(options): RivynClient

Parameters

options

ClientOptions

Returns

RivynClient

Accessors

serverInfo

Get Signature

get serverInfo(): ServerInfo | null

Returns

ServerInfo | null

Methods

close()

close(): void

Returns

void

---

collection()

collection<T>(name): Collection<T>

Type Parameters

T

T extends object = Record<string, unknown>

Parameters

name

string

Returns

Collection<T>

---

collections()

collections(): Promise<CollectionInfo[]>

Returns

Promise<CollectionInfo[]>

---

connect()

connect(): Promise<ServerInfo>

Returns

Promise<ServerInfo>

---

dropCollection()

dropCollection(name): Promise<boolean>

Parameters

name

string

Returns

Promise<boolean>

---

model()

model<T>(name, schema): Model<T>

Type Parameters

T

T extends object = Record<string, unknown>

Parameters

name

string

schema

Schema

Returns

Model<T>

---

off()

off(event, listener): this

Parameters

event

ClientEvent

listener

(...args) => void

Returns

this

---

on()

on(event, listener): this

Parameters

event

ClientEvent

listener

(...args) => void

Returns

this

---

once()

once(event, listener): this

Parameters

event

ClientEvent

listener

(...args) => void

Returns

this

---

ping()

ping(): Promise<"pong">

Returns

Promise<"pong">

---

stats()

stats(): Promise<ServerStats>

Returns

Promise<ServerStats>