bespoke-logbook
Log bespoke.js events and state to the console
The default events are logged by default, as are any custom events from plugins.
Download
Download the production version or the development version, or use a package manager.
Usage
This plugin is shipped in a UMD format, meaning that it is available as a CommonJS/AMD module or browser global.
For example, when using CommonJS modules:
var bespoke = logbook = ; bespoke;
When using browser globals:
bespoke;
Overriding event logging
You can override logging per eventName
, either at instantiation or dynamically. You can pass false
to turn off the specific logger, a plain string, or a function.
Custom events
The function will be called once before firing the event, and once after, with the result -
// Before the event handlers have been called // After all event handlers have been called
Default events
The default events are fired a bit differently than custom events - they aren't intercepted, but rather listened to.
// An event parameter is passed
Override at instantiation
bespokehorizontal;
Override dynamically
bespokepluginslogbook;
Enable/disable logbook
// logbook is making a lot of noise in the consolebespokepluginslogbook; // logbook is good as dead bespokepluginslogbook;// logbook is back once again, with the ill behaviour
Package managers
npm
$ npm install bespoke-logbook
Bower
$ bower install bespoke-logbook
TODO
- Accept separate before/after custom event overrides.
- Normalize default and custom event overrides.
- Mimic the default event handlers'
event
object? - Allow option to not autostart/enable logbook at instantiation.
Credits
Mark Dalgleish for bespoke.js and related tools. This plugin was built with generator-bespokeplugin.
Adam Edmond, addyeddy on flickr, for his photo Old log book (CC BY 2.0).
My best friend, bespoke-convenient, for continued support - rain and shine. I love you, man.
License
Copyright (c) 2013, 2014, Joel Purra All rights reserved.
When using bespoke-logbook, comply to the MIT license. Please see the LICENSE file for details, and the MIT License on Wikipedia.