ViewConnectOptions interface

Namespace @runic-artifex/views/generated · @runic-artifex/views 0.7.0-preview.5

interface ViewConnectOptions<TState>

How a generated module connects one ViewModel route.

Properties

contract

readonly contract: string;

{ViewModel full name}:{contract fingerprint}.

route

readonly route: string;

The route prefix: the root name, or content{id} for presented content.

mount

readonly mount: boolean;

Acknowledge this presentation with a mount token, so .NET attaches a View.

hydrate

readonly hydrate: (wire: never) => TState;

Decodes a wire state, without its revision and field metadata. Throws for an invalid state.

checkedFields

readonly checkedFields?: readonly string[];

Wire names of fields with checked writes.

interactions

readonly interactions?: BridgeInteractions;

The client's interactions, from defineInteractions.

collections

readonly collections?: BridgeCollections;

Generated codecs for opt-in keyed collection changes, from defineCollections.

operations

readonly operations?: BridgeOperations;

bridgeOperations, for a client with operations.