striimi v2.1.0

Striimi

Striimi is a simple value streaming library.

Basics

Stream methods

subscribe | Function | Used to subscribe a function to the stream. Takes a function as a parameter. This function is called when stream values change. Subscribe -method instantly calls the function parameter with current stream values. Returns a function, which clears the subscription when invoked.

Examples

One value

Basic usage example.

import striimi from 'striimi';

const stream = striimi({
    valueOne: 'ExampleValue',
    valueTwo: 1234
});

const subOne = stream.subscribe((val) => { console.log(val.valueOne) });

// Console.log: ExampleValue    --subOne

const subTwo = stream.subscribe(({valTwo}) => { console.log(valTwo) });

stream.emit({valueOne: 'ChangedValue', valueTwo: 4321});

// Console.log: ChangedValue    --subOne
// Console.log: 4321            --subTwo

subOne();

stream.reset();

// Console.log: 1234            --subTwo

Multiple values

Can also be used for multiple values.

import striimi from 'striimi';

export default striimi('ExampleValue', 1234);