Variable deliverJson

Type Declaration

• • (
        record: any,
        attribute: string,
        payload: any,
        headers: Record<string, string>,
        options?: DeliverOptions,
    ): Promise<DeliveryResult>

  • Sends a JSON body with the caller's headers to a registered address, as deliverForm() sends a form.

    Never rejects.

    Parameters

    • record: any

      the entry carrying the address under attribute

    • attribute: string

      the attribute holding the address, one of SENDABLE

    • payload: any

      the value sent as JSON

    • headers: Record<string, string>

      extra request headers, e.g. a Bearer token

    • Optionaloptions: DeliverOptions

      timeoutMs and keepBody

    Returns Promise<DeliveryResult>

    a promise of the delivery result