Interface Options

Data deserialization options passed to deserializer.

Hierarchy

Properties

data? entities? formats? onError? onMeta?

Properties

Optional Readonly data

data?: Record<PropertyKey, unknown>

Custom deserialization data.

This data can be used by deserializers and handlers.

Optional Readonly entities

entities?: {
    [entity: string]: EntityUcrx | undefined;
}

Map of recognized entity receivers.

By default, entities will be deserialized by compiler.

Type declaration

Optional Readonly formats

formats?: {
    [entity: string]: FormatUcrx | undefined;
}

Map of recognized formatted data receivers.

By default, formatted data will be deserialized by compiler.

Type declaration

Optional Readonly onError

onError?: ((this, error) => void)

Type declaration

    • (this, error): void

    • Function to call to report deserialization error.

      By default, throws an churi!UcError with the given error info.

      Parameters

      Returns void

Optional Readonly onMeta

onMeta?: MetaUcrx

Function to call to deserialize metadata attribute.

By default, metadata attribute value will be deserialized as unknown.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc