## Classes
Sandbox
Webtask
## Functions
create(codeOrUrl, [options], [cb]) ⇒ Promise

Create a Webtask from the given options

create(claims, [cb]) ⇒ Promise

Create a Webtask from the given claims

createUrl(options, [cb]) ⇒ Promise

Shortcut to create a Webtask and get its url from the given options

run([codeOrUrl], [options], [cb]) ⇒ Promise

Shortcut to create and run a Webtask from the given options

createToken(options, [cb]) ⇒ Promise

Create a webtask token - A JWT (see: http://jwt.io) with the supplied options

createToken(claims, [cb]) ⇒ Promise

Create a webtask token - A JWT (see: http://jwt.io) with the supplied claims

createLogStream(options) ⇒ Stream

Create a stream of logs from the webtask container

Note that the logs will include messages from our infrastructure.

createLogStream(options) ⇒ Stream

Create a stream of logs from the webtask container

Note that the logs will include messages from our infrastructure.

## Sandbox **Kind**: global class ### new Sandbox(options) Creates an object representing a user's webtask.io credentials | Param | Type | Description | | --- | --- | --- | | options | Object | Options used to configure the profile | | options.url | String | The url of the webtask cluster where code will run | | options.container | String | The name of the container in which code will run | | options.token | String | The JWT (see: http://jwt.io) issued by webtask.io that grants rights to run code in the indicated container | ## Webtask **Kind**: global class * [Webtask](#Webtask) * [new Webtask()](#new_Webtask_new) * [.run(options, [cb])](#Webtask+run) ⇒ Promise ### new Webtask() Creates an object representing a Webtask ### webtask.run(options, [cb]) ⇒ Promise Run the webtask and return the result of execution **Kind**: instance method of [Webtask](#Webtask) | Param | Type | Description | | --- | --- | --- | | options | Object | Options used to tweak how the webtask will be invoked | | [cb] | function | Optional node-style callback that will be invoked upon completion | ## create(codeOrUrl, [options], [cb]) ⇒ Promise Create a Webtask from the given options **Kind**: global function **Returns**: Promise - A Promise that will be fulfilled with the token | Param | Type | Description | | --- | --- | --- | | codeOrUrl | String | The code for the webtask or a url starting with http:// or https:// | | [options] | Object | Options for creating the webtask | | [cb] | function | Optional callback function for node-style callbacks | ## create(claims, [cb]) ⇒ Promise Create a Webtask from the given claims **Kind**: global function **Returns**: Promise - A Promise that will be fulfilled with the token | Param | Type | Description | | --- | --- | --- | | claims | Object | Options for creating the webtask | | [cb] | function | Optional callback function for node-style callbacks | ## createUrl(options, [cb]) ⇒ Promise Shortcut to create a Webtask and get its url from the given options **Kind**: global function **Returns**: Promise - A Promise that will be fulfilled with the token | Param | Type | Description | | --- | --- | --- | | options | Object | Options for creating the webtask | | [cb] | function | Optional callback function for node-style callbacks | ## run([codeOrUrl], [options], [cb]) ⇒ Promise Shortcut to create and run a Webtask from the given options **Kind**: global function **Returns**: Promise - A Promise that will be fulfilled with the token | Param | Type | Description | | --- | --- | --- | | [codeOrUrl] | String | The code for the webtask or a url starting with http:// or https:// | | [options] | Object | Options for creating the webtask | | [cb] | function | Optional callback function for node-style callbacks | ## createToken(options, [cb]) ⇒ Promise Create a webtask token - A JWT (see: http://jwt.io) with the supplied options **Kind**: global function **Returns**: Promise - A Promise that will be fulfilled with the token | Param | Type | Description | | --- | --- | --- | | options | Object | Claims to make for this token (see: https://webtask.io/docs/api_issue) | | [cb] | function | Optional callback function for node-style callbacks | ## createToken(claims, [cb]) ⇒ Promise Create a webtask token - A JWT (see: http://jwt.io) with the supplied claims **Kind**: global function **Returns**: Promise - A Promise that will be fulfilled with the token | Param | Type | Description | | --- | --- | --- | | claims | Object | Claims to make for this token (see: https://webtask.io/docs/api_issue) | | [cb] | function | Optional callback function for node-style callbacks | ## createLogStream(options) ⇒ Stream Create a stream of logs from the webtask container Note that the logs will include messages from our infrastructure. **Kind**: global function **Returns**: Stream - A stream that will emit 'data' events with container logs | Param | Type | Description | | --- | --- | --- | | options | Object | Streaming options overrides | | [options.container] | String | The container for which you would like to stream logs. Defaults to the current profile's container. | ## createLogStream(options) ⇒ Stream Create a stream of logs from the webtask container Note that the logs will include messages from our infrastructure. **Kind**: global function **Returns**: Stream - A stream that will emit 'data' events with container logs | Param | Type | Description | | --- | --- | --- | | options | Object | Streaming options overrides | | [options.container] | String | The container for which you would like to stream logs. Defaults to the current profile's container. |