Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

documented .reset()

  • Loading branch information...
commit 35854c58bc486dc122d6066c8eb551387ac2b6a0 1 parent c623c73
@substack authored
Showing with 9 additions and 2 deletions.
  1. +9 −2 README.markdown
View
11 README.markdown
@@ -83,8 +83,8 @@ methods
var OrderedEmitter = require('ordered-emitter');
-new OrderedEmitter(opts={})
----------------------------
+var em = new OrderedEmitter(opts={})
+------------------------------------
`OrderedEmitter` acts just like an EventEmitter, except that any event that
emits objects as its first argument with numeric `order` keys will be buffered
@@ -94,6 +94,13 @@ By default, order keys are isolated by event names so the order keys from
different event names won't influence each other. However, you can have order
keys work across multiple event names by setting `opts.span` to `true`.
+em.reset(eventName)
+-------------------
+
+Reset the counter for an ordered emitter back to 0.
+
+If `eventName` is `undefined`, reset all the counters to 0.
+
install
=======
Please sign in to comment.
Something went wrong with that request. Please try again.