Interface ResponseBehavior

Interface that defines the behavior of a response.

interface ResponseBehavior {
    withResult(result: EnvelopeEncodableValue): Response;
    withError(error: EnvelopeEncodableValue): Response;
    isOk(): boolean;
    isErr(): boolean;
    id(): ARID | undefined;
    result(): Envelope;
    error(): Envelope;
    toEnvelope(): Envelope;
}

Implemented by

Response

Index

Methods

withResult withError isOk isErr id result error toEnvelope

Methods

withResult

withResult(result: EnvelopeEncodableValue): Response
Sets the result value for a successful response.
Parameters
- result: EnvelopeEncodableValue
Returns Response
Throws
Error if called on a failure response.
- Defined in envelope/src/extension/response.ts:56

withError

withError(error: EnvelopeEncodableValue): Response
Sets the error value for a failure response.
Parameters
- error: EnvelopeEncodableValue
Returns Response
Throws
Error if called on a successful response.
- Defined in envelope/src/extension/response.ts:62

isOk

isOk(): boolean
Returns true if this is a successful response.

Returns boolean
- Defined in envelope/src/extension/response.ts:67

isErr

isErr(): boolean
Returns true if this is a failure response.

Returns boolean
- Defined in envelope/src/extension/response.ts:72

id

id(): ARID | undefined
Returns the ID of the request this response corresponds to, if known.

Returns ARID | undefined
- Defined in envelope/src/extension/response.ts:77

result

result(): Envelope
Returns the result envelope if this is a successful response.

Returns Envelope
Throws
Error if this is a failure response.
- Defined in envelope/src/extension/response.ts:83

error

error(): Envelope
Returns the error envelope if this is a failure response.

Returns Envelope
Throws
Error if this is a successful response.
- Defined in envelope/src/extension/response.ts:89

toEnvelope

toEnvelope(): Envelope
Converts the response to an envelope.

Returns Envelope
- Defined in envelope/src/extension/response.ts:94