Snapshot of tc39/proposal-observable: 3.1k★, JavaScript. Observables for ECMAScript
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
This proposal introduces an Observable type to the ECMAScript standard library.
The Observable type can be used to model push-based data sources such as DOM
events, timer intervals, and sockets. In addition, observables are:
Compositional: Observables can be composed with higher-order combinators.
Lazy: Observables do not start emitting data until an observer has subscribed.
Example: Observing Keyboard Events
Using the Observable constructor, we can create a function which returns an
observable stream of events for an arbitrary DOM element and event type.
function listen(element, eventName) {
return new Observable(observer => {
// Create an event handler which sends data to the sink
let handler = event => observer.next(event);
// Attach the event handler
element.addEventListener(eventName, handler, true);
// Return a cleanup function which will cancel the event stream
return () => {
// Detach the event handler from the element
element.removeEventListener(eventName, handler, true);
};
});
}
We can then use standard combinators to filter and map the events in the stream,
just like we would with an array.
// Return an observable of special key down commands
function commandKeys(element) {
let keyCommands = { "38": "up", "40": "down" };
return listen(element, "keydown")
.filter(event => event.keyCode in keyCommands)
.map(event => keyCommands[event.keyCode])
}
Note: The "filter" and "map" methods are not included in this proposal. They may
be added in a future version of this specification.
When we want to consume the event stream, we subscribe with an observer.
The object returned by subscribe will allow us to cancel the subscription at any time.
Upon cancelation, the Observable's cleanup function will be executed.
// After calling this function, no more events will be sent
subscription.unsubscribe();
Motivation
The Observable type represents one of the fundamental protocols for processing asynchronous
streams of data. It is particularly effective at modeling streams of data which originate
from the environment and are pushed into the application, such as user interface events. By
offering Observable as a component of the ECMAScript standard library, we allow platforms
and applications to share a common push-based stream protocol.
Implementations
RxJS 5
core-js
zen-observable
fate-observable
Running Tests
To run the unit tests, install the es-observable-tests package into your project.
npm install es-observable-tests
Then call the exported runTests function with the constructor you want to test.
An Observable represents a sequence of values which may be observed.
interface Observable {
constructor(subscriber : SubscriberFunction);
// Subscribes to the sequence with an observer
subscribe(observer : Observer) : Subscription;
// Subscribes to the sequence with callbacks
subscribe(onNext : Function,
onError? : Function,
onComplete? : Function) : Subscription;
// Returns itself
[Symbol.observable]() : Observable;
// Converts items to an Observable
static of(...items) : Observable;
// Converts an observable or iterable to an Observable
static from(observable) : Observable;
}
interface Subscription {
// Cancels the subscription
unsubscribe() : void;
// A boolean value indicating whether the subscription is closed
get closed() : Boolean;
}
function SubscriberFunction(observer: SubscriptionObserver) : (void => void)|Subscription;
Observable.of
Observable.of creates an Observable of the values provided as arguments. The values
are delivered synchronously when subscribe is called.
Observable.from converts its argument to an Observable.
If the argument has a Symbol.observable method, then it returns the result of
invoking that method. If the resulting object is not an instance of Observable,
then it is wrapped in an Observable which will delegate subscription.
Otherwise, the argument is assumed to be an iterable and the iteration values are
delivered synchronously when subscribe is called.
Converting from an object which supports Symbol.observable to an Observable:
An Observer is used to receive data from an Observable, and is supplied as an
argument to subscribe.
All methods are optional.
interface Observer {
// Receives the subscription object when `subscribe` is called
start(subscription : Subscription);
// Receives the next value in the sequence
next(value);
// Receives the sequence error
error(errorValue);
// Receives a completion notification
complete();
}
SubscriptionObserver
A SubscriptionObserver is a normalized Observer which wraps the observer object supplied to
subscribe.
interface SubscriptionObserver {
// Sends the next value in the sequence
next(value);
// Sends the sequence error
error(errorValue);
// Sends the completion notification
complete();
// A boolean value indicating whether the subscription is closed
get closed() : Boolean;
}
TopGit's last sync did not record any GitHub topics for tc39/proposal-observable. GitHub topics appear in the right sidebar of a repository page; that's the authoritative place to check.
How active is development on tc39/proposal-observable?
The most recent commit recorded on tc39/proposal-observable was 6.8 years ago, based on the GitHub push timestamp. The repository has 89 forks — one of the better signals of community interest.
How many stars does tc39/proposal-observable have?
tc39/proposal-observable has 3.1k GitHub stars — refresh the page for the live number, or check github.com/tc39/proposal-observable. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
What is tc39/proposal-observable?
tc39/proposal-observable (tc39/proposal-observable) is a JavaScript project on GitHub. From the project's own README: Observables for ECMAScript
What language is tc39/proposal-observable written in?
tc39/proposal-observable is written primarily in JavaScript. GitHub's language field is based on the largest share of bytes in the default branch.
Read full README in the tab above.
Is proposal-observable worth your time?
ChatGPT, Claude and Perplexity can all read this page. Ask one of them what it makes of proposal-observable.