Interface RequestBehavior

Interface that defines the behavior of a request.

This interface extends expression behavior to add methods specific to requests, including metadata management and access to request properties.

interface RequestBehavior {
    withParameter(
        param: ParameterID,
        value: EnvelopeEncodableValue,
    ): Request;
    withNote(note: string): Request;
    withDate(date: Date): Request;
    body(): Expression;
    id(): ARID;
    note(): string;
    date(): Date | undefined;
    function(): Function;
    expressionEnvelope(): Envelope;
    toEnvelope(): Envelope;
}

Implemented by

Request

Index

Methods

withParameter withNote withDate body id note date function expressionEnvelope toEnvelope

Methods

withParameter

withParameter(param: ParameterID, value: EnvelopeEncodableValue): Request
Adds a parameter to the request.
Parameters
- param: ParameterID
- value: EnvelopeEncodableValue
Returns Request
- Defined in envelope/src/extension/request.ts:40

withNote

withNote(note: string): Request
Adds a note to the request.
Parameters
- note: string
Returns Request
- Defined in envelope/src/extension/request.ts:45

withDate

withDate(date: Date): Request
Adds a date to the request.
Parameters
- date: Date
Returns Request
- Defined in envelope/src/extension/request.ts:50

body

body(): Expression
Returns the body of the request (the expression to be evaluated).

Returns Expression
- Defined in envelope/src/extension/request.ts:55

id

id(): ARID
Returns the unique identifier (ARID) of the request.

Returns ARID
- Defined in envelope/src/extension/request.ts:60

note

note(): string
Returns the note attached to the request, or an empty string if none exists.

Returns string
- Defined in envelope/src/extension/request.ts:65

date

date(): Date | undefined
Returns the date attached to the request, if any.

Returns Date | undefined
- Defined in envelope/src/extension/request.ts:70

function

function(): Function
Returns the function of the request.

Returns Function
- Defined in envelope/src/extension/request.ts:75

expressionEnvelope

expressionEnvelope(): Envelope
Returns the expression envelope of the request.

Returns Envelope
- Defined in envelope/src/extension/request.ts:80

toEnvelope

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

Returns Envelope
- Defined in envelope/src/extension/request.ts:85