SendPOSTFunction: ((payload: IPayloadData, oncomplete: OnCompleteCallback, sync?: boolean) => void | IPromise<boolean>)

SendPOSTFunction type defines how an HTTP POST request is sent to an ingestion server

Type declaration

    • (payload, oncomplete, sync?): void | IPromise<boolean>
    • Parameters

      • payload: IPayloadData

        The payload object that should be sent, contains the url, bytes/string and headers for the request

      • oncomplete: OnCompleteCallback

        The function to call once the request has completed whether a success, failure or timeout

      • Optionalsync: boolean

        A boolean flag indicating whether the request should be sent as a synchronous request.

      Returns void | IPromise<boolean>