Class default

default

name

options

q$exists

q$max

q$min

cast

• cast(value?: unknown, _data?: unknown): unknown

  Casts data. This function is used by getters to cast an object to document instances. If the value is null, the default value will be returned.

  Parameters

  • Optionalvalue: unknown
  • Optional_data: unknown

  Returns unknown

compare

• compare(a: unknown, b: unknown): number

  Compares data. This function is used when sorting.

  Parameters

  • a: unknown
  • b: unknown

  Returns number

match

• match(value: Record, query: unknown, _data?: unknown): boolean

  Checks the equality of data.

  Parameters

  • value: Record
  • query: unknown
  • Optional_data: unknown

  Returns boolean

parse

• parse(value: unknown): any

  Parses data. This function is used when restoring data from database files.

  Parameters

  • value: unknown

  Returns any

q$exist

• q$exist(value: unknown, query: unknown, _data?: unknown): boolean

  Checks the existance of data.

  Parameters

  • value: unknown
  • query: unknown
  • Optional_data: unknown

  Returns boolean

q$gt

• q$gt(value: unknown, query: unknown, _data?: unknown): boolean

  Checks whether value is greater than (i.e. >) the query.

  Parameters

  • value: unknown
  • query: unknown
  • Optional_data: unknown

  Returns boolean

q$gte

• q$gte(value: unknown, query: unknown, _data?: unknown): boolean

  Checks whether value is greater than or equal to (i.e. >=) the query.

  Parameters

  • value: unknown
  • query: unknown
  • Optional_data: unknown

  Returns boolean

q$in

• q$in(value: unknown, query: unknown[], _data?: unknown): boolean

  Checks whether value is equal to one of elements in query.

  Parameters

  • value: unknown
  • query: unknown[]
  • Optional_data: unknown

  Returns boolean

q$lt

• q$lt(value: unknown, query: unknown, _data?: unknown): boolean

  Checks whether value is less than (i.e. <) the query.

  Parameters

  • value: unknown
  • query: unknown
  • Optional_data: unknown

  Returns boolean

q$lte

• q$lte(value: unknown, query: unknown, _data?: unknown): boolean

  Checks whether value is less than or equal to (i.e. <=) the query.

  Parameters

  • value: unknown
  • query: unknown
  • Optional_data: unknown

  Returns boolean

q$ne

• q$ne(value: Record, query: unknown, data?: unknown): boolean

  Checks the equality of data. Returns true if the value doesn't match.

  Parameters

  • value: Record
  • query: unknown
  • Optionaldata: unknown

  Returns boolean

q$nin

• q$nin(value: unknown, query: unknown[], _data?: unknown): boolean

  Checks whether value is not equal to any elements in query.

  Parameters

  • value: unknown
  • query: unknown[]
  • Optional_data: unknown

  Returns boolean

u$rename

• u$rename(value: unknown, update: string, data: unknown): void

  Renames a field.

  Parameters

  • value: unknown
  • update: string
  • data: unknown

  Returns void

u$set

• u$set<T>(value: unknown, update: T, _data?: unknown): T

  Sets the value.

  Type Parameters

  • T

  Parameters

  • value: unknown
  • update: T
  • Optional_data: unknown

  Returns T

u$unset

• u$unset<T>(value: T, update: boolean, _data?: unknown): T

  Unsets the value.

  Type Parameters

  • T

  Parameters

  • value: T
  • update: boolean
  • Optional_data: unknown

  Returns T

validate

• validate(value: unknown, _data?: unknown): unknown

  Validates data. This function is used by setters.

  Parameters

  • value: unknown
  • Optional_data: unknown

  Returns unknown

value

• value(value: unknown, _data?: unknown): any

  Transforms value. This function is used when saving data to database files.

  Parameters

  • value: unknown
  • Optional_data: unknown

  Returns any