Version: 1.0.0
Browser AJAX adapter for lib-bb-portal-rest
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
});
-
Exports
default(logFunction)
-
Type Definitions
requestCallback(config, payload)
AjaxAdapter
logCallback(header, message)
btoaCallback(string)
Response
Parameter | Type | Description |
---|---|---|
logFunction | Function (optional) | function to use for logging |
AjaxAdapter - Adapter API
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 |
Response - response object
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 |
logs message with header
Parameter | Type | Description |
---|---|---|
header | String | title of the message |
message | String | message to log |
returns a base-64 encoded ASCII string from a String object
Parameter | Type | Description |
---|---|---|
string | String | to encode |
String - encodedString
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 |