@types/easy-soap-request v4.1.4

Installation

npm install --save @types/easy-soap-request

Summary

This package contains type definitions for easy-soap-request (https://github.com/circa10a/easy-soap-request).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/easy-soap-request.

index.d.ts

// Type definitions for easy-soap-request 4.1
// Project: https://github.com/circa10a/easy-soap-request
// Definitions by: Steven Snoeijen <https://github.com/stevensnoeijen>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

import { AxiosProxyConfig, AxiosRequestConfig, AxiosResponse, AxiosError } from "axios";

interface Options {
    /**
     * HTTP request method
     * @default 'POST'
     */
    method?: string | undefined;

    /**
     * endpoint URL
     */
    url: string;

    /**
     * HTTP headers, can be string or object
     */
    headers?: object | string | undefined;

    /**
     *  SOAP envelope, can be read from file or passed as string
     */
    xml: string;

    /**
     * Milliseconds before timing out request
     * @default 10000
     */
    timeout?: number | undefined;

    /**
     * Object with proxy configuration
     */
    proxy?: AxiosProxyConfig | undefined;

    /**
     * Limit body size being sent(bytes)
     * @default Infinity
     */
    maxBodyLength?: number | undefined;

    /**
     * Limit content size being sent(bytes)
     * @default Infinity
     */
    maxContentLength?: number | undefined;

    /**
     * Object of additional axios parameters.
     */
    extraOpts?: AxiosRequestConfig | undefined;
}

interface Response {
    response: {
        headers: any;
        body: any;
        statusCode: number;
    };
}

/**
 * @returns parsed from a AxiosResponse
 * @throws {any|AxiosError} response from AxiosError.response.data
 */
declare function soapRequest(options: Options): Promise<Response>;

export = soapRequest;

Additional Details

• Last updated: Thu, 08 Jul 2021 12:01:02 GMT
• Dependencies: @types/axios
• Global values: none

Credits

These definitions were written by Steven Snoeijen.