Class DocumentModel

_{Declared in packages/core/echo/document-model/dist/types/src/document-model.d.ts:33}

Object mutation model.

Constructors

constructor(_meta, _itemId, _getState, [_mutationWriter])

Returns: DocumentModel

Arguments:

_meta: ModelMeta<any, any, any>

_itemId: string

_getState: function

_mutationWriter: MutationWriter<ObjectMutationSet>

Properties

_getState

Type: function

meta

Type: ModelMeta<any, any, any>

itemId

Type: string

modelMeta

Type: ModelMeta<any, any, any>

readOnly

Type: boolean

type

Type: undefined | string

Methods

addToSet(key, value)

Returns: Promise<void>

Arguments:

key: string

value: any

builder()

Returns: MutationBuilder

Arguments: none

get(key, [defaultValue])

Returns: any

Arguments:

key: string

defaultValue: unknown

getProperty(key, [defaultValue])

Returns: any

Arguments:

key: string

defaultValue: any

pushToArray(key, value)

Returns: Promise<void>

Arguments:

key: string

value: any

removeFromSet(key, value)

Returns: Promise<void>

Arguments:

key: string

value: any

set(key, value)

Returns: Promise<void>

Arguments:

key: string

value: unknown

setProperties(properties)

Returns: Promise<void>

Arguments:

properties: any

setProperty(key, value)

Returns: Promise<void>

Arguments:

key: string

value: any

toJSON()

Returns: object

Arguments: none

toObject()

Returns an immutable object.

Returns: Record<string, any>

Arguments: none

toString()

Returns: string

Arguments: none

write(mutation)

Writes the raw mutation to the output stream.

Returns: Promise<MutationWriteReceipt>

Arguments:

mutation: ObjectMutationSet