Hierarchy

  • Configuration

Constructors

Properties

accessToken?: string | (() => string)

Type declaration

    • (): string
    • Returns string

apiKeys?: {
    [key: string]: string;
}

Type declaration

  • [key: string]: string
basePath?: string
password?: string
username?: string
withCredentials?: boolean

Methods

  • Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json

    Parameters

    • mime: string

      MIME (Multipurpose Internet Mail Extensions)

    Returns boolean

    True if the given MIME is JSON, false otherwise.

  • Select the correct accept content-type to use for a request. Uses Configuration#isJsonMime to determine the correct accept content-type. If no content type is found return the first found type if the contentTypes is not empty

    Parameters

    • accepts: string[]

      the array of content types that are available for selection.

    Returns string

    the selected content-type or undefined if no selection could be made.

  • Select the correct content-type to use for a request. Uses Configuration#isJsonMime to determine the correct content-type. If no content type is found return the first found type if the contentTypes is not empty

    Parameters

    • contentTypes: string[]

      the array of content types that are available for selection

    Returns string

    the selected content-type or undefined if no selection could be made.

Generated using TypeDoc