Notorious Preying Mantis

    @ovotech/re-pipeline
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.1 • Public • Published

    Re Pipeline

    A node streams pipeline implementation, that reconnects the pipes on error, once the error has been handled.

    Using

    yarn add @ovotech/re-pipeline

    Using stream-mock to mock out the readable and writable streams. Whenever an error is encountered by any of the streams, it would call the error handler and then reconnect the pipes again.

    import { rePipeline } from '@ovotech/re-pipeline';
    import { ReadableMock, WritableMock } from 'stream-mock';
    import { Transform } from 'stream';
    
    const start = new ReadableMock(['one', 'two'], { objectMode: true });
    const end = new WritableMock({ objectMode: true });
    const upperCase = new Transform({
      objectMode: true,
      transform: (item, encoding, callback) => callback(undefined, String(item).toUpperCase()),
    });
    
    const errorHandler = error => console.log(error);
    
    const pipeline = rePipeline(errorHandler, start, upperCase, end);
    
    pipeline.on('finish', () => console.log(end.data));

    You can use the promise version. When the stream has finished it would resolve the promise, and if any error is encountered, it would reject the promise. This would not reconnect the pipes.

    import { rePipelinePromise } from '@ovotech/re-pipeline';
    import { ReadableMock, WritableMock } from 'stream-mock';
    import { Transform } from 'stream';
    
    const start = new ReadableMock(['one', 'two'], { objectMode: true });
    const end = new WritableMock({ objectMode: true });
    const upperCase = new Transform({
      objectMode: true,
      transform: (item, encoding, callback) => callback(undefined, String(item).toUpperCase()),
    });
    
    const main = async () => {
      await pipelinePromise(start, upperCase, end);
      console.log(end.data);
    };

    Running the tests

    Then you can run the tests with:

    yarn test

    Coding style (linting, etc) tests

    Style is maintained with prettier and tslint

    yarn lint
    

    Deployment

    Deployment is preferment by lerna automatically on merge / push to master, but you'll need to bump the package version numbers yourself. Only updated packages with newer versions will be pushed to the npm registry.

    Contributing

    Have a bug? File an issue with a simple example that reproduces this so we can take a look & confirm.

    Want to make a change? Submit a PR, explain why it's useful, and make sure you've updated the docs (this file) and the tests (see test folder).

    License

    This project is licensed under Apache 2 - see the LICENSE file for details

    Keywords

    none

    Install

    npm i @ovotech/re-pipeline

    DownloadsWeekly Downloads

    21

    Version

    1.0.1

    License

    Apache-2.0

    Unpacked Size

    6.23 kB

    Total Files

    7

    Last publish

    Collaborators

    • rtsarykcorgi
    • ylukomskyi-corgi
    • david.regula.ovo
    • vitalii_khudenko
    • samuelnyamukapa
    • ishanfernando-ovo
    • radhika-bijibilla
    • mbartish-ovo
    • kaluzajianzu
    • a.skomarovskyi
    • grahamdawson-ovo
    • pkari
    • srinivasdudam2
    • shatchardovo
    • tigrago
    • ronald.nsabiyera
    • marcopie_at_kaluza
    • clueless_benefactee
    • michaelwheeler
    • prtn-ovo
    • rafolo78
    • tc-kaluza
    • lutza
    • dmytro.kubatko
    • bucabug
    • thomas.finch
    • v.kolesnyk
    • mykola.p
    • s.slotskyi-ovo
    • hantastico
    • joemaher
    • tanjil-hussain
    • adam.vile
    • raluza
    • ipa-bot
    • luigi94
    • anthony_tonev
    • simonarcher999
    • dominicboston-kaluza
    • iblamefish
    • robert-smith-01
    • katebee-kaluza
    • gideoncaspi
    • coderdanuk
    • kawbot
    • markberesford301
    • ovo-homeplan
    • rupson
    • oeptariffs
    • tony.ross
    • bvjones
    • data.discovery.ovo
    • ralitsa
    • fraserhamiltonovo
    • accrecovo
    • luigi.riefolo
    • andy-heywood-ovo
    • rmcnovo
    • ggerikp
    • xnejp03
    • emmapr123
    • andrew-brook-rad
    • a.calderwood
    • sulgee.kim
    • sseccombe
    • samcooper720x
    • lughino
    • amayuk
    • jagreenwood1
    • radek_tomasek
    • clarencedglee
    • ovocms
    • ovotech-sme-team
    • gjain-npm-ovo
    • kenneth-gray
    • nevenablagoeva
    • pete-woodland
    • orion-migration-team
    • ovotech-sg
    • chanex
    • ovotech-qs
    • ovotech-paym
    • ovotech-payments
    • ovotech-live
    • ovotech-payg
    • freddybushboy
    • sarahlikeshiny
    • ovotech-boost
    • agaovo
    • filose
    • props
    • yesdaveovo
    • rob-ovo
    • ellafutkowska
    • ikerin
    • mwidurek
    • andreaborsos
    • tomshawovo
    • ovotech-identity
    • iuna4e
    • lcatallo
    • orex-team
    • ahvargas
    • cwkaluza
    • smart-heat-uat
    • smart-heat-prod
    • potsec
    • rosario-ovo
    • tech.international
    • jvmovo
    • boost-smile
    • nicolasov
    • ovo.cms.devs
    • mkohlmyr
    • sketchingdev
    • mrkiplin
    • ovo-devices
    • sophiepoole
    • joepurnell-ovo
    • vkobyletskyi_ovo
    • richardday-ovo
    • rparkhomchuk
    • daumenta
    • benoitovo
    • v.vasylets
    • enza252
    • lewisunsworthkaluza
    • t.vytrykush
    • vslepkan
    • jubril
    • petro.shevchuk.corgi
    • melcbuckov
    • kir_exp
    • zyurii
    • vlavrynenko-nix
    • timmy.antonio
    • brettburman-code
    • vzahakailo
    • petro.pavlenko
    • goncalogarcia
    • chris.dickson.kaluza
    • muigui
    • k-fernandez
    • alonabarabash
    • manojkakarla
    • nelsma
    • jadamiec-ovo
    • georgi.krastev
    • marknreynolds
    • m_heald
    • gregshielkaluza
    • gordonmartin
    • ovo-data-science-engineering-bot
    • jonnyleakaluza
    • stephen.harris
    • alex-wilson-ovo
    • scdf
    • xenjke
    • rob.straughan
    • molbalazs
    • joewhittles
    • sampennington64
    • marcusgriff
    • amelia.ovo
    • juliabutterly
    • chris.smith
    • sophiesillmanovo
    • marcesquerra
    • pedoublety
    • ovo-engagement
    • marcuskielly
    • david.chellapah.ovo
    • kupxc
    • harrisonbaxter
    • apjm
    • shnist
    • mikemchugh
    • sarahbeharry
    • ursularodgers
    • inlustra
    • andrewjtn
    • tarlingovo
    • troyb95
    • david.ovo
    • ovoenergyapps
    • marina-ovo
    • tom-g-dane
    • homemoves
    • samwest
    • sophiefield
    • simonmclean-ovo
    • jamesbaum
    • robert-g-j
    • paceteamkaluza
    • ovo-oot-bot
    • stuharv-ovo
    • eddiec86
    • csherwin
    • g-tibbs
    • puzzledbytheweb
    • lewright
    • pedro.caldeira
    • aidenscott2016
    • keirlawson
    • dwfullerton
    • gordok
    • darrenthomas-sse
    • seagullmouse
    • markwood23
    • timsteeleovo
    • jacktreble
    • gordon-rennie-ovo
    • adam-mcdevitt
    • jkiely
    • ovo-dc
    • orion-digital-support-experience
    • ovotech-smart-thermostat
    • yahmad
    • kelemensanyi
    • wtaylor-ovo
    • jrdavenport
    • dleyland-ovo
    • rob.desbois
    • sicrossley
    • lewisdick-ovo
    • sjmann
    • stevemossovo
    • eduardolaranjo
    • unibozu
    • cp-ui-tooling
    • lenardprattovo
    • dieman89
    • jensraaby-ovo
    • anthonysmithovo
    • tom.sherman
    • tomlloyd
    • matyas-ovo
    • jamesnoble1
    • phil-pinkowski
    • ovo-aarongibbison
    • nebuladesignsystem
    • ovo-matt-hodges
    • luke-adams-ovo
    • j_kapella
    • mike.walters
    • bgzstephen
    • matthewbursteinovo
    • kslat3r
    • mtardugno-ovo
    • zoelanham
    • jchoskins
    • tom.mottram.kaluza
    • ewan-m
    • mishabruml
    • maciek-kaluza
    • vmary
    • mugishau
    • peterh-ovo
    • dvidg
    • nickfitton-ovo
    • dave.allison
    • oep-accounts-bot
    • cbousie
    • j.okeefe
    • ursula_rodgers
    • jgarciapaj
    • petegrace
    • retrojetpacks
    • benaston13
    • ovo-bit-tech
    • fulvio.ovo
    • blair.calderwood.radically
    • pedromss
    • simonlewissse
    • joolskaluza
    • jifarra-kaluza
    • jameswelshkaluza
    • kimnil
    • carolinelywood
    • mike-gregory-kaluza
    • vasil.dininski
    • sir_hiss
    • csillabarna
    • luca.sale
    • friendigo
    • oroberts221
    • pedro.costa.kaluza
    • annebeth-ovo
    • quartin
    • georgexcollins
    • kapikaluza
    • iovana.pavlovici
    • filosganga
    • chris.brindley
    • engagement-insights
    • hentielouw
    • jaws-bot
    • leaski
    • elliekempster91
    • zoejm
    • rekaelek-ovo
    • nathanmarshovo
    • robturnerovo
    • dsingh07
    • ovo-james
    • jthomasovo