Send a HTTP PATCH Request.

Hierarchy (view full)

Properties

abilityAlias?: string
callStack?: CallStackInfo[]
headers: Headers = {}

Methods - Factory

  • Send a HTTP PATCH request to the specified url. Optionally it is possible to chain definitions for header sand data as well as the expected response type.

    Parameters

    • url: string

      the URL of the target.

    Returns Patch

    the new instance

    Example

    simple request

    Patch.to('https://my-fancy-url.com');
    

    with chained definitions

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

Methods - Other

  • Parameters

    • entry: CallStackInfo

    Returns void

  • Parameters

    • calledWith: CallStackCalledWith

    Returns void

  • Set the alias which is used for an underlying ability

    Parameters

    • alias: undefined | string

      with which an ability was initialized

    Returns this

    current action

  • Add data to the HTTP PATCH request to send. PATCH requests bodies hold partial updates of the entities to be updated.

    Parameters

    • data: any

      the data.

    Returns Patch

    this instance

Methods - called internally

Generated using TypeDoc