Name of the KeyframeBot.
Constructor object.
Environments available.
Instance of express.
Instance of Github SDK API in use.
Github ServiceEmitter.
Github ServiceEmitter name.
Github ServiceListener name.
Product repo.
Add a new type of ServiceEmitter to the client. Should the ServiceEmitter already exist on the client with the handle/name, this will do nothing.
The name of the ServiceEmitter to add.
The constructed or pre-existing ServiceEmitter or void on failure.
Add a new type of ServiceListener to the client. Should the ServiceListener already exist on the client with the handle/name, this will do nothing.
The name of the ServiceListener to add.
The constructed or pre-existing ServiceListener or void on failure.
Creates a new branch on the specified environment for a given keyframe.
The details of the keyframe, user and version.
A string naming the branch created on fulfilment.
Deployment route method, hanging off an Express server. When a valid keyframe version and environment is passed, this will verify the product keyframe, and then create a new branch in the environment. The keyframe will be committed to this branch and a new PR will be based off it. This will automatically be linted by the process.
The HTTP request.
The HTTP response.
Dispatch to the specified emitter. This method exists as a shortcut to avoid having to retrieve a specific emitter before sending to it.
The ServiceEmitRequest to use. This will be dispatched to all ServiceEmitters.
An array of ServiceEmitResponses from all the ServiceEmitters.
Dispatch to a specific ServiceEmitter. This method exists as a shortcut to avoid having to retrieve a specific emitter before sending to it.
The handle of the ServiceEmitter to dispatch to.
Emitter appropriate data to send.
Data returned from the service represented by the ServiceEmitter.
Find a particular attached ServiceEmitter based upon its name.
Handle of the ServiceEmitter instance to find (name if no handle was set).
Instance of the ServiceEmitter found, or void if not found.
Find a particular attached ServiceListener based upon its handle.
Handle of the ServiceListener instance to find (name if no handle was set).
Instance of the ServiceListener found, or void if not found.
Retrieve the binary path for the Node dependencies.
A string containing the absolute path.
Lints a keyframe when the Github ServiceListener sees a PR open or synchronised.
Registration object for the event.
The Github event.
Void Promise fulfilled when the method has finished processing the event.
Process a configuration file from YAML into a nested object.
The configuration file as a string.
The configuration object or void.
Reports an error to the console.
The error to report.
Retrieve a ProcBotConfiguration file from a ServiceEmitter or inbuilt route.
An object detailing the service to retrieve the configuration file from, and its location.
A Promise containing configuration object should one have been found, or void.
Generated using TypeDoc
Constructor for the KeyframeBot.