commit | 2a88d0504f79f238457155010d637ee03c216543 | [log] [tgz] |
---|---|---|
author | James Thomas <jthomas.uk@gmail.com> | Thu Nov 17 16:06:58 2016 +0000 |
committer | GitHub <noreply@github.com> | Thu Nov 17 16:06:58 2016 +0000 |
tree | 15571df447a6126675c648cf7c92a3118cebeca5 | |
parent | 5fdf7ca6739294cbfebf06a5cc609765b8f70318 [diff] | |
parent | d2ce5a922d1da1758970fba15047fa54cde48bd5 [diff] |
Merge pull request #4 from triceam/master added custom error class so activation/error detail is not swallowed
JavaScript client library for the OpenWhisk platform. Provides a wrapper around the OpenWhisk APIs.
$ npm install openwhisk
var openwhisk = require('openwhisk'); var ow = openwhisk({api: 'https://openwhisk.ng.bluemix.net/api/v1/', api_key: '...', namespace: 'default_namespace'});
All methods return a Promise resolved asynchronously with the results. Failures are available through the catch method.
ow.resource.operation().then(function () { // success! }).catch(function (err) { // failed! })
ow.actions.list() ow.activations.list() ow.triggers.list() ow.rules.list() ow.namespaces.list() ow.packages.list()
Query parameters for the API calls are supported (e.g. limit, skip, etc.) by passing an object with the named parameters as the first argument.
ow.actions.list({skip: 100, limit: 50})
The following optional parameters are supported:
namespace
- set custom namespace for endpointow.actions.get({actionName: '...'}) ow.activations.get({activation: '...'}) ow.triggers.get({triggerName: '...'}) ow.rules.get({ruleName: '...'}) ow.namespaces.get({namespace: '...'}) ow.packages.get({packageName: '...'})
The following optional parameters are supported:
namespace
- set custom namespace for endpointow.actions.delete({actionName: '...'}) ow.triggers.delete({triggerName: '...'}) ow.rules.delete({ruleName: '...'}) ow.packages.delete({packageName: '...'})
The following optional parameters are supported:
namespace
- set custom namespace for endpointow.actions.invoke({actionName: '...'})
The following optional parameters are supported:
blocking
- delay returning until action has finished executing (default: false
)params
- JSON object containing parameters for the action being invoked (default: {}
)namespace
- set custom namespace for endpointow.actions.create({actionName: '...', action: 'function main() {};'}) ow.actions.update({actionName: '...', action: 'function main() {};'})
The following mandatory parameters are supported:
actionName
- action identifieraction
- String containing JS function source code or JSON object containing full parameters for the action bodyThe following optional parameters are supported:
namespace
- set custom namespace for endpointow.triggers.invoke({triggerName: '...'})
The following optional parameters are supported:
params
- JSON object containing parameters for the trigger being fired (default: {}
)namespace
- set custom namespace for endpointow.triggers.create({triggerName: '...'}) ow.triggers.update({triggerName: '...'})
The following optional parameters are supported:
trigger
- JSON object containing parameters for the trigger body (default: {}
)namespace
- set custom namespace for endpointow.packages.create({packageName: '...'}) ow.packages.update({packageName: '...'})
The following optional parameters are supported:
package
- JSON object containing parameters for the package body (default: {}
)namespace
- set custom namespace for endpointow.rules.create({ruleName: '...', action: '...', trigger: '...'}) ow.rules.update({ruleName: '...', action: '...', trigger: '...'})
The following optional parameters are supported:
namespace
- set custom namespace for endpointow.rules.enable({ruleName: '...'}) ow.rules.disable({ruleName: '...'})
The following optional parameters are supported:
namespace
- set custom namespace for endpointow.feeds.create({feedName: '...', trigger: '...'}) ow.feeds.delete({feedName: '...', trigger: '...'}) // for example... const params = {cron: '*/8 * * * * *', trigger_payload: {name: 'James'}} ow.feeds.create({feedName: 'alarms/alarm', namespace: 'whisk.system', trigger: 'alarmTrigger', params})
The following optional parameters are supported:
namespace
- set custom namespace for endpointparams
- JSON object containing parameters for the feed being invoked (default: {}
)