JSPM

  • Created
  • Published
  • Downloads 658
  • Score
    100M100P100Q126109F
  • License Apache-2.0

Light observable ponyfill

Package Exports

  • light-observable

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (light-observable) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Light Observable

Build Status Coverage Status Written in typescript JavaScript Style Guide Commitizen friendly npm Greenkeeper badge

An implementation of Observables for JavaScript. Requires a Promise polyfill.

This is a fork of zen-observable. Some of extras are inspired by observable-operators.

Features:

  • Standard: fully compatible with the Observable Proposal.
  • Tiny: Observable itself is only 822 bytes in gzip.
  • Type-safe: written in typescript.
  • Reliable: 100% code coverage.
  • Moderate: only standard methods are included to the Observable and Observable prototype.

Extras

  • pipe: an utility to pipe functions together
    import { pipe } from 'light-observable'
    import { from } from 'rxjs'
    import { mergeMap } from 'rxjs/operators'
    
    import myStream from './myStream'
    
    const RxStream = pipe(
      from,
      mergeMap(...)
    )(myStream)
  • createSubject: an utility that returns a tuple of an observable stream and a controller sink.
    import { createSubject } from 'light-observable'
    const [stream, sink] = createSubject()
    
    stream.subscribe(console.log)
    sink.next(1) // > 1
    sink.next(2) // > 2
  • EMPTY: represents an empty Observable, which completes right after subscribing
  • Bunch of pipeable operators:
    • filter
    • map
    • forEach
    • merge
    • share

Install

npm install light-observable

Usage

import { Observable } from 'light-observable'

const o = new Observable(observer => {
  observer.next(1)
  observer.next(2)
  observer.complete()
})

o.subscribe(console.log)
// > 1
// > 2

Why

Because sometimes you just don't need all these tons of classes, dozens of schedulers and countless operators. Only some of them. Someday.

License

Copyright 2018 Tinkoff Bank

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.