Class Schema<T>

Type parameters

T: {} = any

Hierarchy

Schema

Index

Constructors

constructor

Properties

Accessors

[Symbol.toStringTag]

Methods

Constructors

constructor

new Schema(fields?: Field[], metadata?: Map<string, string> | null, dictionaries?: Map<number, DataType> | null): Schema

- Defined in src/schema.ts:49
Parameters
- Default value fields: Field[] = []
- Optional metadata: Map<string, string> | null
- Optional dictionaries: Map<number, DataType> | null
Returns Schema

Properties

Readonly dictionaries

dictionaries: Map<number, DataType>

Readonly fields

fields: Field<T[keyof T]>[]

Readonly metadata

metadata: Map<string, string>

Accessors

[Symbol.toStringTag]

get [Symbol.toStringTag](): string

- Defined in src/schema.ts:61
Returns string

Methods

assign

assign<R>(schema: Schema<R>): Schema<T & R>
assign<R>(...fields: (Field<R[keyof R]> | Field<R[keyof R]>[])[]): Schema<T & R>

- Defined in src/schema.ts:78
Type parameters
- R: {} = any
Parameters
- schema: Schema<R>
Returns Schema<T & R>
- Defined in src/schema.ts:79
Type parameters
- R: {} = any
Parameters
- Rest ...fields: (Field<R[keyof R]> | Field<R[keyof R]>[])[]
Returns Schema<T & R>

compareTo

compareTo(other?: Schema | null): other is Schema<T>

- Defined in src/schema.ts:66
Parameters
- Optional other: Schema | null
Returns other is Schema<T>

select

select<K>(...columnNames: K[]): Schema<{}>

- Defined in src/schema.ts:70
Type parameters
- K: keyof T = any
Parameters
- Rest ...columnNames: K[]
Returns Schema<{}>

selectAt

selectAt<K>(...columnIndices: number[]): Schema<{}>

- Defined in src/schema.ts:74
Type parameters
- K: T[keyof T] = any
Parameters
- Rest ...columnIndices: number[]
Returns Schema<{}>

toString

toString(): string

- Defined in src/schema.ts:62
Returns string

Static from

from<T>(children: T): Schema<T>
from<T>(children: T): Schema<{}>
from<T>(children: ChildData<T>, fields?: Fields<T>): Schema<T>

- Defined in src/schema.ts:31
nocollapse

Type parameters
- T: {} = any
Parameters
- children: T
Returns Schema<T>
- Defined in src/schema.ts:32
nocollapse

Type parameters
- T: VectorMap = any
Parameters
- children: T
Returns Schema<{}>
- Defined in src/schema.ts:33
nocollapse

Type parameters
- T: {} = any
Parameters
- children: ChildData<T>
- Optional fields: Fields<T>
Returns Schema<T>

Static new

new<T>(children: T): Schema<T>
new<T>(children: T): Schema<{}>
new<T>(children: ChildData<T>, fields?: Fields<T>): Schema<T>

- Defined in src/schema.ts:39
nocollapse

Type parameters
- T: {} = any
Parameters
- children: T
Returns Schema<T>
- Defined in src/schema.ts:40
nocollapse

Type parameters
- T: VectorMap = any
Parameters
- children: T
Returns Schema<{}>
- Defined in src/schema.ts:41
nocollapse

Type parameters
- T: {} = any
Parameters
- children: ChildData<T>
- Optional fields: Fields<T>
Returns Schema<T>

Generated using TypeDoc