Icard/angular-clarity-master(work.../node_modules/@ljharb/through
realSnehal 400e0876de frontend 2024-07-16 20:25:36 +05:30
..
.github frontend 2024-07-16 20:25:36 +05:30
test frontend 2024-07-16 20:25:36 +05:30
.eslintrc frontend 2024-07-16 20:25:36 +05:30
.nycrc frontend 2024-07-16 20:25:36 +05:30
CHANGELOG.md frontend 2024-07-16 20:25:36 +05:30
LICENSE frontend 2024-07-16 20:25:36 +05:30
README.md frontend 2024-07-16 20:25:36 +05:30
index.js frontend 2024-07-16 20:25:36 +05:30
package.json frontend 2024-07-16 20:25:36 +05:30
through.d.ts frontend 2024-07-16 20:25:36 +05:30
tsconfig.json frontend 2024-07-16 20:25:36 +05:30

README.md

@ljharb/through Version Badge

Note: This package is a fork of https://npmjs.com/through, and builds off of it.

github actions coverage License Downloads

npm badge

Easy way to create a Stream that is both readable and writable.

  • Pass in optional write and end methods.
  • through takes care of pause/resume logic if you use this.queue(data) instead of this.emit('data', data).
  • Use this.pause() and this.resume() to manage flow.
  • Check this.paused to see current flow state. (write always returns !this.paused).

This function is the basis for most of the synchronous streams in event-stream.

var through = require('@ljharb/through')

through(function write(data) {
    this.queue(data) //data *must* not be null
  },
  function end () { //optional
    this.queue(null)
  })

Or, can also be used without buffering on pause, use this.emit('data', data), and this.emit('end')

var through = require('@ljharb/through')

through(function write(data) {
    this.emit('data', data)
    //this.pause()
  },
  function end () { //optional
    this.emit('end')
  })

Extended Options

You will probably not need these 99% of the time.

autoDestroy=false

By default, through emits close when the writable and readable side of the stream has ended. If that is not desired, set autoDestroy=false.

var through = require('@ljharb/through')

//like this
var ts = through(write, end, {autoDestroy: false})
//or like this
var ts = through(write, end)
ts.autoDestroy = false