Interface IActionDereferenceParse<T>

Data interface for the type of action.

interface IActionDereferenceParse<T extends IParseMetadata = IParseMetadata> {
    acceptErrors?: boolean;
    context: IActionContext;
    headers?: Headers;
    mediaType?: string;
    mediaTypes?: () => Promise<undefined | Record<string, number>>;
    metadata?: T;
    method?: string;
    url: string;
}

Type Parameters

Hierarchy (View Summary)

Properties

acceptErrors? context headers? mediaType? mediaTypes? metadata? method? url

Properties

OptionalacceptErrors

acceptErrors?: boolean

By default, actors will reject upon receiving non-200 HTTP responses. If this option is true, then all HTTP responses will cause the action to resolve, but some outputs may therefore contain empty quad streams.

context

context: IActionContext

The input context that is passed through by actors.

Optionalheaders

headers?: Headers

Optional HTTP headers to pass.

OptionalmediaType

mediaType?: string

The mediatype of the source (if it can't be inferred from the source)

OptionalmediaTypes

mediaTypes?: () => Promise<undefined | Record<string, number>>

An optional callback to retrieve the mediaType mappings

Optionalmetadata

metadata?: T

Metadata to be given to the parser

Optionalmethod

method?: string

Optional HTTP method to use. Defaults to GET.

url

url: string

The URL to dereference

Settings

Member Visibility

On This Page

Properties