@webex/http-core

@webex/http-core

Core HTTP library for the Cisco Webex JS SDK.

• @webex/http-core
  • Install
  • Usage
    • Environment Variables
    • detect()
    • request()
    • defaults()
    • HttpError
  • Maintainers
  • Contribute
  • License

Install

npm install --save @webex/http-core

Usage

Environment Variables

This plugin utilizes the following environmental variables:

• ENABLE_VERBOSE_NETWORK_LOGGING [ boolean ]- Utilized to enable interceptor logging

detect()

Detects the filetype of the specified file.

request()

Same api as request with the following changes:

• Promise-based instead of nodeback based
• Adds an interceptors property to the options object for adding classes that intercept and modify each request
• 4XX and 5XX responses get rejected with the appropriate subclassed Error type
• Sensible defaults for our API ({json:true}, etc)

defaults()

Curried version of request() that produces an http client with overridden defaults.

HttpError

Child of Error (by way of Exception from @webex/common). Has subclassed errors for each official HTTP status code (and 429 Too Man Requests).

Maintainers

This package is maintained by Cisco Webex for Developers.

Contribute

Pull requests welcome. Please see CONTRIBUTING.md for more details.

License

© 2016-2020 Cisco and/or its affiliates. All Rights Reserved.