Updating JSDocs

This commit is contained in:
Michael Jerred
2015-07-20 17:20:17 +01:00
parent e768494136
commit df5dbd84b2
+5 -2
View File
@@ -106,7 +106,7 @@ declare module Bacon {
/**
* @function
* @description Creates an [EventStream]{@link Bacon.EventStream} from events on a DOM EventTarget or Node.JS EventEmitter object, or an object that supports event listeners using `on`/`off` methods.
* @param {EventTarget|NodeJS.EventEmitter} target
* @param {EventTarget|NodeJS.EventEmitter|JQuery} target
* @param {string} eventName
* @returns {EventStream<E, A>}
* @example
@@ -116,6 +116,9 @@ declare module Bacon {
* Bacon.fromEvent(process.stdin, "readable", () => {
* alert("Bacon!");
* });
* Bacon.fromEvent($("body"), "click").onValue(() => {
* alert("Bacon!");
* });
*/
function fromEvent<E, A>(target:EventTarget|NodeJS.EventEmitter|JQuery, eventName:string):EventStream<E, A>;
@@ -127,7 +130,7 @@ declare module Bacon {
/**
* @function Bacon.fromEvent
* @description Creates an [EventStream]{@link Bacon.EventStream} from events on a DOM EventTarget or Node.JS EventEmitter object, or an object that supports event listeners using `on`/`off` methods. You can pass a function `eventTransformer` that transforms the emitted events' parameters.
* @param {EventTarget|NodeJS.EventEmitter} target
* @param {EventTarget|NodeJS.EventEmitter|JQuery} target
* @param {string} eventName
* @param {Bacon.fromEvent~eventTransformer} eventTransformer
* @returns {EventStream<E, B>}