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

  • T

Hierarchy (View Summary)

Constructors

constructor

Properties

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

Methods

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

Constructors

constructor

  • new default<T>(
        name?: string,
        options?: { default?: T | () => T; required?: boolean },
    ): default<T>

    SchemaType constructor.

    Type Parameters

    • T

    Parameters

    • name: string = ''
    • Optionaloptions: { default?: T | () => T; required?: boolean }

    Returns default<T>

Properties

default

default: () => T

name

name: string = ''

options

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

q$exists

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

Type declaration

    • (value: unknown, query: unknown, data?: unknown): boolean

    • Checks the existance of data.

      Parameters

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

      Returns boolean

q$max

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

Type declaration

    • (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
      • Optionaldata: unknown

      Returns boolean

q$min

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

Type declaration

    • (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
      • Optionaldata: unknown

      Returns boolean

Methods

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
    • Optionaldata: 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: T, query: unknown, data?: unknown): boolean

    Checks the equality of data.

    Parameters

    • value: T
    • query: unknown
    • Optionaldata: 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
    • Optionaldata: 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
    • Optionaldata: 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
    • Optionaldata: 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[]
    • Optionaldata: 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
    • Optionaldata: 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
    • Optionaldata: unknown

    Returns boolean

q$ne

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

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

    Parameters

    • value: T
    • 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[]
    • Optionaldata: 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
    • Optionaldata: 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
    • Optionaldata: unknown

    Returns T

validate

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

    Validates data. This function is used by setters.

    Parameters

    • value: unknown
    • Optionaldata: 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
    • Optionaldata: unknown

    Returns any

Settings

Member Visibility

On This Page

Constructors
Properties
Methods