Class Schema<T>

Type parameters

T: {} = any

Hierarchy

Schema

Index

Constructors

constructor

Properties

Accessors

[Symbol.toStringTag]

Methods

Constructors

constructor

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

- Defined in schema.ts:24
Type parameters
- T: {} = any
Parameters
- fields: Field<any>[] = []
- Optional metadata: null | Map<string, string>
- Optional dictionaries: null | Map<number, DataType<Type, any>>
Returns Schema<T>

Properties

Readonly dictionaries

dictionaries: Map<number, DataType<Type, any>>

Readonly fields

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

Readonly metadata

metadata: Map<string, string>

Accessors

[Symbol.toStringTag]

get [Symbol.toStringTag](): string

- Defined in schema.ts:36
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 schema.ts:49
Type parameters
- R: {} = any
Parameters
- schema: Schema<R>
Returns Schema<T & R>
- Defined in schema.ts:50
Type parameters
- R: {} = any
Parameters
- Rest ...fields: (Field<R[keyof R]> | Field<R[keyof R]>[])[]
Returns Schema<T & R>

select

select<K>(...columnNames: K[]): Schema<{[ P in string | number | symbol]: T[P] }>

- Defined in schema.ts:41
Type parameters
- K: string | number | symbol = any
Parameters
- Rest ...columnNames: K[]
Returns Schema<{[ P in string | number | symbol]: T[P] }>

selectAt

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

- Defined in schema.ts:45
Type parameters
- K: DataType<Type, any, K> = any
Parameters
- Rest ...columnIndices: number[]
Returns Schema<{}>

toString

toString(): string

- Defined in schema.ts:37
Returns string

Generated using TypeDoc