sandwich-stream

constructor

constructor({ head, tail, separator, ...remaining }: SandwichOptions);

• Initiates the SandwichStream, you can consider it also passing ReadableOptions to it

  Parameter head

  Pushes this content before all other content

  Parameter tail

  Pushes this content after all other data has been pushed

  Parameter separator

  Pushes this content between each stream

  Parameter remaining

  The other kind of options to be passed to Readable

  Example 1

  const ss = new SandwichStream({ head: 'This at the top\n', tail: '\nThis at the bottom', separator: '\n --- \n' });

method add

add: (newStream: Readable) => this;

• Add a new Readable stream in the queue

  Parameter newStream

  The Readable stream

  Returns

  This instance of Sandwich Stream

  Throws

  An Error in case that this request was not accepted

  Example 1

  sandwichStream.add(streamOne); sandwichStream.add(streamTwo); sandwichStream.add(streamThree);

property head

readonly head?: string | Buffer;

property separator

readonly separator?: string | Buffer;

property tail

readonly tail?: string | Buffer;