bl 5.0.0 → 5.1.0

package/.github/dependabot.yml

@@ -0,0 +1,16 @@
+version: 2
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'daily'
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'
+  - package-ecosystem: 'npm'
+    directory: '/'
+    schedule:
+      interval: 'daily'
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'

package/.github/workflows/test-and-release.yml

@@ -0,0 +1,61 @@
+name: Test & Maybe Release
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        node: [14.x, 16.x, 18.x, lts/*, current]
+        os: [macos-latest, ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node }}
+        uses: actions/setup-node@v3.5.1
+        with:
+          node-version: ${{ matrix.node }}
+      - name: Install Dependencies
+        run: |
+          npm install --no-progress
+      - name: Run tests
+        run: |
+          npm config set script-shell bash
+          npm run test:ci
+  release:
+    name: Release
+    needs: test
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v3.5.1
+        with:
+          node-version: 14
+      - name: Install dependencies
+        run: |
+          npm install --no-progress --no-package-lock --no-save
+      - name: Build
+        run: |
+          npm run build
+      - name: Install plugins
+        run: |
+          npm install \
+            @semantic-release/commit-analyzer \
+            conventional-changelog-conventionalcommits \
+            @semantic-release/release-notes-generator \
+            @semantic-release/npm \
+            @semantic-release/github \
+            @semantic-release/git \
+            @semantic-release/changelog \
+            --no-progress --no-package-lock --no-save
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release
+

package/BufferList.d.ts

@@ -0,0 +1,382 @@
+export type BufferListAcceptedTypes =
+  | Buffer
+  | BufferList
+  | Uint8Array
+  | BufferListAcceptedTypes[]
+  | string
+  | number;
+
+export interface BufferListConstructor {
+  new (initData?: BufferListAcceptedTypes): BufferList;
+  (initData?: BufferListAcceptedTypes): BufferList;
+
+  /**
+   * Determines if the passed object is a BufferList. It will return true
+   * if the passed object is an instance of BufferList or BufferListStream
+   * and false otherwise.
+   *
+   * N.B. this won't return true for BufferList or BufferListStream instances
+   * created by versions of this library before this static method was added.
+   *
+   * @param other
+   */
+
+  isBufferList(other: unknown): boolean;
+}
+
+interface BufferList {
+  prototype: Object
+
+  /**
+   * Get the length of the list in bytes. This is the sum of the lengths
+   * of all of the buffers contained in the list, minus any initial offset
+   * for a semi-consumed buffer at the beginning. Should accurately
+   * represent the total number of bytes that can be read from the list.
+   */
+
+  length: number;
+
+  /**
+   * Adds an additional buffer or BufferList to the internal list.
+   * this is returned so it can be chained.
+   *
+   * @param buffer
+   */
+
+  append(buffer: BufferListAcceptedTypes): this;
+
+  /**
+   * Will return the byte at the specified index.
+   * @param index
+   */
+
+  get(index: number): number;
+
+  /**
+   * Returns a new Buffer object containing the bytes within the
+   * range specified. Both start and end are optional and will
+   * default to the beginning and end of the list respectively.
+   *
+   * If the requested range spans a single internal buffer then a
+   * slice of that buffer will be returned which shares the original
+   * memory range of that Buffer. If the range spans multiple buffers
+   * then copy operations will likely occur to give you a uniform Buffer.
+   *
+   * @param start
+   * @param end
+   */
+
+  slice(start?: number, end?: number): Buffer;
+
+  /**
+   * Returns a new BufferList object containing the bytes within the
+   * range specified. Both start and end are optional and will default
+   * to the beginning and end of the list respectively.
+   *
+   * No copies will be performed. All buffers in the result share
+   * memory with the original list.
+   *
+   * @param start
+   * @param end
+   */
+
+  shallowSlice(start?: number, end?: number): this;
+
+  /**
+   * Copies the content of the list in the `dest` buffer, starting from
+   * `destStart` and containing the bytes within the range specified
+   * with `srcStart` to `srcEnd`.
+   *
+   * `destStart`, `start` and `end` are optional and will default to the
+   * beginning of the dest buffer, and the beginning and end of the
+   * list respectively.
+   *
+   * @param dest
+   * @param destStart
+   * @param srcStart
+   * @param srcEnd
+   */
+
+  copy(
+    dest: Buffer,
+    destStart?: number,
+    srcStart?: number,
+    srcEnd?: number
+  ): Buffer;
+
+  /**
+   * Performs a shallow-copy of the list. The internal Buffers remains the
+   * same, so if you change the underlying Buffers, the change will be
+   * reflected in both the original and the duplicate.
+   *
+   * This method is needed if you want to call consume() or pipe() and
+   * still keep the original list.
+   *
+   * @example
+   *
+   * ```js
+   * var bl = new BufferListStream();
+   * bl.append('hello');
+   * bl.append(' world');
+   * bl.append('\n');
+   * bl.duplicate().pipe(process.stdout, { end: false });
+   *
+   * console.log(bl.toString())
+   * ```
+   */
+
+  duplicate(): this;
+
+  /**
+   * Will shift bytes off the start of the list. The number of bytes
+   * consumed don't need to line up with the sizes of the internal
+   * Buffers—initial offsets will be calculated accordingly in order
+   * to give you a consistent view of the data.
+   *
+   * @param bytes
+   */
+
+  consume(bytes?: number): void;
+
+  /**
+   * Will return a string representation of the buffer. The optional
+   * `start` and `end` arguments are passed on to `slice()`, while
+   * the encoding is passed on to `toString()` of the resulting Buffer.
+   *
+   * See the [`Buffer#toString()`](http://nodejs.org/docs/latest/api/buffer.html#buffer_buf_tostring_encoding_start_end)
+   * documentation for more information.
+   *
+   * @param encoding
+   * @param start
+   * @param end
+   */
+
+  toString(encoding?: string, start?: number, end?: number): string;
+
+  /**
+   * Will return the byte at the specified index. indexOf() method
+   * returns the first index at which a given element can be found
+   * in the BufferList, or -1 if it is not present.
+   *
+   * @param value
+   * @param byteOffset
+   * @param encoding
+   */
+
+  indexOf(
+    value: string | number | Uint8Array | BufferList | Buffer,
+    byteOffset?: number,
+    encoding?: string
+  ): number;
+
+  /**
+   * All of the standard byte-reading methods of the Buffer interface are implemented and will operate across internal Buffer boundaries transparently.
+   * See the [Buffer](http://nodejs.org/docs/latest/api/buffer.html) documentation for how these work.
+   *
+   * @param offset
+   */
+
+  readDoubleBE: Buffer['readDoubleBE'];
+
+  /**
+   * All of the standard byte-reading methods of the Buffer interface are implemented and will operate across internal Buffer boundaries transparently.
+   * See the [Buffer](http://nodejs.org/docs/latest/api/buffer.html) documentation for how these work.
+   *
+   * @param offset
+   */
+
+  readDoubleLE: Buffer['readDoubleLE'];
+
+  /**
+   * All of the standard byte-reading methods of the Buffer interface are implemented and will operate across internal Buffer boundaries transparently.
+   * See the [Buffer](http://nodejs.org/docs/latest/api/buffer.html) documentation for how these work.
+   *
+   * @param offset
+   */
+
+  readFloatBE: Buffer['readFloatBE'];
+
+  /**
+   * All of the standard byte-reading methods of the Buffer interface are implemented and will operate across internal Buffer boundaries transparently.
+   * See the [Buffer](http://nodejs.org/docs/latest/api/buffer.html) documentation for how these work.
+   *
+   * @param offset
+   */
+
+  readFloatLE: Buffer['readFloatLE'];
+
+  /**
+   * All of the standard byte-reading methods of the Buffer interface are implemented and will operate across internal Buffer boundaries transparently.
+   * See the [Buffer](http://nodejs.org/docs/latest/api/buffer.html) documentation for how these work.
+   *
+   * @param offset
+   */
+
+  readInt32BE: Buffer['readInt32BE'];
+
+  /**
+   * All of the standard byte-reading methods of the Buffer interface are implemented and will operate across internal Buffer boundaries transparently.
+   * See the [Buffer](http://nodejs.org/docs/latest/api/buffer.html) documentation for how these work.
+   *
+   * @param offset
+   */
+
+  readInt32LE: Buffer['readInt32LE'];
+
+  /**
+   * All of the standard byte-reading methods of the Buffer interface are implemented and will operate across internal Buffer boundaries transparently.
+   * See the [Buffer](http://nodejs.org/docs/latest/api/buffer.html) documentation for how these work.
+   *
+   * @param offset
+   */
+
+  readUInt32BE: Buffer['readUInt32BE'];
+
+  /**
+   * All of the standard byte-reading methods of the Buffer interface are implemented and will operate across internal Buffer boundaries transparently.
+   * See the [Buffer](http://nodejs.org/docs/latest/api/buffer.html) documentation for how these work.
+   *
+   * @param offset
+   */
+
+  readUInt32LE: Buffer['readUInt32LE'];
+
+  /**
+   * All of the standard byte-reading methods of the Buffer interface are implemented and will operate across internal Buffer boundaries transparently.
+   * See the [Buffer](http://nodejs.org/docs/latest/api/buffer.html) documentation for how these work.
+   *
+   * @param offset
+   */
+
+  readInt16BE: Buffer['readInt16BE'];
+
+  /**
+   * All of the standard byte-reading methods of the Buffer interface are
+   * implemented and will operate across internal Buffer boundaries transparently.
+   *
+   * See the [Buffer](http://nodejs.org/docs/latest/api/buffer.html)
+   * documentation for how these work.
+   *
+   * @param offset
+   */
+
+  readInt16LE: Buffer['readInt16LE'];
+
+  /**
+   * All of the standard byte-reading methods of the Buffer interface are
+   * implemented and will operate across internal Buffer boundaries transparently.
+   *
+   * See the [Buffer](http://nodejs.org/docs/latest/api/buffer.html)
+   * documentation for how these work.
+   *
+   * @param offset
+   */
+
+  readUInt16BE: Buffer['readUInt16BE'];
+
+  /**
+   * All of the standard byte-reading methods of the Buffer interface are
+   * implemented and will operate across internal Buffer boundaries transparently.
+   *
+   * See the [Buffer](http://nodejs.org/docs/latest/api/buffer.html)
+   * documentation for how these work.
+   *
+   * @param offset
+   */
+
+  readUInt16LE: Buffer['readUInt16LE'];
+
+  /**
+   * All of the standard byte-reading methods of the Buffer interface are
+   * implemented and will operate across internal Buffer boundaries transparently.
+   *
+   * See the [Buffer](http://nodejs.org/docs/latest/api/buffer.html)
+   * documentation for how these work.
+   *
+   * @param offset
+   */
+
+  readInt8: Buffer['readInt8'];
+
+  /**
+   * All of the standard byte-reading methods of the Buffer interface are
+   * implemented and will operate across internal Buffer boundaries transparently.
+   *
+   * See the [Buffer](http://nodejs.org/docs/latest/api/buffer.html)
+   * documentation for how these work.
+   *
+   * @param offset
+   */
+
+  readUInt8: Buffer['readUInt8'];
+
+  /**
+   * All of the standard byte-reading methods of the Buffer interface are
+   * implemented and will operate across internal Buffer boundaries transparently.
+   *
+   * See the [Buffer](http://nodejs.org/docs/latest/api/buffer.html)
+   * documentation for how these work.
+   *
+   * @param offset
+   */
+
+  readIntBE: Buffer['readIntBE'];
+
+  /**
+   * All of the standard byte-reading methods of the Buffer interface are
+   * implemented and will operate across internal Buffer boundaries transparently.
+   *
+   * See the [Buffer](http://nodejs.org/docs/latest/api/buffer.html)
+   * documentation for how these work.
+   *
+   * @param offset
+   */
+
+  readIntLE: Buffer['readIntLE'];
+
+  /**
+   * All of the standard byte-reading methods of the Buffer interface are
+   * implemented and will operate across internal Buffer boundaries transparently.
+   *
+   * See the [Buffer](http://nodejs.org/docs/latest/api/buffer.html)
+   * documentation for how these work.
+   *
+   * @param offset
+   */
+
+  readUIntBE: Buffer['readUIntBE'];
+
+  /**
+   * All of the standard byte-reading methods of the Buffer interface are
+   * implemented and will operate across internal Buffer boundaries transparently.
+   *
+   * See the [Buffer](http://nodejs.org/docs/latest/api/buffer.html)
+   * documentation for how these work.
+   *
+   * @param offset
+   */
+
+  readUIntLE: Buffer['readUIntLE'];
+}
+
+/**
+ * No arguments are required for the constructor, but you can initialise
+ * the list by passing in a single Buffer object or an array of Buffer
+ * objects.
+ *
+ * `new` is not strictly required, if you don't instantiate a new object,
+ * it will be done automatically for you so you can create a new instance
+ * simply with:
+ *
+ * ```js
+ * const { BufferList } = require('bl')
+ * const bl = BufferList()
+ *
+ * // equivalent to:
+ *
+ * const { BufferList } = require('bl')
+ * const bl = new BufferList()
+ * ```
+ */
+
+declare const BufferList: BufferListConstructor;

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+## [5.1.0](https://github.com/rvagg/bl/compare/v5.0.0...v5.1.0) (2022-10-18)
+
+
+### Features
+
+* added integrated TypeScript typings ([#108](https://github.com/rvagg/bl/issues/108)) ([433ff89](https://github.com/rvagg/bl/commit/433ff8942f47fab8a5c9d13b2c00989ccf8d0710))
+
+
+### Bug Fixes
+
+* windows support in tests ([387dfaf](https://github.com/rvagg/bl/commit/387dfaf9b2bca7849f12785436ceb01e42adac2c))
+
+
+### Trivial Changes
+
+* GH Actions, Dependabot, auto-release, remove Travis ([997f058](https://github.com/rvagg/bl/commit/997f058357de8f2a7f66998e80a72b491835573f))
+* **no-release:** bump standard from 16.0.4 to 17.0.0 ([#112](https://github.com/rvagg/bl/issues/112)) ([078bfe3](https://github.com/rvagg/bl/commit/078bfe33390d125297b1c946e5989c4aa9228961))

package/index.d.ts

@@ -0,0 +1,88 @@
+import { Duplex } from "readable-stream";
+import {
+  BufferList as BL,
+  BufferListConstructor,
+  BufferListAcceptedTypes,
+} from "./BufferList";
+
+type BufferListStreamInit =
+  | ((err: Error, buffer: Buffer) => void)
+  | BufferListAcceptedTypes;
+
+interface BufferListStreamConstructor {
+  new (initData?: BufferListStreamInit): BufferListStream;
+  (callback?: BufferListStreamInit): BufferListStream;
+
+  /**
+   * Determines if the passed object is a BufferList. It will return true
+   * if the passed object is an instance of BufferList or BufferListStream
+   * and false otherwise.
+   *
+   * N.B. this won't return true for BufferList or BufferListStream instances
+   * created by versions of this library before this static method was added.
+   *
+   * @param other
+   */
+
+  isBufferList(other: unknown): boolean;
+
+  /**
+   * Rexporting BufferList and BufferListStream to fix
+   * issue with require/commonjs import and "export = " below.
+   */
+
+  BufferList: BufferListConstructor;
+  BufferListStream: BufferListStreamConstructor;
+}
+
+interface BufferListStream extends Duplex, BL {
+  prototype: BufferListStream & BL;
+}
+
+/**
+ * BufferListStream is a Node Duplex Stream, so it can be read from
+ * and written to like a standard Node stream. You can also pipe()
+ * to and from a BufferListStream instance.
+ *
+ * The constructor takes an optional callback, if supplied, the
+ * callback will be called with an error argument followed by a
+ * reference to the bl instance, when bl.end() is called
+ * (i.e. from a piped stream).
+ *
+ * This is a convenient method of collecting the entire contents of
+ * a stream, particularly when the stream is chunky, such as a network
+ * stream.
+ *
+ * Normally, no arguments are required for the constructor, but you can
+ * initialise the list by passing in a single Buffer object or an array
+ * of Buffer object.
+ *
+ * `new` is not strictly required, if you don't instantiate a new object,
+ * it will be done automatically for you so you can create a new instance
+ * simply with:
+ *
+ * ```js
+ * const { BufferListStream } = require('bl');
+ * const bl = BufferListStream();
+ *
+ * // equivalent to:
+ *
+ * const { BufferListStream } = require('bl');
+ * const bl = new BufferListStream();
+ * ```
+ *
+ * N.B. For backwards compatibility reasons, BufferListStream is the default
+ * export when you `require('bl')`:
+ *
+ * ```js
+ * const { BufferListStream } = require('bl')
+ *
+ * // equivalent to:
+ *
+ * const BufferListStream = require('bl')
+ * ```
+ */
+
+declare const BufferListStream: BufferListStreamConstructor;
+
+export = BufferListStream;

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "bl",
-  "version": "5.0.0",
+  "version": "5.1.0",
   "description": "Buffer List: collect buffers and access with a standard readable Buffer interface, streamable too!",
   "license": "MIT",
   "main": "bl.js",
   "scripts": {
     "lint": "standard *.js test/*.js",
-    "test": "npm run lint && node test/test.js | faucet"
+    "test": "npm run lint && npm run test:types && node test/test.js | faucet",
+    "test:ci": "npm run lint && node test/test.js && npm run test:types",
+    "test:types": "tsc --allowJs --noEmit test/test.js",
+    "build": "true"
   },
   "repository": {
     "type": "git",
@@ -30,8 +33,91 @@
     "readable-stream": "^3.4.0"
   },
   "devDependencies": {
+    "@types/readable-stream": "^2.3.13",
     "faucet": "~0.0.1",
-    "standard": "^16.0.3",
-    "tape": "^5.2.2"
+    "standard": "^17.0.0",
+    "tape": "^5.2.2",
+    "typescript": "~4.7.3"
+  },
+  "release": {
+    "branches": [
+      "master"
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "conventionalcommits",
+          "releaseRules": [
+            {
+              "breaking": true,
+              "release": "major"
+            },
+            {
+              "revert": true,
+              "release": "patch"
+            },
+            {
+              "type": "feat",
+              "release": "minor"
+            },
+            {
+              "type": "fix",
+              "release": "patch"
+            },
+            {
+              "type": "chore",
+              "release": "patch"
+            },
+            {
+              "type": "docs",
+              "release": "patch"
+            },
+            {
+              "type": "test",
+              "release": "patch"
+            },
+            {
+              "scope": "no-release",
+              "release": false
+            }
+          ]
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "conventionalcommits",
+          "presetConfig": {
+            "types": [
+              {
+                "type": "feat",
+                "section": "Features"
+              },
+              {
+                "type": "fix",
+                "section": "Bug Fixes"
+              },
+              {
+                "type": "chore",
+                "section": "Trivial Changes"
+              },
+              {
+                "type": "docs",
+                "section": "Trivial Changes"
+              },
+              {
+                "type": "test",
+                "section": "Tests"
+              }
+            ]
+          }
+        }
+      ],
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      "@semantic-release/git"
+    ]
   }
 }

package/test/test.js

@@ -1,22 +1,49 @@
+// @ts-check
 'use strict'
 
 const tape = require('tape')
 const crypto = require('crypto')
 const fs = require('fs')
 const path = require('path')
-const BufferList = require('../')
+const os = require('os')
+const BufferListStream = require('../')
 const { Buffer } = require('buffer')
 
-const encodings =
-      ('hex utf8 utf-8 ascii binary base64' +
-          (process.browser ? '' : ' ucs2 ucs-2 utf16le utf-16le')).split(' ')
+/**
+ * This typedef allows us to add _bufs to the API without declaring it publicly on types.
+ * @typedef { BufferListStream & { _bufs?: Buffer[] }} BufferListStreamWithPrivate
+ */
+
+/**
+ * Just for typechecking in js
+ * @type { NodeJS.Process & { browser?: boolean }}
+ */
+
+const process = globalThis.process
+
+/** @type {BufferEncoding[]} */
+const encodings = ['ascii', 'utf8', 'utf-8', 'hex', 'binary', 'base64']
+
+if (process.browser) {
+  encodings.push(
+    'ucs2',
+    'ucs-2',
+    'utf16le',
+    /**
+     * This alias is not in typescript typings for BufferEncoding. Still have to fix
+     * @see https://nodejs.org/api/buffer.html#buffers-and-character-encodings
+     */
+    // @ts-ignore
+    'utf-16le'
+  )
+}
 
 require('./indexOf')
 require('./isBufferList')
 require('./convert')
 
 tape('single bytes from single buffer', function (t) {
-  const bl = new BufferList()
+  const bl = new BufferListStream()
 
   bl.append(Buffer.from('abcd'))
 
@@ -32,7 +59,7 @@ tape('single bytes from single buffer', function (t) {
 })
 
 tape('single bytes from multiple buffers', function (t) {
-  const bl = new BufferList()
+  const bl = new BufferListStream()
 
   bl.append(Buffer.from('abcd'))
   bl.append(Buffer.from('efg'))
@@ -56,7 +83,7 @@ tape('single bytes from multiple buffers', function (t) {
 })
 
 tape('multi bytes from single buffer', function (t) {
-  const bl = new BufferList()
+  const bl = new BufferListStream()
 
   bl.append(Buffer.from('abcd'))
 
@@ -71,7 +98,7 @@ tape('multi bytes from single buffer', function (t) {
 })
 
 tape('multi bytes from single buffer (negative indexes)', function (t) {
-  const bl = new BufferList()
+  const bl = new BufferListStream()
 
   bl.append(Buffer.from('buffer'))
 
@@ -85,7 +112,7 @@ tape('multi bytes from single buffer (negative indexes)', function (t) {
 })
 
 tape('multiple bytes from multiple buffers', function (t) {
-  const bl = new BufferList()
+  const bl = new BufferListStream()
 
   bl.append(Buffer.from('abcd'))
   bl.append(Buffer.from('efg'))
@@ -105,10 +132,10 @@ tape('multiple bytes from multiple buffers', function (t) {
 })
 
 tape('multiple bytes from multiple buffer lists', function (t) {
-  const bl = new BufferList()
+  const bl = new BufferListStream()
 
-  bl.append(new BufferList([Buffer.from('abcd'), Buffer.from('efg')]))
-  bl.append(new BufferList([Buffer.from('hi'), Buffer.from('j')]))
+  bl.append(new BufferListStream([Buffer.from('abcd'), Buffer.from('efg')]))
+  bl.append(new BufferListStream([Buffer.from('hi'), Buffer.from('j')]))
 
   t.equal(bl.length, 10)
 
@@ -124,17 +151,19 @@ tape('multiple bytes from multiple buffer lists', function (t) {
 
 // same data as previous test, just using nested constructors
 tape('multiple bytes from crazy nested buffer lists', function (t) {
-  const bl = new BufferList()
-
-  bl.append(new BufferList([
-    new BufferList([
-      new BufferList(Buffer.from('abc')),
-      Buffer.from('d'),
-      new BufferList(Buffer.from('efg'))
-    ]),
-    new BufferList([Buffer.from('hi')]),
-    new BufferList(Buffer.from('j'))
-  ]))
+  const bl = new BufferListStream()
+
+  bl.append(
+    new BufferListStream([
+      new BufferListStream([
+        new BufferListStream(Buffer.from('abc')),
+        Buffer.from('d'),
+        new BufferListStream(Buffer.from('efg'))
+      ]),
+      new BufferListStream([Buffer.from('hi')]),
+      new BufferListStream(Buffer.from('j'))
+    ])
+  )
 
   t.equal(bl.length, 10)
 
@@ -149,7 +178,7 @@ tape('multiple bytes from crazy nested buffer lists', function (t) {
 })
 
 tape('append accepts arrays of Buffers', function (t) {
-  const bl = new BufferList()
+  const bl = new BufferListStream()
 
   bl.append(Buffer.from('abc'))
   bl.append([Buffer.from('def')])
@@ -162,7 +191,7 @@ tape('append accepts arrays of Buffers', function (t) {
 })
 
 tape('append accepts arrays of Uint8Arrays', function (t) {
-  const bl = new BufferList()
+  const bl = new BufferListStream()
 
   bl.append(new Uint8Array([97, 98, 99]))
   bl.append([Uint8Array.from([100, 101, 102])])
@@ -175,12 +204,17 @@ tape('append accepts arrays of Uint8Arrays', function (t) {
 })
 
 tape('append accepts arrays of BufferLists', function (t) {
-  const bl = new BufferList()
+  const bl = new BufferListStream()
 
   bl.append(Buffer.from('abc'))
-  bl.append([new BufferList('def')])
-  bl.append(new BufferList([Buffer.from('ghi'), new BufferList('jkl')]))
-  bl.append([Buffer.from('mnop'), new BufferList([Buffer.from('qrstu'), Buffer.from('vwxyz')])])
+  bl.append([new BufferListStream('def')])
+  bl.append(
+    new BufferListStream([Buffer.from('ghi'), new BufferListStream('jkl')])
+  )
+  bl.append([
+    Buffer.from('mnop'),
+    new BufferListStream([Buffer.from('qrstu'), Buffer.from('vwxyz')])
+  ])
   t.equal(bl.length, 26)
   t.equal(bl.slice().toString('ascii'), 'abcdefghijklmnopqrstuvwxyz')
 
@@ -188,21 +222,26 @@ tape('append accepts arrays of BufferLists', function (t) {
 })
 
 tape('append chainable', function (t) {
-  const bl = new BufferList()
+  const bl = new BufferListStream()
 
   t.ok(bl.append(Buffer.from('abcd')) === bl)
   t.ok(bl.append([Buffer.from('abcd')]) === bl)
-  t.ok(bl.append(new BufferList(Buffer.from('abcd'))) === bl)
-  t.ok(bl.append([new BufferList(Buffer.from('abcd'))]) === bl)
+  t.ok(bl.append(new BufferListStream(Buffer.from('abcd'))) === bl)
+  t.ok(bl.append([new BufferListStream(Buffer.from('abcd'))]) === bl)
 
   t.end()
 })
 
 tape('append chainable (test results)', function (t) {
-  const bl = new BufferList('abc')
-    .append([new BufferList('def')])
-    .append(new BufferList([Buffer.from('ghi'), new BufferList('jkl')]))
-    .append([Buffer.from('mnop'), new BufferList([Buffer.from('qrstu'), Buffer.from('vwxyz')])])
+  const bl = new BufferListStream('abc')
+    .append([new BufferListStream('def')])
+    .append(
+      new BufferListStream([Buffer.from('ghi'), new BufferListStream('jkl')])
+    )
+    .append([
+      Buffer.from('mnop'),
+      new BufferListStream([Buffer.from('qrstu'), Buffer.from('vwxyz')])
+    ])
 
   t.equal(bl.length, 26)
   t.equal(bl.slice().toString('ascii'), 'abcdefghijklmnopqrstuvwxyz')
@@ -211,7 +250,7 @@ tape('append chainable (test results)', function (t) {
 })
 
 tape('consuming from multiple buffers', function (t) {
-  const bl = new BufferList()
+  const bl = new BufferListStream()
 
   bl.append(Buffer.from('abcd'))
   bl.append(Buffer.from('efg'))
@@ -246,7 +285,8 @@ tape('consuming from multiple buffers', function (t) {
 })
 
 tape('complete consumption', function (t) {
-  const bl = new BufferList()
+  /** @type {BufferListStreamWithPrivate} */
+  const bl = new BufferListStream()
 
   bl.append(Buffer.from('a'))
   bl.append(Buffer.from('b'))
@@ -263,7 +303,7 @@ tape('test readUInt8 / readInt8', function (t) {
   const buf1 = Buffer.alloc(1)
   const buf2 = Buffer.alloc(3)
   const buf3 = Buffer.alloc(3)
-  const bl = new BufferList()
+  const bl = new BufferListStream()
 
   buf1[0] = 0x1
   buf2[1] = 0x3
@@ -292,7 +332,7 @@ tape('test readUInt16LE / readUInt16BE / readInt16LE / readInt16BE', function (t
   const buf1 = Buffer.alloc(1)
   const buf2 = Buffer.alloc(3)
   const buf3 = Buffer.alloc(3)
-  const bl = new BufferList()
+  const bl = new BufferListStream()
 
   buf1[0] = 0x1
   buf2[1] = 0x3
@@ -326,7 +366,7 @@ tape('test readUInt32LE / readUInt32BE / readInt32LE / readInt32BE', function (t
   const buf1 = Buffer.alloc(1)
   const buf2 = Buffer.alloc(3)
   const buf3 = Buffer.alloc(3)
-  const bl = new BufferList()
+  const bl = new BufferListStream()
 
   buf1[0] = 0x1
   buf2[1] = 0x3
@@ -352,7 +392,7 @@ tape('test readUIntLE / readUIntBE / readIntLE / readIntBE', function (t) {
   const buf1 = Buffer.alloc(1)
   const buf2 = Buffer.alloc(3)
   const buf3 = Buffer.alloc(3)
-  const bl = new BufferList()
+  const bl = new BufferListStream()
 
   buf2[0] = 0x2
   buf2[1] = 0x3
@@ -397,7 +437,7 @@ tape('test readFloatLE / readFloatBE', function (t) {
   const buf1 = Buffer.alloc(1)
   const buf2 = Buffer.alloc(3)
   const buf3 = Buffer.alloc(3)
-  const bl = new BufferList()
+  const bl = new BufferListStream()
 
   buf1[0] = 0x01
   buf2[1] = 0x00
@@ -422,7 +462,7 @@ tape('test readDoubleLE / readDoubleBE', function (t) {
   const buf1 = Buffer.alloc(1)
   const buf2 = Buffer.alloc(3)
   const buf3 = Buffer.alloc(10)
-  const bl = new BufferList()
+  const bl = new BufferListStream()
 
   buf1[0] = 0x01
   buf2[1] = 0x55
@@ -448,7 +488,7 @@ tape('test readDoubleLE / readDoubleBE', function (t) {
 })
 
 tape('test toString', function (t) {
-  const bl = new BufferList()
+  const bl = new BufferListStream()
 
   bl.append(Buffer.from('abcd'))
   bl.append(Buffer.from('efg'))
@@ -465,7 +505,7 @@ tape('test toString', function (t) {
 })
 
 tape('test toString encoding', function (t) {
-  const bl = new BufferList()
+  const bl = new BufferListStream()
   const b = Buffer.from('abcdefghij\xff\x00')
 
   bl.append(Buffer.from('abcd'))
@@ -485,7 +525,7 @@ tape('uninitialized memory', function (t) {
   const secret = crypto.randomBytes(256)
   for (let i = 0; i < 1e6; i++) {
     const clone = Buffer.from(secret)
-    const bl = new BufferList()
+    const bl = new BufferListStream()
     bl.append(Buffer.from('a'))
     bl.consume(-1024)
     const buf = bl.slice(1)
@@ -500,17 +540,17 @@ tape('uninitialized memory', function (t) {
 !process.browser && tape('test stream', function (t) {
   const random = crypto.randomBytes(65534)
 
-  const bl = new BufferList((err, buf) => {
+  const bl = new BufferListStream((err, buf) => {
     t.ok(Buffer.isBuffer(buf))
     t.ok(err === null)
     t.ok(random.equals(bl.slice()))
     t.ok(random.equals(buf.slice()))
 
-    bl.pipe(fs.createWriteStream('/tmp/bl_test_rnd_out.dat'))
+    bl.pipe(fs.createWriteStream(path.join(os.tmpdir(), 'bl_test_rnd_out.dat')))
       .on('close', function () {
         const rndhash = crypto.createHash('md5').update(random).digest('hex')
         const md5sum = crypto.createHash('md5')
-        const s = fs.createReadStream('/tmp/bl_test_rnd_out.dat')
+        const s = fs.createReadStream(path.join(os.tmpdir(), 'bl_test_rnd_out.dat'))
 
         s.on('data', md5sum.update.bind(md5sum))
         s.on('end', function () {
@@ -520,24 +560,24 @@ tape('uninitialized memory', function (t) {
       })
   })
 
-  fs.writeFileSync('/tmp/bl_test_rnd.dat', random)
-  fs.createReadStream('/tmp/bl_test_rnd.dat').pipe(bl)
+  fs.writeFileSync(path.join(os.tmpdir(), 'bl_test_rnd.dat'), random)
+  fs.createReadStream(path.join(os.tmpdir(), 'bl_test_rnd.dat')).pipe(bl)
 })
 
 tape('instantiation with Buffer', function (t) {
   const buf = crypto.randomBytes(1024)
   const buf2 = crypto.randomBytes(1024)
-  let b = BufferList(buf)
+  let b = BufferListStream(buf)
 
   t.equal(buf.toString('hex'), b.slice().toString('hex'), 'same buffer')
-  b = BufferList([buf, buf2])
+  b = BufferListStream([buf, buf2])
   t.equal(b.slice().toString('hex'), Buffer.concat([buf, buf2]).toString('hex'), 'same buffer')
 
   t.end()
 })
 
 tape('test String appendage', function (t) {
-  const bl = new BufferList()
+  const bl = new BufferListStream()
   const b = Buffer.from('abcdefghij\xff\x00')
 
   bl.append('abcd')
@@ -554,7 +594,7 @@ tape('test String appendage', function (t) {
 })
 
 tape('test Number appendage', function (t) {
-  const bl = new BufferList()
+  const bl = new BufferListStream()
   const b = Buffer.from('1234567890')
 
   bl.append(1234)
@@ -571,7 +611,7 @@ tape('test Number appendage', function (t) {
 
 tape('write nothing, should get empty buffer', function (t) {
   t.plan(3)
-  BufferList(function (err, data) {
+  BufferListStream(function (err, data) {
     t.notOk(err, 'no error')
     t.ok(Buffer.isBuffer(data), 'got a buffer')
     t.equal(0, data.length, 'got a zero-length buffer')
@@ -585,7 +625,7 @@ tape('unicode string', function (t) {
   const inp1 = '\u2600'
   const inp2 = '\u2603'
   const exp = inp1 + ' and ' + inp2
-  const bl = BufferList()
+  const bl = BufferListStream()
 
   bl.write(inp1)
   bl.write(' and ')
@@ -595,8 +635,8 @@ tape('unicode string', function (t) {
 })
 
 tape('should emit finish', function (t) {
-  const source = BufferList()
-  const dest = BufferList()
+  const source = BufferListStream()
+  const dest = BufferListStream()
 
   source.write('hello')
   source.pipe(dest)
@@ -610,7 +650,7 @@ tape('should emit finish', function (t) {
 tape('basic copy', function (t) {
   const buf = crypto.randomBytes(1024)
   const buf2 = Buffer.alloc(1024)
-  const b = BufferList(buf)
+  const b = BufferListStream(buf)
 
   b.copy(buf2)
   t.equal(b.slice().toString('hex'), buf2.toString('hex'), 'same buffer')
@@ -621,7 +661,7 @@ tape('basic copy', function (t) {
 tape('copy after many appends', function (t) {
   const buf = crypto.randomBytes(512)
   const buf2 = Buffer.alloc(1024)
-  const b = BufferList(buf)
+  const b = BufferListStream(buf)
 
   b.append(buf)
   b.copy(buf2)
@@ -633,7 +673,7 @@ tape('copy after many appends', function (t) {
 tape('copy at a precise position', function (t) {
   const buf = crypto.randomBytes(1004)
   const buf2 = Buffer.alloc(1024)
-  const b = BufferList(buf)
+  const b = BufferListStream(buf)
 
   b.copy(buf2, 20)
   t.equal(b.slice().toString('hex'), buf2.slice(20).toString('hex'), 'same buffer')
@@ -644,7 +684,7 @@ tape('copy at a precise position', function (t) {
 tape('copy starting from a precise location', function (t) {
   const buf = crypto.randomBytes(10)
   const buf2 = Buffer.alloc(5)
-  const b = BufferList(buf)
+  const b = BufferListStream(buf)
 
   b.copy(buf2, 0, 5)
   t.equal(b.slice(5).toString('hex'), buf2.toString('hex'), 'same buffer')
@@ -654,7 +694,7 @@ tape('copy starting from a precise location', function (t) {
 
 tape('copy in an interval', function (t) {
   const rnd = crypto.randomBytes(10)
-  const b = BufferList(rnd) // put the random bytes there
+  const b = BufferListStream(rnd) // put the random bytes there
   const actual = Buffer.alloc(3)
   const expected = Buffer.alloc(3)
 
@@ -669,7 +709,7 @@ tape('copy in an interval', function (t) {
 tape('copy an interval between two buffers', function (t) {
   const buf = crypto.randomBytes(10)
   const buf2 = Buffer.alloc(10)
-  const b = BufferList(buf)
+  const b = BufferListStream(buf)
 
   b.append(buf)
   b.copy(buf2, 0, 5, 15)
@@ -680,7 +720,7 @@ tape('copy an interval between two buffers', function (t) {
 })
 
 tape('shallow slice across buffer boundaries', function (t) {
-  const bl = new BufferList(['First', 'Second', 'Third'])
+  const bl = new BufferListStream(['First', 'Second', 'Third'])
 
   t.equal(bl.shallowSlice(3, 13).toString(), 'stSecondTh')
 
@@ -690,7 +730,7 @@ tape('shallow slice across buffer boundaries', function (t) {
 tape('shallow slice within single buffer', function (t) {
   t.plan(2)
 
-  const bl = new BufferList(['First', 'Second', 'Third'])
+  const bl = new BufferListStream(['First', 'Second', 'Third'])
 
   t.equal(bl.shallowSlice(5, 10).toString(), 'Secon')
   t.equal(bl.shallowSlice(7, 10).toString(), 'con')
@@ -701,7 +741,7 @@ tape('shallow slice within single buffer', function (t) {
 tape('shallow slice single buffer', function (t) {
   t.plan(3)
 
-  const bl = new BufferList(['First', 'Second', 'Third'])
+  const bl = new BufferListStream(['First', 'Second', 'Third'])
 
   t.equal(bl.shallowSlice(0, 5).toString(), 'First')
   t.equal(bl.shallowSlice(5, 11).toString(), 'Second')
@@ -711,7 +751,7 @@ tape('shallow slice single buffer', function (t) {
 tape('shallow slice with negative or omitted indices', function (t) {
   t.plan(4)
 
-  const bl = new BufferList(['First', 'Second', 'Third'])
+  const bl = new BufferListStream(['First', 'Second', 'Third'])
 
   t.equal(bl.shallowSlice().toString(), 'FirstSecondThird')
   t.equal(bl.shallowSlice(5).toString(), 'SecondThird')
@@ -723,7 +763,7 @@ tape('shallow slice does not make a copy', function (t) {
   t.plan(1)
 
   const buffers = [Buffer.from('First'), Buffer.from('Second'), Buffer.from('Third')]
-  const bl = (new BufferList(buffers)).shallowSlice(5, -3)
+  const bl = new BufferListStream(buffers).shallowSlice(5, -3)
 
   buffers[1].fill('h')
   buffers[2].fill('h')
@@ -735,7 +775,7 @@ tape('shallow slice with 0 length', function (t) {
   t.plan(1)
 
   const buffers = [Buffer.from('First'), Buffer.from('Second'), Buffer.from('Third')]
-  const bl = (new BufferList(buffers)).shallowSlice(0, 0)
+  const bl = (new BufferListStream(buffers)).shallowSlice(0, 0)
 
   t.equal(bl.length, 0)
 })
@@ -744,7 +784,7 @@ tape('shallow slice with 0 length from middle', function (t) {
   t.plan(1)
 
   const buffers = [Buffer.from('First'), Buffer.from('Second'), Buffer.from('Third')]
-  const bl = (new BufferList(buffers)).shallowSlice(10, 10)
+  const bl = (new BufferListStream(buffers)).shallowSlice(10, 10)
 
   t.equal(bl.length, 0)
 })
@@ -752,7 +792,7 @@ tape('shallow slice with 0 length from middle', function (t) {
 tape('duplicate', function (t) {
   t.plan(2)
 
-  const bl = new BufferList('abcdefghij\xff\x00')
+  const bl = new BufferListStream('abcdefghij\xff\x00')
   const dup = bl.duplicate()
 
   t.equal(bl.prototype, dup.prototype)
@@ -762,7 +802,8 @@ tape('duplicate', function (t) {
 tape('destroy no pipe', function (t) {
   t.plan(2)
 
-  const bl = new BufferList('alsdkfja;lsdkfja;lsdk')
+  /** @type {BufferListStreamWithPrivate} */
+  const bl = new BufferListStream('alsdkfja;lsdkfja;lsdk')
 
   bl.destroy()
 
@@ -773,7 +814,8 @@ tape('destroy no pipe', function (t) {
 tape('destroy with error', function (t) {
   t.plan(3)
 
-  const bl = new BufferList('alsdkfja;lsdkfja;lsdk')
+  /** @type {BufferListStreamWithPrivate} */
+  const bl = new BufferListStream('alsdkfja;lsdkfja;lsdk')
   const err = new Error('kaboom')
 
   bl.destroy(err)
@@ -788,7 +830,8 @@ tape('destroy with error', function (t) {
 !process.browser && tape('destroy with pipe before read end', function (t) {
   t.plan(2)
 
-  const bl = new BufferList()
+  /** @type {BufferListStreamWithPrivate} */
+  const bl = new BufferListStream()
   fs.createReadStream(path.join(__dirname, '/test.js'))
     .pipe(bl)
 
@@ -801,7 +844,8 @@ tape('destroy with error', function (t) {
 !process.browser && tape('destroy with pipe before read end with race', function (t) {
   t.plan(2)
 
-  const bl = new BufferList()
+  /** @type {BufferListStreamWithPrivate} */
+  const bl = new BufferListStream()
 
   fs.createReadStream(path.join(__dirname, '/test.js'))
     .pipe(bl)
@@ -818,8 +862,8 @@ tape('destroy with error', function (t) {
 !process.browser && tape('destroy with pipe after read end', function (t) {
   t.plan(2)
 
-  const bl = new BufferList()
-
+  /** @type {BufferListStreamWithPrivate} */
+  const bl = new BufferListStream()
   fs.createReadStream(path.join(__dirname, '/test.js'))
     .on('end', onEnd)
     .pipe(bl)
@@ -835,8 +879,9 @@ tape('destroy with error', function (t) {
 !process.browser && tape('destroy with pipe while writing to a destination', function (t) {
   t.plan(4)
 
-  const bl = new BufferList()
-  const ds = new BufferList()
+  /** @type {BufferListStreamWithPrivate} */
+  const bl = new BufferListStream()
+  const ds = new BufferListStream()
 
   fs.createReadStream(path.join(__dirname, '/test.js'))
     .on('end', onEnd)
@@ -862,7 +907,7 @@ tape('destroy with error', function (t) {
 !process.browser && tape('handle error', function (t) {
   t.plan(2)
 
-  fs.createReadStream('/does/not/exist').pipe(BufferList(function (err, data) {
+  fs.createReadStream('/does/not/exist').pipe(BufferListStream(function (err, data) {
     t.ok(err instanceof Error, 'has error')
     t.notOk(data, 'no data')
   }))

package/.travis.yml

@@ -1,17 +0,0 @@
-sudo: false
-arch:
- - amd64
- - ppc64le
-language: node_js
-node_js:
-  - '6'
-  - '8'
-  - '10'
-  - '12'
-  - '14'
-  - '15'
-  - lts/*
-notifications:
-  email:
-    - rod@vagg.org
-    - matteo.collina@gmail.com