Big update!Announcing Socket for GitHub 1.0. Learn more
Socket
BlogLoveFAQ
Install
Log in

symbol-observable

Package Overview
Dependencies
0
Maintainers
3
Versions
19
Issues
File Explorer

Advanced tools

symbol-observable

Symbol.observable ponyfill

    4.0.0latest

Version published
Maintainers
3
Weekly downloads
13,003,561
decreased by-4.43%

Weekly downloads

Readme

Source

symbol-observable Build Status

Symbol.observable pony/polyfill

This will polyfill Symbol.observable if Symbol exists, but will not polyfill Symbol if it doesn't exist. Meant to be used as a "ponyfill", meaning you're meant to use the module's exported symbol value as described below. This is all done to ensure that everyone is using the same version of the symbol (or string depending on the environment), as per the nature of symbols in JavaScript.

Install

$ npm install --save symbol-observable

Basic Usage

const symbolObservable = require('symbol-observable').default; console.log(symbolObservable); //=> Symbol(observable) import Symbol_observable from 'symbol-observable'; console.log(Symbol_observable); //=> Symbol(observable)

Making an object "observable":

You can do something like what you see below to make any object "observable" by libraries like RxJS, XStream and Most.js.

Things to know:

  1. It's best if you just use one of the above libraries.
  2. If you're not, but sure you never next, error or complete on your observer after error or complete was called.
  3. Likewise, make sure you don't next, error or complete after unsubscribe is called on the returned object.
import Symbol_observable from 'symbol-observable'; someObject[Symbol_observable] = () => { return { subscribe(observer) { const handler = e => observer.next(e); someObject.addEventListener('data', handler); return { unsubscribe() { someObject.removeEventListener('data', handler); } } }, [Symbol_observable]() { return this } } }

Often, it's not very hard, but it can get tricky in some cases.

License

MIT © Sindre Sorhus and Ben Lesh

Keywords

FAQs

What is symbol-observable?

Symbol.observable ponyfill

Is symbol-observable popular?

The npm package symbol-observable receives a total of 10,865,120 weekly downloads. As such, symbol-observable popularity was classified as popular.

Is symbol-observable well maintained?

We found that symbol-observable demonstrated a not healthy version release cadence and project activity because the last version was released a year ago.It has 3 open source maintainers collaborating on the project.

Last updated on 15 Apr 2021
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc