Class default<I, T>

Array schema type.

Type Parameters

I
T extends default<I>

Hierarchy (view full)

default<I[]>
- default

Index

Constructors

constructor

new default<I, T>(name, options?): default<I, T>
Type Parameters
- I
- T extends default<I>
Parameters
- name: string
- Optional options: Partial<{
      default?: I[] | (() => I[]);
      required: boolean;
  }> & {
      child?: T;
  }
Returns default<I, T>
Overrides default.constructor
- Defined in types/array.ts:21

Properties

child

child: T

default

default: (() => I[])

Type declaration

- (): I[]
- Returns I[]

name

name: string = ''

options

options: {
    default?: I[] | (() => I[]);
    required: boolean;
} & {
    child?: T;
}

Type declaration

Optional default?: I[] | (() => I[])
required: boolean

Type declaration

Optional child?: T

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$length

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

Type declaration

- (value?, query?, data?): boolean
- Checks whether the number of elements in an array is equal to query.
  Parameters
  - Optional value: unknown[]
  - Optional 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

u$append

u$append: (<T>(value?, update?, data?) => T[])

Type declaration

- <T>(value?, update?, data?): T[]
- Add elements to an array.
  Type Parameters
  - T
  Parameters
  - Optional value: T[]
  - Optional update: T | T[]
  - Optional data: unknown
  Returns T[]

u$prepend

u$prepend: (<T>(value?, update?, data?) => T[])

Type declaration

- <T>(value?, update?, data?): T[]
- Add elements in front of an array.
  Type Parameters
  - T
  Parameters
  - Optional value: T[]
  - Optional update: T | T[]
  - Optional data: unknown
  Returns T[]

Methods

cast

cast(value_, data?): I[]
Casts an array and its child elements.
Parameters
- value_: unknown
- Optional data: unknown
Returns I[]
Overrides default.cast
- Defined in types/array.ts:36
cast(value_?, data?): I[]
Parameters
- Optional value_: unknown
- Optional data: unknown
Returns I[]
Overrides SchemaType.cast
- Defined in types/array.ts:37

compare

compare(a?, b?): number
Compares an array by its child elements and the size of the array.
Parameters
- Optional a: I[]
- Optional b: I[]
Returns number
Overrides default.compare
- Defined in types/array.ts:86

match

match(value?, query?, data?): boolean
Checks the equality of an array.
Parameters
- Optional value: I[]
- Optional query: unknown[]
- Optional data: unknown
Returns boolean
Overrides default.match
- Defined in types/array.ts:163

parse

parse(value): I[]
Parses data.
Parameters
- value: unknown[]
Returns I[]
Overrides default.parse
- Defined in types/array.ts:112
parse(): undefined
Returns undefined
Overrides SchemaType.parse
- Defined in types/array.ts:113

q$all

q$all<T>(value?, query?, data?): boolean
Checks whether an array contains all elements in query.
Type Parameters
- T
Parameters
- Optional value: T[]
- Optional query: T[]
- Optional data: unknown
Returns boolean
- Defined in types/array.ts:238

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 an array contains one of elements in query.
Parameters
- Optional value: unknown[]
- Optional query: unknown[]
- Optional data: unknown
Returns boolean
Overrides default.q$in
- Defined in types/array.ts:202

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: I[]
- query: unknown
- Optional data: unknown
Returns boolean
Inherited from default.q$ne
- Defined in schematype.ts:175

q$nin

q$nin<T>(value?, query?, data?): boolean
Checks whether an array does not contain in any elements in query.
Type Parameters
- T
Parameters
- Optional value: T[]
- Optional query: T[]
- Optional data: unknown
Returns boolean
Overrides default.q$nin
- Defined in types/array.ts:220

q$size

q$size(value?, query?, data?): boolean
Checks whether the number of elements in an array is equal to query.
Parameters
- Optional value: unknown[]
- Optional query: unknown
- Optional data: unknown
Returns boolean
- Defined in types/array.ts:190

u$addToSet

u$addToSet<T>(value?, update?, data?): T[]
Add elements to an array only if the value is not already in the array.
Type Parameters
- T
Parameters
- Optional value: T[]
- Optional update: T | T[]
- Optional data: unknown
Returns T[]
- Defined in types/array.ts:358

u$pop

u$pop<T>(value?, update?, data?): T[]
Removes the last element from an array.
Type Parameters
- T
Parameters
- Optional value: T[]
- Optional update: number | boolean
- Optional data: unknown
Returns T[]
- Defined in types/array.ts:336

u$pull

u$pull<T>(value?, update?, data?): T[]
Removes elements from an array.
Type Parameters
- T
Parameters
- Optional value: T[]
- Optional update: T | T[]
- Optional data: unknown
Returns T[]
- Defined in types/array.ts:298

u$push

u$push<T>(value?, update?, data?): T[]
Add elements to an array.
Type Parameters
- T
Parameters
- Optional value: T[]
- Optional update: T | T[]
- Optional data: unknown
Returns T[]
- Defined in types/array.ts:256

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$shift

u$shift<T>(value?, update?, data?): T[]
Removes the first element from an array.
Type Parameters
- T
Parameters
- Optional value: T[]
- Optional update: number | boolean
- Optional data: unknown
Returns T[]
- Defined in types/array.ts:316

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

u$unshift

u$unshift<T>(value?, update?, data?): T[]
Add elements in front of an array.
Type Parameters
- T
Parameters
- Optional value: T[]
- Optional update: T | T[]
- Optional data: unknown
Returns T[]
- Defined in types/array.ts:277

validate

validate(value_?, data?): I[]
Validates an array and its child elements.
Parameters
- Optional value_: unknown
- Optional data: unknown
Returns I[]
Overrides default.validate
- Defined in types/array.ts:61

value

value(value, data?): any[]
Transforms data.
Parameters
- value: unknown[]
- Optional data: unknown
Returns any[]
Overrides default.value
- Defined in types/array.ts:137
value(): undefined
Returns undefined
Overrides SchemaType.value
- Defined in types/array.ts:138

Class default<I, T>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns default<I, T>

Properties

child

default

Type declaration

Returns I[]

name

options

Type declaration

Optional default?: I[] | (() => I[])

required: boolean

Type declaration

Optional child?: T

q$exists

Type declaration

Parameters

Returns boolean

q$length

Type declaration

Parameters

Returns boolean

q$max

Type declaration

Parameters

Returns boolean

q$min

Type declaration

Parameters

Returns boolean

u$append

Type declaration

Type Parameters

Parameters

Returns T[]

u$prepend

Type declaration

Type Parameters

Parameters

Returns T[]

Methods

cast

Parameters

Returns I[]

Parameters

Returns I[]

compare

Parameters

Returns number

match

Parameters

Returns boolean

parse

Parameters

Returns I[]

Returns undefined

q$all

Type Parameters

Parameters

Returns boolean

q$exist

Parameters

Returns boolean

q$gt

Parameters

Returns boolean

q$gte

Parameters

Returns boolean

q$in

`Optional` default?: I[] | (() => I[])

`Optional` child?: T