UNPKG

canonical

Version:

Canonical code style linter and formatter for JavaScript, SCSS and CSS.

74 lines (73 loc) 5.52 kB
{ "_args": [ [ "event-emitter@https://registry.npmjs.org/event-emitter/-/event-emitter-0.3.4.tgz", "/Users/gajus/Documents/dev/canonical-code-style/canonical" ] ], "_from": "event-emitter@>=0.3.4 <0.4.0", "_id": "event-emitter@0.3.4", "_inCache": true, "_location": "/event-emitter", "_phantomChildren": {}, "_requested": { "name": "event-emitter", "raw": "event-emitter@https://registry.npmjs.org/event-emitter/-/event-emitter-0.3.4.tgz", "rawSpec": "https://registry.npmjs.org/event-emitter/-/event-emitter-0.3.4.tgz", "scope": null, "spec": "https://registry.npmjs.org/event-emitter/-/event-emitter-0.3.4.tgz", "type": "remote" }, "_requiredBy": [ "/es6-map", "/es6-set" ], "_resolved": "https://registry.npmjs.org/event-emitter/-/event-emitter-0.3.4.tgz", "_shasum": "8d63ddfb4cfe1fae3b32ca265c4c720222080bb5", "_shrinkwrap": null, "_spec": "event-emitter@https://registry.npmjs.org/event-emitter/-/event-emitter-0.3.4.tgz", "_where": "/Users/gajus/Documents/dev/canonical-code-style/canonical", "author": { "email": "medyk@medikoo.com", "name": "Mariusz Nowak", "url": "http://www.medikoo.com/" }, "bugs": { "url": "https://github.com/medikoo/event-emitter/issues" }, "dependencies": { "d": "~0.1.1", "es5-ext": "~0.10.7" }, "description": "Environment agnostic event emitter", "devDependencies": { "tad": "~0.2.3", "xlint": "~0.2.2", "xlint-jslint-medikoo": "~0.1.4" }, "homepage": "https://github.com/medikoo/event-emitter#readme", "keywords": [ "emitter", "event", "events", "listener", "observer", "pubsub", "trigger" ], "license": "MIT", "name": "event-emitter", "optionalDependencies": {}, "readme": "# event-emitter\n## Environment agnostic event emitter\n\n### Installation\n\n\t$ npm install event-emitter\n\t\nTo port it to Browser or any other (non CJS) environment, use your favorite CJS bundler. No favorite yet? Try: [Browserify](http://browserify.org/), [Webmake](https://github.com/medikoo/modules-webmake) or [Webpack](http://webpack.github.io/)\n\n### Usage\n\n```javascript\nvar ee = require('event-emitter');\n\nvar emitter = ee({}), listener;\n\nemitter.on('test', listener = function (args) {\n // …emitter logic\n});\n\nemitter.once('test', function (args) {\n // …invoked only once(!)\n});\n\nemitter.emit('test', arg1, arg2/*…args*/); // Two above listeners invoked\nemitter.emit('test', arg1, arg2/*…args*/); // Only first listener invoked\n\nemitter.off('test', listener); // Removed first listener\nemitter.emit('test', arg1, arg2/*…args*/); // No listeners invoked\n```\n### Additional utilities\n\n#### allOff(obj) _(event-emitter/all-off)_\n\nRemoves all listeners from given event emitter object\n\n#### hasListeners(obj[, name]) _(event-emitter/has-listeners)_\n\nWhether object has some listeners attached to the object.\nWhen `name` is provided, it checks listeners for specific event name\n\n```javascript\nvar emitter = ee();\nvar hasListeners = require('event-emitter/has-listeners');\nvar listener = function () {};\n\nhasListeners(emitter); // false\n\nemitter.on('foo', listener);\nhasListeners(emitter); // true\nhasListeners(emitter, 'foo'); // true\nhasListeners(emitter, 'bar'); // false\n\nemitter.off('foo', listener);\nhasListeners(emitter, 'foo'); // false\n```\n\n#### pipe(source, target[, emitMethodName]) _(event-emitter/pipe)_\n\nPipes all events from _source_ emitter onto _target_ emitter (all events from _source_ emitter will be emitted also on _target_ emitter, but not other way). \nReturns _pipe_ object which exposes `pipe.close` function. Invoke it to close configured _pipe_. \nIt works internally by redefinition of `emit` method, if in your interface this method is referenced differently, provide its name (or symbol) with third argument.\n\n#### unify(emitter1, emitter2) _(event-emitter/unify)_\n\nUnifies event handling for two objects. Events emitted on _emitter1_ would be also emitter on _emitter2_, and other way back. \nNon reversible.\n\n```javascript\nvar eeUnify = require('event-emitter/unify');\n\nvar emitter1 = ee(), listener1, listener3;\nvar emitter2 = ee(), listener2, listener4;\n\nemitter1.on('test', listener1 = function () { });\nemitter2.on('test', listener2 = function () { });\n\nemitter1.emit('test'); // Invoked listener1\nemitter2.emit('test'); // Invoked listener2\n\nvar unify = eeUnify(emitter1, emitter2);\n\nemitter1.emit('test'); // Invoked listener1 and listener2\nemitter2.emit('test'); // Invoked listener1 and listener2\n\nemitter1.on('test', listener3 = function () { });\nemitter2.on('test', listener4 = function () { });\n\nemitter1.emit('test'); // Invoked listener1, listener2, listener3 and listener4\nemitter2.emit('test'); // Invoked listener1, listener2, listener3 and listener4\n```\n\n### Tests [![Build Status](https://travis-ci.org/medikoo/event-emitter.png)](https://travis-ci.org/medikoo/event-emitter)\n\n\t$ npm test\n", "readmeFilename": "README.md", "repository": { "type": "git", "url": "git://github.com/medikoo/event-emitter.git" }, "scripts": { "lint": "node node_modules/xlint/bin/xlint --linter=node_modules/xlint-jslint-medikoo/index.js --no-cache --no-stream", "lint-console": "node node_modules/xlint/bin/xlint --linter=node_modules/xlint-jslint-medikoo/index.js --watch", "test": "node ./node_modules/tad/bin/tad" }, "version": "0.3.4" }