Skip to content

choojs/choo-hooks

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

choo-hooks stability

npm version build status downloads js-standard-style

Hook into Choo's events and timings. Useful to create loggers, analytics and more.

Usage

var Hooks = require('choo-hooks')
var choo = require('choo')

var app = choo()
app.use(function (state, emitter) {
  var hooks = Hooks(emitter)
  hooks.on('event', function (eventName, timing, data) {
    console.log(eventName + ':', timing.duration + 'ms', data)
  })

  hooks.on('unhandled', function (eventName, data) {
    console.error('No listeners for ' + eventName)
  })
})

API

hooks = Hooks(emitter)

Create a new Choo Hooks instance.

hook.on('log:trace', cb(…args))

hook.on('log:debug', cb(…args))

hook.on('log:info', cb(…args))

hook.on('log:warn', cb(…args))

hook.on('log:error', cb(…args))

hook.on('log:fatal', cb(…args))

Listen for log events.

hook.on('service-worker', cb(data))

Listen for service worker event.

hook.on('event', cb(eventName, timing, data))

Called for events implemented at the application layer.

hook.on('unhandled', cb(eventName, data))

Called whenever an event is emitted, and there is no handler available.

hook.on('DOMContentLoaded', cb(timing))

Called whenever the DOM has loaded. Returns the window.performance.timing object.

hook.on('render', cb(timings))

Called whenever Choo renders. Returns an object with the render and morph properties.

hook.on('resourceTimingBufferFull', cb())

Called whenever the browser's resource timing buffer has filled up.

License

MIT