Class default<T>

This is the basic schema type. All schema types should inherit from this class. For example:

class SchemaTypeCustom extends SchemaType {};

Query operators

To add a query operator, defines a method whose name is started with q$. For example:

SchemaTypeCustom.q$foo = function(value, query, data){
  // ...
};

The value parameter is the value of specified field; the query parameter is the value passed to the query operator; the data parameter is the complete data.

The return value must be a boolean indicating whether the data passed.

Update operators

To add a update operator, defines a method whose name is started with u$. For example:

SchemaTypeCustom.u$foo = function(value, update, data){
  // ...
};

The value parameter is the value of specified field; the update parameter is the value passed to the update operator; the data parameter is the complete data.

The return value will replace the original data.

Type Parameters

Hierarchy (view full)

default

Index

Constructors

constructor

new default<T>(name?, options?): default<T>
SchemaType constructor.
Type Parameters
- T
Parameters
- name: string = ''
- Optional options: {
  default?: T | (() => T);
  required?: boolean;
  }
  - Optional default?: T | (() => T)
  - Optional required?: boolean
Returns default<T>
- Defined in schematype.ts:59

Properties

default

default: (() => T)

Type declaration

- (): T
- Returns T

name

name: string = ''

options

options: {
default?: T | (() => T);
required: boolean;
}

Type declaration

Optional default?: T | (() => T)
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

Methods

cast

cast(value?, data?): 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
- Optional value: unknown
- Optional data: unknown
Returns unknown
- Defined in schematype.ts:81

compare

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

match

match(value, query, data?): boolean
Checks the equality of data.
Parameters
- value: T
- query: unknown
- Optional data: unknown
Returns boolean
- 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
- 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
- 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
- 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
- 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
- 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
- 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
- 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: T
- query: unknown
- Optional data: unknown
Returns boolean
- 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
- Defined in schematype.ts:247

u$rename

u$rename(value, update, data): void
Renames a field.
Parameters
- value: unknown
- update: unknown
- data: unknown
Returns void
- 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
- 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
- Defined in schematype.ts:271

validate

validate(value, data?): unknown
Validates data. This function is used by setters.
Parameters
- value: unknown
- Optional data: unknown
Returns unknown
- Defined in schematype.ts:96

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
- Defined in schematype.ts:139

Class default<T>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Optional default?: T | (() => T)

Optional required?: boolean

Returns default<T>

Properties

default

Type declaration

Returns T

name

options

Type declaration

Optional default?: T | (() => T)

required: boolean

q$exists

Type declaration

Parameters

Returns boolean

q$max

Type declaration

Parameters

Returns boolean

q$min

Type declaration

Parameters

Returns boolean

Methods

cast

Parameters

Returns unknown

compare

Parameters

Returns number

match

Parameters

Returns boolean

parse

Parameters

Returns any

q$exist

Parameters

Returns boolean

q$gt

Parameters

Returns boolean

q$gte

Parameters

Returns boolean

q$in

Parameters

Returns boolean

q$lt

Parameters

Returns boolean

q$lte

Parameters

Returns boolean

q$ne

Parameters

Returns boolean

q$nin

Parameters

Returns boolean

u$rename

Parameters

Returns void

u$set

Type Parameters

Parameters

Returns T

u$unset

`Optional` default?: T | (() => T)

`Optional` required?: boolean

`Optional` default?: T | (() => T)