From df5dbd84b2b473eab99014b3576b9640538a685e Mon Sep 17 00:00:00 2001 From: Michael Jerred Date: Mon, 20 Jul 2015 17:20:17 +0100 Subject: [PATCH] Updating JSDocs --- baconjs/baconjs.d.ts | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/baconjs/baconjs.d.ts b/baconjs/baconjs.d.ts index a831e74f6..2021b3dd7 100644 --- a/baconjs/baconjs.d.ts +++ b/baconjs/baconjs.d.ts @@ -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} * @example @@ -116,6 +116,9 @@ declare module Bacon { * Bacon.fromEvent(process.stdin, "readable", () => { * alert("Bacon!"); * }); + * Bacon.fromEvent($("body"), "click").onValue(() => { + * alert("Bacon!"); + * }); */ function fromEvent(target:EventTarget|NodeJS.EventEmitter|JQuery, eventName:string):EventStream; @@ -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}