UNPKG

12.9 kBJavaScriptView Raw
1"use strict";
2Object.defineProperty(exports, "__esModule", { value: true });
3var index_1 = require("../index");
4var DOMEventProducer = /** @class */ (function () {
5 function DOMEventProducer(node, eventType, useCapture) {
6 this.node = node;
7 this.eventType = eventType;
8 this.useCapture = useCapture;
9 this.type = 'fromEvent';
10 }
11 DOMEventProducer.prototype._start = function (out) {
12 this.listener = function (e) { return out._n(e); };
13 this.node.addEventListener(this.eventType, this.listener, this.useCapture);
14 };
15 DOMEventProducer.prototype._stop = function () {
16 this.node.removeEventListener(this.eventType, this.listener, this.useCapture);
17 this.listener = null;
18 };
19 return DOMEventProducer;
20}());
21exports.DOMEventProducer = DOMEventProducer;
22var NodeEventProducer = /** @class */ (function () {
23 function NodeEventProducer(node, eventName) {
24 this.node = node;
25 this.eventName = eventName;
26 this.type = 'fromEvent';
27 }
28 NodeEventProducer.prototype._start = function (out) {
29 this.listener = function () {
30 var args = [];
31 for (var _i = 0; _i < arguments.length; _i++) {
32 args[_i] = arguments[_i];
33 }
34 return (args.length > 1) ? out._n(args) : out._n(args[0]);
35 };
36 this.node.addListener(this.eventName, this.listener);
37 };
38 NodeEventProducer.prototype._stop = function () {
39 this.node.removeListener(this.eventName, this.listener);
40 this.listener = null;
41 };
42 return NodeEventProducer;
43}());
44exports.NodeEventProducer = NodeEventProducer;
45function isEmitter(element) {
46 return element.emit && element.addListener;
47}
48/**
49 * Creates a stream based on either:
50 * - DOM events with the name `eventName` from a provided target node
51 * - Events with the name `eventName` from a provided NodeJS EventEmitter
52 *
53 * When creating a stream from EventEmitters, if the source event has more than
54 * one argument all the arguments will be aggregated into an array in the
55 * result stream.
56 *
57 * (Tip: when using this factory with TypeScript, you will need types for
58 * Node.js because fromEvent knows how to handle both DOM events and Node.js
59 * EventEmitter. Just install `@types/node`)
60 *
61 * Marble diagram:
62 *
63 * ```text
64 * fromEvent(element, eventName)
65 * ---ev--ev----ev---------------
66 * ```
67 *
68 * Examples:
69 *
70 * ```js
71 * import fromEvent from 'xstream/extra/fromEvent'
72 *
73 * const stream = fromEvent(document.querySelector('.button'), 'click')
74 * .mapTo('Button clicked!')
75 *
76 * stream.addListener({
77 * next: i => console.log(i),
78 * error: err => console.error(err),
79 * complete: () => console.log('completed')
80 * })
81 * ```
82 *
83 * ```text
84 * > 'Button clicked!'
85 * > 'Button clicked!'
86 * > 'Button clicked!'
87 * ```
88 *
89 * ```js
90 * import fromEvent from 'xstream/extra/fromEvent'
91 * import {EventEmitter} from 'events'
92 *
93 * const MyEmitter = new EventEmitter()
94 * const stream = fromEvent(MyEmitter, 'foo')
95 *
96 * stream.addListener({
97 * next: i => console.log(i),
98 * error: err => console.error(err),
99 * complete: () => console.log('completed')
100 * })
101 *
102 * MyEmitter.emit('foo', 'bar')
103 * ```
104 *
105 * ```text
106 * > 'bar'
107 * ```
108 *
109 * ```js
110 * import fromEvent from 'xstream/extra/fromEvent'
111 * import {EventEmitter} from 'events'
112 *
113 * const MyEmitter = new EventEmitter()
114 * const stream = fromEvent(MyEmitter, 'foo')
115 *
116 * stream.addListener({
117 * next: i => console.log(i),
118 * error: err => console.error(err),
119 * complete: () => console.log('completed')
120 * })
121 *
122 * MyEmitter.emit('foo', 'bar', 'baz', 'buzz')
123 * ```
124 *
125 * ```text
126 * > ['bar', 'baz', 'buzz']
127 * ```
128 *
129 * @factory true
130 * @param {EventTarget|EventEmitter} element The element upon which to listen.
131 * @param {string} eventName The name of the event for which to listen.
132 * @param {boolean?} useCapture An optional boolean that indicates that events of
133 * this type will be dispatched to the registered listener before being
134 * dispatched to any EventTarget beneath it in the DOM tree. Defaults to false.
135 * @return {Stream}
136 */
137function fromEvent(element, eventName, useCapture) {
138 if (useCapture === void 0) { useCapture = false; }
139 if (isEmitter(element)) {
140 return new index_1.Stream(new NodeEventProducer(element, eventName));
141 }
142 else {
143 return new index_1.Stream(new DOMEventProducer(element, eventName, useCapture));
144 }
145}
146exports.default = fromEvent;
147//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"fromEvent.js","sourceRoot":"","sources":["../src/extra/fromEvent.ts"],"names":[],"mappings":";;AAEA,kCAAoE;AAEpE;IAIE,0BAAoB,IAAiB,EACjB,SAAiB,EACjB,UAAmB;QAFnB,SAAI,GAAJ,IAAI,CAAa;QACjB,cAAS,GAAT,SAAS,CAAQ;QACjB,eAAU,GAAV,UAAU,CAAS;QALhC,SAAI,GAAG,WAAW,CAAC;IAM1B,CAAC;IAED,iCAAM,GAAN,UAAO,GAA4B;QACjC,IAAI,CAAC,QAAQ,GAAG,UAAC,CAAC,IAAK,OAAA,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAT,CAAS,CAAC;QACjC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAC7E,CAAC;IAED,gCAAK,GAAL;QACE,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,QAAe,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACrF,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACvB,CAAC;IACH,uBAAC;AAAD,CAAC,AAlBD,IAkBC;AAlBY,4CAAgB;AAoB7B;IAIE,2BAAoB,IAAkB,EAAU,SAAiB;QAA7C,SAAI,GAAJ,IAAI,CAAc;QAAU,cAAS,GAAT,SAAS,CAAQ;QAH1D,SAAI,GAAG,WAAW,CAAC;IAG2C,CAAC;IAEtE,kCAAM,GAAN,UAAO,GAA0B;QAC/B,IAAI,CAAC,QAAQ,GAAG;YAAC,cAAmB;iBAAnB,UAAmB,EAAnB,qBAAmB,EAAnB,IAAmB;gBAAnB,yBAAmB;;YAClC,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5D,CAAC,CAAC;QACF,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IACvD,CAAC;IAED,iCAAK,GAAL;QACE,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,QAAe,CAAC,CAAC;QAC/D,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACvB,CAAC;IACH,wBAAC;AAAD,CAAC,AAjBD,IAiBC;AAjBY,8CAAiB;AAmB9B,mBAAmB,OAAY;IAC7B,OAAO,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,WAAW,CAAC;AAC7C,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwFG;AACH,mBAAkC,OAAmC,EACnC,SAAiB,EACjB,UAA2B;IAA3B,2BAAA,EAAA,kBAA2B;IAC3D,IAAI,SAAS,CAAC,OAAO,CAAC,EAAE;QACtB,OAAO,IAAI,cAAM,CAAM,IAAI,iBAAiB,CAAC,OAAuB,EAAE,SAAS,CAAC,CAAC,CAAC;KACnF;SAAM;QACL,OAAO,IAAI,cAAM,CAAQ,IAAI,gBAAgB,CAAC,OAAsB,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC;KAC/F;AACH,CAAC;AARD,4BAQC","sourcesContent":["/// <reference types=\"node\" />\nimport {EventEmitter} from 'events';\nimport {Stream, InternalProducer, InternalListener} from '../index';\n\nexport class DOMEventProducer implements InternalProducer<Event> {\n  public type = 'fromEvent';\n  private listener: EventListener | null;\n\n  constructor(private node: EventTarget,\n              private eventType: string,\n              private useCapture: boolean) {\n  }\n\n  _start(out: InternalListener<Event>) {\n    this.listener = (e) => out._n(e);\n    this.node.addEventListener(this.eventType, this.listener, this.useCapture);\n  }\n\n  _stop() {\n    this.node.removeEventListener(this.eventType, this.listener as any, this.useCapture);\n    this.listener = null;\n  }\n}\n\nexport class NodeEventProducer implements InternalProducer<any> {\n  public type = 'fromEvent';\n  private listener: Function | null;\n\n  constructor(private node: EventEmitter, private eventName: string) { }\n\n  _start(out: InternalListener<any>) {\n    this.listener = (...args: Array<any>) => {\n      return (args.length > 1) ? out._n(args) : out._n(args[0]);\n    };\n    this.node.addListener(this.eventName, this.listener);\n  }\n\n  _stop() {\n    this.node.removeListener(this.eventName, this.listener as any);\n    this.listener = null;\n  }\n}\n\nfunction isEmitter(element: any): boolean {\n  return element.emit && element.addListener;\n}\n\n/**\n * Creates a stream based on either:\n * - DOM events with the name `eventName` from a provided target node\n * - Events with the name `eventName` from a provided NodeJS EventEmitter\n *\n * When creating a stream from EventEmitters, if the source event has more than\n * one argument all the arguments will be aggregated into an array in the\n * result stream.\n *\n * (Tip: when using this factory with TypeScript, you will need types for\n * Node.js because fromEvent knows how to handle both DOM events and Node.js\n * EventEmitter. Just install `@types/node`)\n *\n * Marble diagram:\n *\n * ```text\n *   fromEvent(element, eventName)\n * ---ev--ev----ev---------------\n * ```\n *\n * Examples:\n *\n * ```js\n * import fromEvent from 'xstream/extra/fromEvent'\n *\n * const stream = fromEvent(document.querySelector('.button'), 'click')\n *   .mapTo('Button clicked!')\n *\n * stream.addListener({\n *   next: i => console.log(i),\n *   error: err => console.error(err),\n *   complete: () => console.log('completed')\n * })\n * ```\n *\n * ```text\n * > 'Button clicked!'\n * > 'Button clicked!'\n * > 'Button clicked!'\n * ```\n *\n * ```js\n * import fromEvent from 'xstream/extra/fromEvent'\n * import {EventEmitter} from 'events'\n *\n * const MyEmitter = new EventEmitter()\n * const stream = fromEvent(MyEmitter, 'foo')\n *\n * stream.addListener({\n *   next: i => console.log(i),\n *   error: err => console.error(err),\n *   complete: () => console.log('completed')\n * })\n *\n * MyEmitter.emit('foo', 'bar')\n * ```\n *\n * ```text\n * > 'bar'\n * ```\n *\n * ```js\n * import fromEvent from 'xstream/extra/fromEvent'\n * import {EventEmitter} from 'events'\n *\n * const MyEmitter = new EventEmitter()\n * const stream = fromEvent(MyEmitter, 'foo')\n *\n * stream.addListener({\n *   next: i => console.log(i),\n *   error: err => console.error(err),\n *   complete: () => console.log('completed')\n * })\n *\n * MyEmitter.emit('foo', 'bar', 'baz', 'buzz')\n * ```\n *\n * ```text\n * > ['bar', 'baz', 'buzz']\n * ```\n *\n * @factory true\n * @param {EventTarget|EventEmitter} element The element upon which to listen.\n * @param {string} eventName The name of the event for which to listen.\n * @param {boolean?} useCapture An optional boolean that indicates that events of\n * this type will be dispatched to the registered listener before being\n * dispatched to any EventTarget beneath it in the DOM tree. Defaults to false.\n * @return {Stream}\n */\nexport default function fromEvent(element: EventTarget | EventEmitter,\n                                  eventName: string,\n                                  useCapture: boolean = false): Stream<Event|any> {\n  if (isEmitter(element)) {\n    return new Stream<any>(new NodeEventProducer(element as EventEmitter, eventName));\n  } else {\n    return new Stream<Event>(new DOMEventProducer(element as EventTarget, eventName, useCapture));\n  }\n}\n"]}
\No newline at end of file