.config/coc/extensions/node_modules/coc-prettier/node_modules/component-emitter/Readme.md

   1 # Emitter [![Build Status](https://travis-ci.org/component/emitter.png)](https://travis-ci.org/component/emitter)\r
   2 \r
   3   Event emitter component.\r
   4 \r
   5 ## Installation\r
   6 \r
   7 ```\r
   8 $ component install component/emitter\r
   9 ```\r
  10 \r
  11 ## API\r
  12 \r
  13 ### Emitter(obj)\r
  14 \r
  15   The `Emitter` may also be used as a mixin. For example\r
  16   a "plain" object may become an emitter, or you may\r
  17   extend an existing prototype.\r
  18 \r
  19   As an `Emitter` instance:\r
  20 \r
  21 ```js\r
  22 var Emitter = require('emitter');\r
  23 var emitter = new Emitter;\r
  24 emitter.emit('something');\r
  25 ```\r
  26 \r
  27   As a mixin:\r
  28 \r
  29 ```js\r
  30 var Emitter = require('emitter');\r
  31 var user = { name: 'tobi' };\r
  32 Emitter(user);\r
  33 \r
  34 user.emit('im a user');\r
  35 ```\r
  36 \r
  37   As a prototype mixin:\r
  38 \r
  39 ```js\r
  40 var Emitter = require('emitter');\r
  41 Emitter(User.prototype);\r
  42 ```\r
  43 \r
  44 ### Emitter#on(event, fn)\r
  45 \r
  46   Register an `event` handler `fn`.\r
  47 \r
  48 ### Emitter#once(event, fn)\r
  49 \r
  50   Register a single-shot `event` handler `fn`,\r
  51   removed immediately after it is invoked the\r
  52   first time.\r
  53 \r
  54 ### Emitter#off(event, fn)\r
  55 \r
  56   * Pass `event` and `fn` to remove a listener.\r
  57   * Pass `event` to remove all listeners on that event.\r
  58   * Pass nothing to remove all listeners on all events.\r
  59 \r
  60 ### Emitter#emit(event, ...)\r
  61 \r
  62   Emit an `event` with variable option args.\r
  63 \r
  64 ### Emitter#listeners(event)\r
  65 \r
  66   Return an array of callbacks, or an empty array.\r
  67 \r
  68 ### Emitter#hasListeners(event)\r
  69 \r
  70   Check if this emitter has `event` handlers.\r
  71 \r
  72 ## License\r
  73 \r
  74 MIT\r