Class default

Virtual schema type.

Hierarchy (view full)

default<any>
- default

Index

Constructors

Properties

default getter name options q$exists q$max q$min setter

Methods

cast compare get match parse q$exist q$gt q$gte q$in q$lt q$lte q$ne q$nin set u$rename u$set u$unset validate value

Constructors

constructor

new default(name?, options?): default
SchemaType constructor.
Parameters
- name: string = ''
- Optional options: {
  default?: any;
  required?: boolean;
  }
  - Optional default?: any
  - Optional required?: boolean
Returns default
Inherited from default.constructor
- Defined in schematype.ts:59

Properties

default

default: (() => any)

Type declaration

- (): any
- Returns any

getter

getter: (() => any)

Type declaration

- (): any
- Returns any

name

name: string = ''

options

options: {
default?: any;
required: boolean;
}

Type declaration

Optional default?: any
required: boolean

q$exists

q$exists: ((value, query, data?) => boolean)

Type declaration

- (value, query, data?): boolean
- Checks the existance of data.
  Parameters
  - value: unknown
  - query: unknown
  - Optional data: unknown
  Returns boolean

q$max

q$max: ((value, query, data?) => boolean)

Type declaration

- (value, query, data?): 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$min

q$min: ((value, query, data?) => boolean)

Type declaration

- (value, query, data?): boolean
- Checks whether value is greater than or equal to (i.e. >=) the query.
  Parameters
  - value: unknown
  - query: unknown
  - Optional data: unknown
  Returns boolean

setter

setter: ((value) => void)

Type declaration

- (value): void
- Parameters
  - value: any
  Returns void

Methods

cast

cast(value, data): void
Applies getters.
Parameters
- value: unknown
- data: any
Returns void
Overrides default.cast
- Defined in types/virtual.ts:50

compare

compare(a, b): number
Compares data. This function is used when sorting.
Parameters
- a: unknown
- b: unknown
Returns number
Inherited from default.compare
- Defined in schematype.ts:111

get

get(fn): default
Add a getter.
Parameters
- fn: (() => any)
  - - (): any
    - Returns any
Returns default
Chainable
- Defined in types/virtual.ts:17

match

match(value, query, data?): boolean
Checks the equality of data.
Parameters
- value: any
- query: unknown
- Optional data: unknown
Returns boolean
Inherited from default.match
- Defined in schematype.ts:151

parse

parse(value): any
Parses data. This function is used when restoring data from database files.
Parameters
- value: unknown
Returns any
Inherited from default.parse
- Defined in schematype.ts:128

q$exist

q$exist(value, query, data?): boolean
Checks the existance of data.
Parameters
- value: unknown
- query: unknown
- Optional data: unknown
Returns boolean
Inherited from default.q$exist
- Defined in schematype.ts:163

q$gt

q$gt(value, query, data?): boolean
Checks whether value is greater than (i.e. >) the query.
Parameters
- value: unknown
- query: unknown
- Optional data: unknown
Returns boolean
Inherited from default.q$gt
- Defined in schematype.ts:211

q$gte

q$gte(value, query, data?): boolean
Checks whether value is greater than or equal to (i.e. >=) the query.
Parameters
- value: unknown
- query: unknown
- Optional data: unknown
Returns boolean
Inherited from default.q$gte
- Defined in schematype.ts:223

q$in

q$in(value, query, data?): boolean
Checks whether value is equal to one of elements in query.
Parameters
- value: unknown
- query: unknown[]
- Optional data: unknown
Returns boolean
Inherited from default.q$in
- Defined in schematype.ts:235

q$lt

q$lt(value, query, data?): boolean
Checks whether value is less than (i.e. <) the query.
Parameters
- value: unknown
- query: unknown
- Optional data: unknown
Returns boolean
Inherited from default.q$lt
- Defined in schematype.ts:187

q$lte

q$lte(value, query, data?): boolean
Checks whether value is less than or equal to (i.e. <=) the query.
Parameters
- value: unknown
- query: unknown
- Optional data: unknown
Returns boolean
Inherited from default.q$lte
- Defined in schematype.ts:199

q$ne

q$ne(value, query, data?): boolean
Checks the equality of data. Returns true if the value doesn't match.
Parameters
- value: any
- query: unknown
- Optional data: unknown
Returns boolean
Inherited from default.q$ne
- Defined in schematype.ts:175

q$nin

q$nin(value, query, data?): boolean
Checks whether value is not equal to any elements in query.
Parameters
- value: unknown
- query: unknown[]
- Optional data: unknown
Returns boolean
Inherited from default.q$nin
- Defined in schematype.ts:247

set

set(fn): default
Add a setter.
Parameters
- fn: ((value) => void)
  - - (value): void
    - Parameters
      value: any
      Returns void
Returns default
Chainable
- Defined in types/virtual.ts:33

u$rename

u$rename(value, update, data): void
Renames a field.
Parameters
- value: unknown
- update: unknown
- data: unknown
Returns void
Inherited from default.u$rename
- Defined in schematype.ts:281

u$set

u$set<T>(value, update, data?): T
Sets the value.
Type Parameters
- T
Parameters
- value: unknown
- update: T
- Optional data: unknown
Returns T
Inherited from default.u$set
- Defined in schematype.ts:259

u$unset

u$unset<T>(value, update, data?): T
Unsets the value.
Type Parameters
- T
Parameters
- value: T
- update: boolean
- Optional data: unknown
Returns T
Inherited from default.u$unset
- Defined in schematype.ts:271

validate

validate(value, data): void
Applies setters.
Parameters
- value: any
- data: any
Returns void
Overrides default.validate
- Defined in types/virtual.ts:73

value

value(value, data?): any
Transforms value. This function is used when saving data to database files.
Parameters
- value: unknown
- Optional data: unknown
Returns any
Inherited from default.value
- Defined in schematype.ts:139