Licence
ISC
Version
1.0.4
Deps
3
Size
8 kB
Vulns
1
Weekly
0
Classes
ClientClient for JSON/REST/RPC over http with AWS4 signatures
Typedefs
CallResult :CallResultArray
Map of s for the associated calls
CallResultArray CallStructure :CallResultArray
A structure with method names and their associated parameters.
Each result is an for the associated call key.
Client
Client for JSON/REST/RPC over http with AWS4 signatures
Kind: global class
new Client(host, keys)
Create client for a host
| Param | Type | Description |
|---|---|---|
| host | string |
Host name |
| keys | Credentials |
Optional credentials for AWS4 signing |
Example
const client = new Client('api.moarhealth.com')
client.call({
greeting: "Mark"
initialize: { "some": "stuff" }
}).then(results => {
console.log(`Result for greeting was ${results.greeting}`)
console.log(`Result for initialize was ${results.initialize}`)
})
client.call(structures) ⇒ CallResult
Call one or more methods
Kind: instance method of Client
Returns: CallResult - A promise to produce
| Param | Type | Description |
|---|---|---|
| structures | CallStructure |
Structure for the calls the client will make. |
CallResult : CallResultArray
Map of s for the associated calls
CallResultArray
Kind: global typedef
Properties
| Name | Type | Description |
|---|---|---|
| 0 | object |
Error object |
| 1 | object |
Data object |
CallStructure : CallResultArray
A structure with method names and their associated parameters.
Each result is an for the associated call key.
Kind: global typedef