webconsole-cloudapi-client v1.1.0

CloudApi fetch client

API

Constructor

• token - included as 'X-Auth-Token' HTTP header on all requests for this client. Require for production.
• key - private key used to sign request, must be a string or an object with { key, passphrase }
• keyId - CloudAPI formatted key ID, usually in the form 'user/keys/md5 id'
• url - base URL for CloudAPI service
• pathPrefix - default path prefix for all requests, defaults to '/my'.
• log - function used to log errors for debugging purposes
• tracer - optional object used for OpenTracing tracing. Must have function for startSpan

fetch(path[, options ])

• path - is a string of the resource to request
• options - object with the following properties
  • includeRes - boolean, indicates if the raw res object should be returned. Defaults to only returning the payload
  • span - parent OpenTracing span that initiated this request
  • method - HTTP method, defaults to 'GET'
  • query - object with any query string name/values to include
  • payload - object to JSON stringify and send to the server
  • headers - any additional HTTP headers to include