Class Get

Send a HTTP GET Request.

Hierarchy (view full)

Properties

abilityAlias? callStack? headers

Methods - Factory

from

Methods - Other

addToCallStack setCallStackInitializeCalledWith withAbilityAlias withHeaders withResponseBodyFormat

Methods - called internally

performAs

Properties

Optional abilityAlias

abilityAlias?: string

Optional callStack

callStack?: CallStackInfo[]

Protected headers

headers: Headers = {}

Methods - Factory

Static from

  • from(url): Get

  • Send a HTTP GET request to the specified url. Optionally it is possible to chain definitions for headers as well as the expected response type.

    Parameters

    • url: string

      the URL of the target.

    Returns Get

    create a new instance

    Example

    simple request

    Get.from('https://my-fancy-url.com');

    with chained definitions

    Get.from('https://my-fancy-url.com')
        // add headers
        .withHeaders({
            key: value,
        })
        // define expected response format
        .withResponseFormat('text');

Methods - Other

addToCallStack

  • addToCallStack(entry): void

  • Parameters

    • entry: CallStackInfo

    Returns void

setCallStackInitializeCalledWith

  • setCallStackInitializeCalledWith(calledWith): void

  • Parameters

    • calledWith: CallStackCalledWith

    Returns void

withAbilityAlias

  • withAbilityAlias(alias): this

  • Set the alias which is used for an underlying ability

    Parameters

    • alias: undefined | string

      with which an ability was initialized

    Returns this

    current action

withHeaders

withResponseBodyFormat

Methods - called internally

performAs

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc