diff --git a/baconjs/baconjs-tests.ts b/baconjs/baconjs-tests.ts index e542ef1c9..5d5998b70 100644 --- a/baconjs/baconjs-tests.ts +++ b/baconjs/baconjs-tests.ts @@ -28,6 +28,9 @@ function CreatingStreams() { Bacon.fromEvent(process.stdin, "readable", () => { alert("Bacon!"); }); + Bacon.fromEvent($("body"), "click").onValue(() => { + alert("Bacon!"); + }); // This would create a stream that outputs a single value "Bacon!" and ends after that. The use of setTimeout causes the value to be delayed by 1 second. Bacon.fromCallback(callback => { diff --git a/baconjs/baconjs.d.ts b/baconjs/baconjs.d.ts index 0e3f77c12..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,8 +116,11 @@ declare module Bacon { * Bacon.fromEvent(process.stdin, "readable", () => { * alert("Bacon!"); * }); + * Bacon.fromEvent($("body"), "click").onValue(() => { + * alert("Bacon!"); + * }); */ - function fromEvent(target:EventTarget|NodeJS.EventEmitter, eventName:string):EventStream; + function fromEvent(target:EventTarget|NodeJS.EventEmitter|JQuery, eventName:string):EventStream; /** * @callback Bacon.fromEvent~eventTransformer @@ -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} @@ -136,7 +139,7 @@ declare module Bacon { * alert("Bacon!"); * }); */ - function fromEvent(target:EventTarget|NodeJS.EventEmitter, eventName:string, eventTransformer:(event:A) => B):EventStream; + function fromEvent(target:EventTarget|NodeJS.EventEmitter|JQuery, eventName:string, eventTransformer:(event:A) => B):EventStream; /** * @callback Bacon.fromCallback1~f