Module db/driver

Index

Functions

Functions

getAll

getAll(lean?: boolean): Promise<DaemonDocument[]>

- Defined in src/db/driver.ts:10
Returns all daemons in the database.

Parameters
- Optional lean: boolean
  
  Whether to return dehydrated Mongoose documents (faster). (See: https://mongoosejs.com/docs/tutorials/lean.html)
Returns Promise<DaemonDocument[]>

Array of Daemon objects.

getByMac

getByMac(mac: string, lean?: boolean): Promise<DaemonDocument | null>

- Defined in src/db/driver.ts:23
Returns a daemon by searching for its MAC address, and returns null if not found.

Parameters
- mac: string
- Optional lean: boolean
  
  Whether to return dehydrated Mongoose documents (faster). (See: https://mongoosejs.com/docs/tutorials/lean.html)
Returns Promise<DaemonDocument | null>

Daemon object.

getByToken

getByToken(token?: string, lean?: boolean): Promise<DaemonDocument | null>

- Defined in src/db/driver.ts:36
Returns a daemon by searching for its token, and returns null if not found.

Parameters
- Optional token: string
  
  Daemon token to search by.
- Optional lean: boolean
  
  Whether to return dehydrated Mongoose documents (faster). (See: https://mongoosejs.com/docs/tutorials/lean.html)
Returns Promise<DaemonDocument | null>

Daemon object.

insert

insert(daemon: default): Promise<void>

- Defined in src/db/driver.ts:47
Inserts a new Daemon into the database.

Parameters
- daemon: default
  
  {@link Daemon} to insert
Returns Promise<void>

remove

remove(oldDaemon: DaemonDocument): Promise<void>

- Defined in src/db/driver.ts:66
Removes a Daemon.

Parameters
- oldDaemon: DaemonDocument
  
  {@link Daemon} to remove
Returns Promise<void>

update

update(oldDaemon: DaemonDocument, newDaemon: DaemonDocument): Promise<void>

- Defined in src/db/driver.ts:57
Updates a Daemon.

Parameters
- oldDaemon: DaemonDocument
  
  {@link Daemon} to update
- newDaemon: DaemonDocument
  
  {@link Daemon} with new, updated data
Returns Promise<void>

Generated using TypeDoc