ViewConnection interface

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

interface ViewConnection<TState> extends ViewClient<TState>

The runtime half of a generated client. Generated code is its only intended caller.

Properties

interactions

readonly interactions: Readonly<Record<string, InteractionSurface>>;

No documentation.

Methods

invoke

invoke(name: string, ...args: unknown[]): Promise<TState>;

Calls a state-returning route.

command

command(name: string, ...args: unknown[]): Promise<TState>;

Calls a command route after .NET acknowledged this View's interaction handlers.

commandOutcome

commandOutcome<TFailure>(name: string, decodeFailure: (value: unknown) => TFailure, ...args: unknown[]): Promise<BridgeOutcome<TState, TFailure>>;

Calls a command route that declares a failure type, like command. Its declared failure resolves bridgeFailure(decodeFailure(failure)); every other failure still rejects with BridgeError.

query

query(name: string, ...args: unknown[]): Promise<boolean>;

Calls a Can{Command} route.

writeField

writeField<T>(name: string, payload: string, decode: (value: unknown) => T): Promise<FieldWriteReceipt<T>>;

No documentation.

fieldBaseline

fieldBaseline(field: string): FieldBaseline<unknown>;

No documentation.

startOperation

startOperation<TResult, TFailure = never>(member: string, requestId: string, payload: () => string, decode: (value: unknown) => TResult, stream?: boolean, decodeFailure?: (value: unknown) => TFailure): Promise<BridgeOperationRuntimeHandle<TResult, TFailure>>;

decodeFailure is given for an operation that declares a failure type.

recoverOperation

recoverOperation<TResult, TFailure = never>(member: string, requestId: string, decode: (value: unknown) => TResult, stream?: boolean, decodeFailure?: (value: unknown) => TFailure): Promise<BridgeOperationRuntimeHandle<TResult, TFailure>>;

No documentation.