tooling
Accepts static debug information from laxar-loader/debug-info
and listens on the debug event bus to
supply development tools with the current state of the LaxarJS instance and bootstrapping items:
Contents
Module Members
Types
Module Members
create()
Exposes inspection data from laxarjs services to development tools
Types
AxTooling
AxTooling.forItem( itemMeta )
Get an #AxTooling
interface for the given bootstrapping item.
Parameters
Property | Type | Description |
---|---|---|
itemMeta | ItemMeta |
an object identifying the bootstrapping item |
Returns
Type | Description |
---|---|
AxTooling |
a tooling API for the given bootstrapping item |
AxTooling.registerDebugInfo( debugInfo )
Register a debug info object or callback with the tooling instance. Debug information can be generated
with laxar-loader/debug-info
and may be in the form a function accepting a callback.
If debug information is needed, the function will be called to load it asynchronously.
Parameters
Property | Type | Description |
---|---|---|
debugInfo | Object , Function |
a debug information callback or object |
AxTooling.registerItem( itemMeta )
Register a bootstrapping item with the tooling instance.
Parameters
Property | Type | Description |
---|---|---|
itemMeta | ItemMeta |
an object identifying the bootstrapping item |
AxTooling.onChange( callback )
Register a function to be called when the composition of active observed items changes.
Parameters
Property | Type | Description |
---|---|---|
callback | Function |
a function to call with updated debug information |
Returns
Type | Description |
---|---|
AxTooling |
the tooling instance |
AxTooling.unsubscribe( callback )
Unsubscribe a registered #AxTooling.onChange
callback
Parameters
Property | Type | Description |
---|---|---|
callback | Function |
a function that was previously passed to #AxTooling.onChange |
Returns
Type | Description |
---|---|
AxTooling |
the tooling instance |
AxTooling.pages PagesTooling
A PagesTooling
interface to the AxTooling
instance.