Home

The mechanic documentation is broken down by module. Additional work is being done to add examples and usages for each function available in the mechanic library.

In the meantime, the documentation should provide context on what each function expects and should return. For ultimate clarity, refer to the source code!

APIs

• Core (mechanic-core.js)
• Events (events.js)
• Data (data.js)
• Logging (logging.js)

Usage Note

If you are importing these files individually, mechanic-core.js should always be imported first. The other files extend the definition of the mechanic object.