Class Schema

_{Declared in packages/core/echo/echo-db/dist/types/src/packlets/api/schema.d.ts:21}

Wrapper for ECHO Item that represents an DocumentModel schema.

Constructors

constructor(_schema)

Returns: Schema

Arguments:

_schema: DocumentModel

Properties

fields

Type: SchemaField[]

name

Type: string

Methods

addField(newField)

Returns: Promise<void>

Arguments:

newField: SchemaField

deleteField(key)

Returns: Promise<void>

Arguments:

key: string

editField(currentKey, editedField)

Returns: Promise<void>

Arguments:

currentKey: string

editedField: SchemaField

getField(key)

Returns: undefined | SchemaField

Arguments:

key: string

validate(model)

Returns: boolean

Arguments:

model: DocumentModel