npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

rxjs-interop

v2.0.0

Published

Observable interop helpers for RxJS

Downloads

242,016

Readme

rxjs-interop

GitHub License NPM version Build status dependency status devDependency Status peerDependency Status

What is it?

A package that contains interop helper functions and types for use with RxJS.

Why might you need it?

Observables exist independently of RxJS. There are TC39 and WHATWG observable proposals. The helpers in this package make it easy to implement observables that will work with or without RxJS and will still play nice - with RxJS - if Symbol.observable is not configured.

For more information on RxJS interop, see this blog post.

This package has no dependency on RxJS and is small, but if you want to publish an interop package with no dependencies, just copy the license and the code from this project into yours.

Install

Install the package using NPM:

npm install rxjs-interop --save

Usage

Interop observables expose an observable factory via the Symbol.observable property, like this:

export const interop = {
  [Symbol.observable]: () => {
    return {
      subscribe(nextOrObserver, error, complete) {
        /* figure out whether it's a next callback or an observer */
        /* call observer methods */
        return () => { /* some teardown logic */ };
      }
    };
  }
});

For this to work with RxJS, the caller will need to initialize Symbol.observable - which makes things more complicated.

You can use the toObserver and patch helpers in this package to more easily implement subscribe and to make sure that the interop observable will work with RxJS without Symbol.observable having to be initialized:

import { patch, toObserver } from "rxjs-interop";

export const interop = patch({
  [Symbol.observable]: () => {
    return {
      subscribe(nextOrObserver, error, complete) {
        const observer = toObserver(nextOrObserver, error, complete);
        /* call observer methods */
        return () => { /* some teardown logic */ };
      }
    };
  }
});

patch can be passed either an interop observable instance or the constructor of an interop observable class - see the tests for usage.

For an example of how this package can be used to implement things that can be used with or without RxJS, check out Christoph Guttandin's subscribable-things.