Interface RestApiRecipe

interface RestApiRecipe {
    defaultBaseUrl?: string;
    name: string;
    querySerializer: QuerySerializer;
    getOptions(
        apiKey?: string,
        overrides?: Partial<RestAdapterOptions>,
    ): RestAdapterOptions;
}

Implemented by

Index

Properties

defaultBaseUrl? name querySerializer

Methods

Properties

`Optional`defaultBaseUrl

defaultBaseUrl?: string

The default base URL for the API (if applicable)

name

name: string

Name of the recipe

querySerializer

querySerializer: QuerySerializer

The query serializer that translates Quatrain Filters to the API's expected query strings

Methods

getOptions

getOptions(
apiKey?: string,
overrides?: Partial<RestAdapterOptions>,
): RestAdapterOptions
Provides the default RestAdapterOptions for this recipe. Users can spread this over their own options.
Parameters
- OptionalapiKey: string
- Optionaloverrides: Partial<RestAdapterOptions>
Returns RestAdapterOptions
- Defined in RestApiRecipe.ts:23