Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tj committed May 2, 2012
1 parent 709deff commit d69fcf2
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@

# Emitter

Event emitter component.

## Installation

$ npm install emitter-component

## API


### Emitter#on(event, fn)

Register an `event` handler `fn`.

### Emitter#once(event, fn)

Register a single-shot `event` handler `fn`,
removed immediately after it is invoked the
first time.

### Emitter#off(event, fn)

Remove `event` handler `fn`, or pass only the `event`
name to remove all handlers for `event`.

### Emitter#emit(event, ...)

Emit an `event` with variable option args.

0 comments on commit d69fcf2

Please sign in to comment.