commit | 2fd5a7ddc6f9f6dc8f1606e55bccadbf0004eb61 | [log] [tgz] |
---|---|---|
author | James Thomas <jthomas.uk@gmail.com> | Mon Nov 28 18:11:45 2016 +0000 |
committer | GitHub <noreply@github.com> | Mon Nov 28 18:11:45 2016 +0000 |
tree | 47dd08e3be1a5ba9e28c099bd314e0c440066bff | |
parent | e776b7faa4e7e95b8132ad23c0481c6507d2dfbe [diff] |
Update README.md
JavaScript client library for the OpenWhisk platform. Provides a wrapper around the OpenWhisk APIs.
$ npm install openwhisk
var openwhisk = require('openwhisk'); var options = {apihost: 'openwhisk.ng.bluemix.net', api_key: '...', namespace: 'my_namespace'}; var ow = openwhisk(options);
Client constructor supports the following options:
openwhisk.ng.bluemix.net
or my_whisk_host:80
. Used with API URL template ${protocol}://${apihost}/api/v1/
. If port is missing or port value is 443 in the apihost string, protocol is HTTPS. Otherwise, protocol is HTTP.https://openwhisk.ng.bluemix.net/api/v1/
. This value overrides apihost
if both are present.Client constructor will read values for the apihost
, namespace
and api_key
options from the environment if the following parameters are set. Explicit parameter values override these values.
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 actionName
parameter supports the following formats: actionName
, package/actionName
, /namespace/actionName
, /namespace/package/actionName
.
If actionName
includes a namespace, this overrides any other namespace
properties.
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, Buffer containing package action zip file 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: {}
)