1.0.0 • Published 7 years ago
lib-bb-portal-rest-ajax-adapter v1.0.0
lib-bb-portal-rest-ajax-adapter
Version: 1.0.0
Browser AJAX adapter for lib-bb-portal-rest
Example
import bbrest from 'lib-bb-portal-rest';
import adapter from 'lib-bb-portal-rest-ajax-adapter';
const BBRest = bbrest(adapter);
BBRest.server().get()
.then(portals => {
// do something
});Table of Contents
- Exports default(logFunction)
- Type Definitions requestCallback(config, payload) AjaxAdapter logCallback(header, message) btoaCallback(string) Response
Exports
default(logFunction)
| Parameter | Type | Description |
|---|---|---|
| logFunction | Function (optional) | function to use for logging |
Returns
AjaxAdapter - Adapter API
Type Definitions
requestCallback(config, payload)
Executes http request.
| Parameter | 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 | file blob object |
| 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 url of xml to sent as request body |
Returns
Response - response object
AjaxAdapter
Type: Object
| Property | Type | Description |
|---|---|---|
| request | requestCallback | http request method |
| log | logCallback | log method |
| btoa | btoaCallback | base64 string convert method |
| DOMParser | DOMParser | See https://developer.mozilla.org/en-US/docs/Web/API/DOMParser |
logCallback(header, message)
logs message with header
| Parameter | 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
| Parameter | Type | Description |
|---|---|---|
| string | String | to encode |
Returns
String - encodedString
Response
Type: Object
| Property | Type | Description |
|---|---|---|
| status | Number | http status code |
| statusText | String | http status text |
| headers | Object | http response headers |
| body | String | http response body |
1.0.0
7 years ago