Skip to content

erql/js-rx-exprs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

17 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Regular Expressions for RxJS

RxJS implementation of Regular Expressions for Reactive Streams

npm i exprs-rx

Intro

This library allows us to apply RegExp-like syntax to Observables, in order to select events from them.

Imagine that we have three streams:

A  ----o---------------
B  -o-o--o--o--o---o-o-
C  --------------o-----

And we want to select only those emissions that happen after A and before C emits

A  ----o---------------
B  -x-x--o--o--o---x-x-
C  --------------o-----

We can do that by applying the following expression:

AB*C

This expression means:

Take one emission from A
Then take all emissions from B
Until C emits. Take that one emission from C too
Then complete

Check out this intro article for more:
"RegExp syntax for Observables: Never Easier!"
https://dev.to/kosich/regexp-for-reactive-streams-143g
2 min read

Usage example

Query mousemove events after mousedown and before mouseup
(as in a drag-n-drop flow)

import { fromEvent } from 'rxjs'; 
import { repeat } from 'rxjs/operators';
import { exec } from 'exprs-rx';

// listen to events
const A = fromEvent(item, 'mousedown');
const B = fromEvent(document, 'mousemove');
const C = fromEvent(document, 'mouseup');

// apply a regular expression
exec('AB*C', { A, B, C })
    // it returns an Observable
    .pipe(
        repeat() // repeat the capturing
    )
    // use the selected events
    .subscribe(console.log);

Try this code in a sandbox:
https://stackblitz.com/edit/rxjs-regular-expressions

Notes

Currently, the library supports A โ€” capital letters that represent a single emission of a corresponding stream.

And a repeat A* notation that will consume multiple events from the corresponding stream, until completion or until next entry in the regex matches.

For regex specification and plans on vocabulary, please, see this repo https://github.com/expressions-for-reactive-streams/spec-regular-expressions

by Kostia Palchyk