Class Schema

Hierarchy

Schema

Constructors

constructor

new Schema(opts?: SchemaOpts): Schema

Parameters
- opts: SchemaOpts = {}
Returns Schema

Methods

Entity

Entity(records: Record[]): Entity

Parameters
- records: Record[]
Returns Entity

Record

Record(record: any): Record

Parameters
- record: any
Returns Record

RecordVersion

RecordVersion(recordVersion: any): RecordVersion

Parameters
- recordVersion: any
Returns RecordVersion

_addFieldForType

_addFieldForType(type: Type, spec: FieldSpec): Field

Parameters
- type: Type
- spec: FieldSpec
Returns Field

_parseSchemaPath

_parseSchemaPath(address: string): SchemaPath

Parameters
- address: string
Returns SchemaPath

addType

addType(spec: TypeSpecInput, opts?: AddTypeOpts): Type

Parameters
- spec: TypeSpecInput
- opts: AddTypeOpts = {}
Returns Type

addTypes

addTypes(spec: any[] | TypeSpec): void

Parameters
- spec: any[] | TypeSpec
Returns void

build

build(strict?: boolean): void

Parameters
- strict: boolean = true
Returns void

defaultNamespace

defaultNamespace(): string

Returns string

getField

getField(address: string): undefined | Field

Parameters
- address: string
Returns undefined | Field

getType

getType(address: string): undefined | Type

Parameters
- address: string
Returns undefined | Type

getTypes

getTypes(): Type[]

Returns Type[]

hasField

hasField(address: string): boolean

Parameters
- address: string
Returns boolean

hasType

hasType(address: string): boolean

Parameters
- address: string
Returns boolean

resolveFieldAddress

resolveFieldAddress(address: string, type?: Type): string

Parameters
- address: string
- Optional type: Type
Returns string

resolveTypeAddress

resolveTypeAddress(address: string): string

Parameters
- address: string
Returns string

setDefaultNamespace

setDefaultNamespace(namespace: string): void

Parameters
- namespace: string
Returns void

toJSON

toJSON(): SchemaSpec

Returns SchemaSpec

`Static` fromJSON

fromJSON(json: SchemaSpec, opts?: SchemaOpts): Schema

Parameters
- json: SchemaSpec
- opts: SchemaOpts = {}
Returns Schema

Generated using TypeDoc