Collection of NLU matching criteria by key
Collection of NaturalLanguageResult instances by key
Collection of raw NLU results by key (also used for matched subset)
Collection of allowed adapter types for loading.
Collection of adapter types and their loaded adapter.
Keep all created bits, for getting by their ID as key
Await helper, pauses for event loop
Event Emitter for listening to bot events.
Global path to process any state not within specific isolated context.
Set keys to remove from data before keep
Winston logger provides a logging interface common to many Node apps, with custom levels, filters, and outputs, and service integrations. It will also handle exceptions and exit after logging (except middleware).
By default, all log items will write to console and a combined log file, errors also write to a an error log file. Log level can be set globally or for each transport:
Collection of middleware types and their stacks.
Access the settings instance, to replace options and reload config
Register middleware piece to execute with catch-all match
Utility for converting option keys, from foo-bar to fooBar
Empty memory and start fresh with minimal empty collections
Stop saving data
Convert instance to plain object for storage
Get the next value in global counter
Key for counter, prepend to return value
Magic function to un-weird weird things
Build a regular expression that matches text prefixed with the bot's name
Execute a bit using its ID, providing current bot state
Query store for subset matching params, via adapter
Query store for single value matching params, via adapter
Retrieve value from memory by key within given (or default) collection.
Return config directly, without updating those in the settings instance
Find out where the loading or shutdown process is at.
Register middleware piece to execute before any matching
Utility for converting option keys, from fooBar to foo-bar
Keep serial data in collection, via adapter (converted to plain objects)
Register middleware piece to execute after branch match
Load all components. Extensions/adapters can interrupt or modify the stack before start.
Require adapter module from local path or NPM package. If a module name is given, it will be required as normal or from the parent module path. If that fails, attempt to load from the included adapters path. If local path given, attempt to resolve a number of possible locations in case bBot running from tests or as a local dependency (in development).
Load all adapters, but don't yet start them.
Update internal memory with any data set (mostly used on load)
Thought process middleware collection. Contains pieces for async execution at each stage of input processing loop.
Remove anything from collection in storage that matches params
Stop temporarily. Allow start to be called again without reloading
Generate a random unique ID value
Optionally prepend ID type
Register middleware piece to execute before storing data
Scrub it clean! Would allow redefining classes before calling start again, mostly for tests.
Register middleware piece to execute before sending any response
Save internal memory back to storage adapter (as
Save key-value pair under the collection namespace, extend existing data.
Set is used for temporal in-memory data for common interactions. For large
data sets that will be infrequently accessed, use
Save memory every x milliseconds
Private helper for setting and logging loading status.
Add new bit to collection, returning its ID
Make it stop! Stops responding but keeps history and loaded components. Will wait until started if shutdown called while starting.
Run shutdown on each adapter concurrently, to resolve when all shutdown
Save data and disconnect storage adapter
Make it go!
Start each adapter concurrently, to resolve when all ready.
Populate brian with temporal data from storage adapter and get started
Register middleware piece to execute with NLU before intent match
Unload adapters for resetting bot
Remove all middleware for reset
Remove item from memory by key and collection namespace (optional).
Get a User object by ID. If found and given meta, overwrites and returns updated user. if given meta and ID not found, creates new user.
Shortcut to get the user collection from memory
Get users by their name.
Maintain a list of global counters against their prefix key
Initial array of config options, can be extended prior and post load.
Save tracking vars
Internal storage for data, can hold any key/value collection
Internal index for loading status
Generated using TypeDoc