Constructor
- - - -new App(definition) → {App}
- - - - - - -Parameters:
- - -Name | - - -Type | - - - - - -Description | -
---|---|---|
definition |
-
-
- - - - Object - - - - | - - - - - -Application definition. See `config` for examples. | -
Properties:
- - - -Name | - - -Type | - - - - - -Description | -
---|---|---|
components |
-
-
- - - - Collection - - - - | - - - - - -Interface elements. | -
stash |
-
-
- - - - Store - - - - | - - - - - -Routable Datastore. | -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
-
-
-
-
- - types/app.js, line 26 - -
-
-
-
-
-
-
-
-
Returns:
- - --
-
- - Type - -
- - - App - - - -
Extends
- - - - --
-
- Service -
Methods
- - - - - - - -(async) _GET(path) → {Promise}
- - - - - - -Parameters:
- - -Name | - - -Type | - - - - - -Description | -
---|---|---|
path |
-
-
- - - - String - - - - | - - - - - -Path of the value to retrieve. | -
-
-
-
-
-
-
-
-
-
-
- Overrides: -
-
-
-
-
- - Service#_GET - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source: -
-
-
-
-
- - types/service.js, line 663 - -
-
-
-
-
-
-
-
-
Returns:
- - --
-
- - Type - -
- - - Promise - - - -
(async) _PUT(path, value, commitopt) → {Promise}
- - - - - - -Parameters:
- - -Name | - - -Type | - - -Attributes | - - - -Default | - - -Description | -
---|---|---|---|---|
path |
-
-
- - - - String - - - - | - - -- - - - - - | - - - -- - | - - -Path to store the value at. | -
value |
-
-
- - - - Object - - - - | - - -- - - - - - | - - - -- - | - - -Document to store. | -
commit |
-
-
- - - - Boolean - - - - | - - -
-
- <optional> - - - - - - |
-
-
-
- - - false - - | - - -Sign the resulting state. | -
-
-
-
-
-
-
-
-
-
-
- Overrides: -
-
-
-
-
- - Service#_PUT - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source: -
-
-
-
-
- - types/service.js, line 697 - -
-
-
-
-
-
-
-
-
Returns:
- - --
-
- - Type - -
- - - Promise - - - -
(async) _registerActor(actor) → {Promise}
- - - - - - - - - - - - - - - - -Parameters:
- - -Name | - - -Type | - - - - - -Description | -
---|---|---|
actor |
-
-
- - - - Object - - - - | - - - - - -Instance of the Actor. | -
-
-
-
-
-
-
-
-
-
-
- Overrides: -
-
-
-
-
- - Service#_registerActor - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source: -
-
-
-
-
- - types/service.js, line 975 - -
-
-
-
-
-
-
-
-
Returns:
- - --
-
- - Type - -
- - - Promise - - - -
_registerService(name, Service) → {Service}
- - - - - - -Parameters:
- - -Name | - - -Type | - - - - - -Description | -
---|---|---|
name |
-
-
- - - - String - - - - | - - - - - -Internal name of the service. | -
Service |
-
-
- - - - Class - - - - | - - - - - -The ES6 class definition implementing Service. | -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
-
-
-
-
- - types/app.js, line 340 - -
-
-
-
-
-
-
-
-
Returns:
- - --
-
- - Type - -
- - - Service - - - -
(async) _send(message)
- - - - - - -Parameters:
- - -Name | - - -Type | - - - - - -Description | -
---|---|---|
message |
-
-
- - - - Mixed - - - - | - - - - - -Message to send. | -
-
-
-
-
-
-
-
-
-
-
- Overrides: -
-
-
-
-
- - Service#_send - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source: -
-
-
-
-
- - types/service.js, line 1104 - -
-
-
-
-
-
-
-
-
attach(element) → {App}
- - - - - - -Parameters:
- - -Name | - - -Type | - - - - - -Description | -
---|---|---|
element |
-
-
- - - - DOMElement - - - - | - - - - - -DOM element to bind to. | -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
-
-
-
-
- - types/app.js, line 246 - -
-
-
-
-
-
-
-
-
Returns:
- - --
-
- - Type - -
- - - App - - - -
beat() → {Service}
- - - - - - --
-
-
-
-
-
-
-
-
-
- Overrides: -
-
-
-
-
- - Service#beat - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source: -
-
-
-
-
- - types/service.js, line 257 - -
-
-
-
-
-
-
-
-
Fires:
--
-
- Message#event:beat -
Returns:
- - - - --
-
- - Type - -
- - - Service - - - -
(async) connect(notify) → {Promise}
- - - - - - -Parameters:
- - -Name | - - -Type | - - - - -Default | - - -Description | -
---|---|---|---|
notify |
-
-
- - - - Boolean - - - - | - - - - -- - true - - | - - -Commit to changes. | -
-
-
-
-
-
-
-
-
-
-
- Overrides: -
-
-
-
-
- - Service#connect - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source: -
-
-
-
-
- - types/service.js, line 769 - -
-
-
-
-
-
-
-
-
Returns:
- - --
-
- - Type - -
- - - Promise - - - -
consume(resources) → {App}
- - - - - - -Parameters:
- - -Name | - - -Type | - - - - - -Description | -
---|---|---|
resources |
-
-
- - - - Object - - - - | - - - - - -Map of resource definitions by name. | -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
-
-
-
-
- - types/app.js, line 256 - -
-
-
-
-
-
-
-
-
Returns:
- - --
-
- - Type - -
- - - App - - - -
(async) defer(authority) → {App}
- - - - - - -Parameters:
- - -Name | - - -Type | - - - - - -Description | -
---|---|---|
authority |
-
-
- - - - String - - - - | - - - - - -Hostname to trust. | -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
-
-
-
-
- - types/app.js, line 194 - -
-
-
-
-
-
-
-
-
Returns:
- - --
-
- - Type - -
- - - App - - - -
(async) define(name, structure) → {Object}
- - - - - - -Parameters:
- - -Name | - - -Type | - - - - - -Description | -
---|---|---|
name |
-
-
- - - - String - - - - | - - - - - -Human-friendly name for the Resource. | -
structure |
-
-
- - - - Object - - - - | - - - - - -Map of attribute names -> definitions. | -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
-
-
-
-
- - types/app.js, line 162 - -
-
-
-
-
-
-
-
-
Returns:
- - --
-
- - Type - -
- - - Object - - - -
envelop(selector) → {App}
- - - - - - -Parameters:
- - -Name | - - -Type | - - - - - -Description | -
---|---|---|
selector |
-
-
- - - - String - - - - | - - - - - -CSS selector. | -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
-
-
-
-
- - types/app.js, line 275 - -
-
-
-
-
-
-
-
-
Returns:
- - --
-
- - Type - -
- - - App - - - -
get(path) → {Mixed}
- - - - - - -Parameters:
- - -Name | - - -Type | - - - - - -Description | -
---|---|---|
path |
-
-
- - - - Path - - - - | - - - - - -Key to retrieve. | -
-
-
-
-
-
-
-
-
-
-
- Overrides: -
-
-
-
-
- - Service#get - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source: -
-
-
-
-
- - types/service.js, line 302 - -
-
-
-
-
-
-
-
-
Returns:
- - - - --
-
- - Type - -
- - - Mixed - - - -
handler(message) → {Service}
- - - - - - -Parameters:
- - -Name | - - -Type | - - - - - -Description | -
---|---|---|
message |
-
-
- - - - Activity - - - - | - - - - - -Message object. | -
-
-
-
-
-
-
-
-
-
-
- Overrides: -
-
-
-
-
- - Service#handler - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source: -
-
-
-
-
- - types/service.js, line 447 - -
-
-
-
-
-
-
-
-
Returns:
- - --
-
- - Type - -
- - - Service - - - -
init()
- - - - - - --
-
-
-
-
-
-
-
-
-
- Overrides: -
-
-
-
-
- - Service#init - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source: -
-
-
-
-
- - types/service.js, line 240 - -
-
-
-
-
-
-
-
-
lock(durationopt) → {Boolean}
- - - - - - -Parameters:
- - -Name | - - -Type | - - -Attributes | - - - -Default | - - -Description | -
---|---|---|---|---|
duration |
-
-
- - - - Number - - - - | - - -
-
- <optional> - - - - - - |
-
-
-
- - - 1000 - - | - - -Number of milliseconds to hold lock. | -
-
-
-
-
-
-
-
-
-
-
- Overrides: -
-
-
-
-
- - Service#lock - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source: -
-
-
-
-
- - types/service.js, line 466 - -
-
-
-
-
-
-
-
-
Returns:
- - --
-
- - Type - -
- - - Boolean - - - -
render() → {String}
- - - - - - --
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
-
-
-
-
- - types/app.js, line 309 - -
-
-
-
-
-
-
-
-
Returns:
- - --
-
- - Type - -
- - - String - - - -
(async) route(msg) → {Promise}
- - - - - - - - - - - - - - - - -Parameters:
- - -Name | - - -Type | - - - - - -Description | -
---|---|---|
msg |
-
-
- - - - Message - - - - | - - - - - -Explicit Fabric Message. | -
-
-
-
-
-
-
-
-
-
-
- Overrides: -
-
-
-
-
- - Service#route - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source: -
-
-
-
-
- - types/service.js, line 515 - -
-
-
-
-
-
-
-
-
Returns:
- - --
-
- - Type - -
- - - Promise - - - -
(async) send(channel, message) → {Service}
- - - - - - -Parameters:
- - -Name | - - -Type | - - - - - -Description | -
---|---|---|
channel |
-
-
- - - - String - - - - | - - - - - -Channel name to which the message will be sent. | -
message |
-
-
- - - - String - - - - | - - - - - -Content of the message to send. | -
-
-
-
-
-
-
-
-
-
-
- Overrides: -
-
-
-
-
- - Service#send - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source: -
-
-
-
-
- - types/service.js, line 852 - -
-
-
-
-
-
-
-
-
Returns:
- - --
-
- - Type - -
- - - Service - - - -
set(path) → {Mixed}
- - - - - - -Parameters:
- - -Name | - - -Type | - - - - - -Description | -
---|---|---|
path |
-
-
- - - - Path - - - - | - - - - - -Key to retrieve. | -
-
-
-
-
-
-
-
-
-
-
- Overrides: -
-
-
-
-
- - Service#set - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source: -
-
-
-
-
- - types/service.js, line 317 - -
-
-
-
-
-
-
-
-
Returns:
- - - - --
-
- - Type - -
- - - Mixed - - - -
(async) start() → {Promise}
- - - - - - --
-
-
-
-
-
-
-
-
-
- Overrides: -
-
-
-
-
- - Service#start - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source: -
-
-
-
-
- - types/app.js, line 121 - -
-
-
-
-
-
-
-
-
Returns:
- - - - --
-
- - Type - -
- - - Promise - - - -
(async) stop() → {Promise}
- - - - - - --
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
-
-
-
-
- - types/app.js, line 147 - -
-
-
-
-
-
-
-
-
Returns:
- - - - --
-
- - Type - -
- - - Promise - - - -
tick() → {Number}
- - - - - - --
-
-
-
-
-
-
-
-
-
- Overrides: -
-
-
-
-
- - Service#tick - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source: -
-
-
-
-
- - types/service.js, line 248 - -
-
-
-
-
-
-
-
-
Returns:
- - - - --
-
- - Type - -
- - - Number - - - -
trust(source) → {Service}
- - - - - - -Parameters:
- - -Name | - - -Type | - - - - - -Description | -
---|---|---|
source |
-
-
- - - - EventEmitter - - - - | - - - - - -Emitter of events. | -
-
-
-
-
-
-
-
-
-
-
- Overrides: -
-
-
-
-
- - Service#trust - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source: -
-
-
-
-
- - types/service.js, line 328 - -
-
-
-
-
-
-
-
-
Returns:
- - --
-
- - Type - -
- - - Service - - - -
use(name, definition) → {App}
- - - - - - -Parameters:
- - -Name | - - -Type | - - - - - -Description | -
---|---|---|
name |
-
-
- - - - String - - - - | - - - - - -Human-friendly name for this resource. | -
definition |
-
-
- - - - Object - - - - | - - - - - -Map of configuration values. | -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
-
-
-
-
- - types/app.js, line 299 - -
-
-
-
-
-
-
-
-
Returns:
- - --
-
- - Type - -
- - - App - - - -