Newts Parading Majestically

    @bb-cli/lib-bb-portal-rest-nodejs-plugin

    2.1.0 • Public • Published

    Members

    default

    Typedefs

    requestCallbackResponse

    Executes http request.

    NodeJSAdapter : object
    logCallback : function

    logs message with header

    btoaCallbackstring

    returns a base-64 encoded ASCII string from a String object

    Response : object

    default ⇒

    Kind: global variable
    Returns: NodeJSAdapter Adapter API

    Param Type Description
    logFunction function function to use for logging

    requestCallback ⇒ Response

    Executes http request.

    Kind: global typedef
    Returns: Response - response object

    Param Type Description
    config object http request configuration
    config.url string target url
    config.method string http method
    config.query object http param query hash
    config.headers object headers hash
    config.importFile string path of the file to upload
    config.exportFile string path of the file to download to
    config.formField string name of the form field for upload
    payload string xml string or path of xml file to sent as request body

    NodeJSAdapter : object

    Kind: global typedef
    Properties

    Name Type Description
    request requestCallback http request method
    log logCallback log method
    btoa btoaCallback base64 string convert method
    DOMParser DOMParser DOMParser API

    logCallback : function

    logs message with header

    Kind: global typedef

    Param Type Description
    header string title of the message
    message string message to log

    btoaCallback ⇒ string

    returns a base-64 encoded ASCII string from a String object

    Kind: global typedef
    Returns: string - encodedString

    Param Type Description
    string string to encode

    Response : object

    Kind: global typedef
    Properties

    Name Type Description
    status number http status code
    statusText string http status text
    headers object http response headers
    body string http response body

    Keywords

    Install

    npm i @bb-cli/lib-bb-portal-rest-nodejs-plugin

    DownloadsWeekly Downloads

    2,158

    Version

    2.1.0

    License

    SEE LICENSE IN LICENSE

    Unpacked Size

    80.9 kB

    Total Files

    21

    Last publish

    Collaborators

    • bb-cli