openmixer — generated API reference
    Preparing search index...

    Interface ResourceReadResult<S>

    The result of a read.

    interface ResourceReadResult<S extends object> {
        fault?: ResourceFault;
        known?: readonly string[];
        ok: boolean;
        reason?: string;
        refusal?: Refusal;
        state?: S;
    }

    Type Parameters

    • S extends object
    Index
    fault? known? ok reason? refusal? state?
    fault?: ResourceFault
    known?: readonly string[]

    Which fields of state the entity actually KNOWS, when it draws that distinction.

    ok: boolean
    reason?: string
    refusal?: Refusal

    The coded reason, on a fault — NO_INSTANCE / NOT_ADDRESSABLE for an absent address.

    state?: S

    Settings
    Member Visibility

    On This Page
    Properties