bl 6.1.6 → 7.0.1

package/test/types.ts

@@ -0,0 +1,89 @@
+// Type-level test: verifies augmented types are correct.
+// Run with: tsc --noEmit test/types.ts
+// If this file fails to compile, the type augmentations are out of sync.
+
+import { BufferListStream, BufferList } from '../types/index.js'
+
+// -- Conformance with Buffer read methods --
+// Assert that BufferList's read methods are callable with the same
+// signatures as Buffer's. If @types/node changes a signature, this
+// section will fail to compile.
+type AssertConforms<_Bl extends _Buf, _Buf> = true
+
+type _FixedRead = AssertConforms<
+  { [K in
+    | 'readDoubleBE' | 'readDoubleLE'
+    | 'readFloatBE' | 'readFloatLE'
+    | 'readBigInt64BE' | 'readBigInt64LE'
+    | 'readBigUInt64BE' | 'readBigUInt64LE'
+    | 'readInt32BE' | 'readInt32LE'
+    | 'readUInt32BE' | 'readUInt32LE'
+    | 'readInt16BE' | 'readInt16LE'
+    | 'readUInt16BE' | 'readUInt16LE'
+    | 'readInt8' | 'readUInt8'
+  ]: BufferList[K] },
+  { [K in
+    | 'readDoubleBE' | 'readDoubleLE'
+    | 'readFloatBE' | 'readFloatLE'
+    | 'readBigInt64BE' | 'readBigInt64LE'
+    | 'readBigUInt64BE' | 'readBigUInt64LE'
+    | 'readInt32BE' | 'readInt32LE'
+    | 'readUInt32BE' | 'readUInt32LE'
+    | 'readInt16BE' | 'readInt16LE'
+    | 'readUInt16BE' | 'readUInt16LE'
+    | 'readInt8' | 'readUInt8'
+  ]: Buffer[K] }
+>
+
+type _VariableRead = AssertConforms<
+  { [K in 'readIntBE' | 'readIntLE' | 'readUIntBE' | 'readUIntLE']: BufferList[K] },
+  { [K in 'readIntBE' | 'readIntLE' | 'readUIntBE' | 'readUIntLE']: Buffer[K] }
+>
+
+// Verify return types match Buffer
+declare const buf: Buffer
+declare const bl: BufferList
+const _br: ReturnType<typeof buf.readUInt16BE> = bl.readUInt16BE(0)
+const _bbr: ReturnType<typeof buf.readBigInt64BE> = bl.readBigInt64BE(0)
+const _bfr: ReturnType<typeof buf.readDoubleBE> = bl.readDoubleBE(0)
+
+// -- BufferList basic API --
+const bl2 = new BufferList()
+const _a1: BufferList = bl2.append(Buffer.from('test'))
+const _a2: BufferList = bl2.prepend(Buffer.from('test'))
+const _g: number | undefined = bl2.get(0)
+const _s: Buffer = bl2.slice(0, 2)
+const _ss: BufferList = bl2.shallowSlice(0, 2)
+const _c: Buffer = bl2.copy(Buffer.alloc(4), 0, 0, 4)
+const _d: BufferList = bl2.duplicate()
+const _co: BufferList = bl2.consume(2)
+const _ts: string = bl2.toString('utf8', 0, 2)
+const _io: number = bl2.indexOf('test')
+const _io2: number = bl2.indexOf(Buffer.from('x'), 0, 'utf8')
+const _gb: Buffer[] = bl2.getBuffers()
+const _l: number = bl2.length
+const _ib: boolean = BufferList.isBufferList(bl2)
+
+// -- BufferListStream has both Duplex and BufferList APIs --
+const bls = new BufferListStream()
+const _sa: BufferListStream = bls.append(Buffer.from('test'))
+const _sp: BufferListStream = bls.prepend(Buffer.from('test'))
+const _sg: number | undefined = bls.get(0)
+const _sslice: Buffer = bls.slice(0, 2)
+const _sss: BufferListStream = bls.shallowSlice(0, 2)
+const _sco: BufferListStream = bls.consume(2)
+const _sd: BufferListStream = bls.duplicate()
+const _sts: string = bls.toString('utf8', 0, 2)
+const _sio: number = bls.indexOf('test')
+const _sgb: Buffer[] = bls.getBuffers()
+const _sru: number = bls.readUInt16BE(0)
+const _srb: bigint = bls.readBigInt64BE(0)
+const _srib: number = bls.readIntBE(0, 4)
+
+// Duplex stream methods
+bls.pipe(process.stdout)
+bls.write(Buffer.from('hello'))
+bls.end()
+
+// isBufferList
+const _sib: boolean = BufferListStream.isBufferList(bls)

package/test/verify-types.js

@@ -0,0 +1,51 @@
+import tape from 'tape'
+import { BufferList, BufferListStream } from '../BufferListStream.js'
+
+// Methods declared in types/augment.d.ts for BufferList (read methods)
+const readMethods = [
+  'readDoubleBE', 'readDoubleLE',
+  'readFloatBE', 'readFloatLE',
+  'readBigInt64BE', 'readBigInt64LE',
+  'readBigUInt64BE', 'readBigUInt64LE',
+  'readInt32BE', 'readInt32LE',
+  'readUInt32BE', 'readUInt32LE',
+  'readInt16BE', 'readInt16LE',
+  'readUInt16BE', 'readUInt16LE',
+  'readInt8', 'readUInt8',
+  'readIntBE', 'readIntLE',
+  'readUIntBE', 'readUIntLE'
+]
+
+// Methods declared in types/augment.d.ts for BufferListStream (BufferList methods)
+const bufferListMethods = [
+  'append', 'prepend',
+  'get', 'indexOf',
+  'slice', 'shallowSlice',
+  'copy', 'duplicate',
+  'consume', 'toString',
+  'getBuffers'
+]
+
+tape('BufferList has all augmented read methods', (t) => {
+  const bl = new BufferList()
+  for (const method of readMethods) {
+    t.equal(typeof bl[method], 'function', `BufferList.prototype.${method} exists`)
+  }
+  t.end()
+})
+
+tape('BufferListStream has all augmented read methods', (t) => {
+  const bls = new BufferListStream()
+  for (const method of readMethods) {
+    t.equal(typeof bls[method], 'function', `BufferListStream.prototype.${method} exists`)
+  }
+  t.end()
+})
+
+tape('BufferListStream has all augmented BufferList methods', (t) => {
+  const bls = new BufferListStream()
+  for (const method of bufferListMethods) {
+    t.equal(typeof bls[method], 'function', `BufferListStream.prototype.${method} exists`)
+  }
+  t.end()
+})

package/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "checkJs": true,
+    "strict": true,
+    "esModuleInterop": true,
+    "target": "ESNext",
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "skipLibCheck": true,
+    "types": ["node"],
+    "declaration": true,
+    "declarationMap": true,
+    "emitDeclarationOnly": true,
+    "outDir": "types"
+  },
+  "include": [
+    "BufferList.js",
+    "BufferListStream.js"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}

package/types/BufferList.d.ts

@@ -0,0 +1,109 @@
+export class BufferList {
+    /**
+     * @param {any} b
+     * @returns {boolean}
+     */
+    static isBufferList(b: any): boolean;
+    /** @param {BufferListAcceptedTypes} [buf] */
+    constructor(buf?: BufferListAcceptedTypes);
+    /** @type {Buffer[]} */
+    _bufs: Buffer[];
+    /** @type {number} */
+    length: number;
+    /** @param {BufferListAcceptedTypes} [buf] */
+    _new(buf?: BufferListAcceptedTypes): BufferList;
+    /**
+     * @param {number} offset
+     * @returns {[number, number]}
+     */
+    _offset(offset: number): [number, number];
+    /**
+     * @param {[number, number]} blOffset
+     * @returns {number}
+     */
+    _reverseOffset(blOffset: [number, number]): number;
+    /** @returns {Buffer[]} */
+    getBuffers(): Buffer[];
+    /**
+     * @param {number} index
+     * @returns {number | undefined}
+     */
+    get(index: number): number | undefined;
+    /**
+     * @param {number} [start]
+     * @param {number} [end]
+     * @returns {Buffer}
+     */
+    slice(start?: number, end?: number): Buffer;
+    /**
+     * @param {Buffer | null} dst
+     * @param {number} [dstStart]
+     * @param {number} [srcStart]
+     * @param {number} [srcEnd]
+     * @returns {Buffer}
+     */
+    copy(dst: Buffer | null, dstStart?: number, srcStart?: number, srcEnd?: number): Buffer;
+    /**
+     * @param {number} [start]
+     * @param {number} [end]
+     * @returns {BufferList}
+     */
+    shallowSlice(start?: number, end?: number): BufferList;
+    /**
+     * @param {BufferEncoding} [encoding]
+     * @param {number} [start]
+     * @param {number} [end]
+     * @returns {string}
+     */
+    toString(encoding?: BufferEncoding, start?: number, end?: number): string;
+    /**
+     * @param {number} bytes
+     * @returns {this}
+     */
+    consume(bytes: number): this;
+    /** @returns {BufferList} */
+    duplicate(): BufferList;
+    /**
+     * @param {BufferListAcceptedTypes} buf
+     * @returns {this}
+     */
+    append(buf: BufferListAcceptedTypes): this;
+    /**
+     * @param {BufferListAcceptedTypes} buf
+     * @returns {this}
+     */
+    prepend(buf: BufferListAcceptedTypes): this;
+    /**
+     * @param {BufferListAcceptedTypes} buf
+     * @param {(this: BufferList, buf: Buffer) => void} attacher
+     * @param {boolean} [prepend]
+     * @returns {this}
+     */
+    _attach(buf: BufferListAcceptedTypes, attacher: (this: BufferList, buf: Buffer) => void, prepend?: boolean): this;
+    /** @param {Buffer} buf */
+    _appendBuffer(buf: Buffer): void;
+    /** @param {Buffer} buf */
+    _prependBuffer(buf: Buffer): void;
+    /**
+     * @param {string | number | Buffer | BufferList | Uint8Array} search
+     * @param {number | string} [offset]
+     * @param {BufferEncoding} [encoding]
+     * @returns {number}
+     */
+    indexOf(search: string | number | Buffer | BufferList | Uint8Array, offset?: number | string, encoding?: BufferEncoding): number;
+    /**
+     * @param {number} offset
+     * @param {Buffer | Uint8Array} search
+     * @returns {boolean}
+     */
+    _match(offset: number, search: Buffer | Uint8Array): boolean;
+    /**
+     * @param {any} b
+     * @returns {b is BufferList}
+     */
+    _isBufferList(b: any): b is BufferList;
+}
+export default BufferList;
+export type BufferListAcceptedTypes = Buffer | BufferList | Uint8Array | Array<Buffer | BufferList | Uint8Array | string | number> | string | number;
+import { Buffer } from 'node:buffer';
+//# sourceMappingURL=BufferList.d.ts.map

package/types/BufferList.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BufferList.d.ts","sourceRoot":"","sources":["../BufferList.js"],"names":[],"mappings":"AAQA;IA6bE;;;OAGG;IACH,uBAHW,GAAG,GACD,OAAO,CAInB;IAlcD,6CAA6C;IAC7C,kBADY,uBAAuB,EAUlC;IARC,uBAAuB;IACvB,OADW,MAAM,EAAE,CACJ;IACf,qBAAqB;IACrB,QADW,MAAM,CACF;IAOjB,6CAA6C;IAC7C,WADY,uBAAuB,cAGlC;IAED;;;OAGG;IACH,gBAHW,MAAM,GACJ,CAAC,MAAM,EAAE,MAAM,CAAC,CAkB5B;IAED;;;OAGG;IACH,yBAHW,CAAC,MAAM,EAAE,MAAM,CAAC,GACd,MAAM,CAWlB;IAED,0BAA0B;IAC1B,cADc,MAAM,EAAE,CAGrB;IAED;;;OAGG;IACH,WAHW,MAAM,GACJ,MAAM,GAAG,SAAS,CAU9B;IAED;;;;OAIG;IACH,cAJW,MAAM,QACN,MAAM,GACJ,MAAM,CAYlB;IAED;;;;;;OAMG;IACH,UANW,MAAM,GAAG,IAAI,aACb,MAAM,aACN,MAAM,WACN,MAAM,GACJ,MAAM,CAoFlB;IAED;;;;OAIG;IACH,qBAJW,MAAM,QACN,MAAM,GACJ,UAAU,CAiCtB;IAED;;;;;OAKG;IACH,oBALW,cAAc,UACd,MAAM,QACN,MAAM,GACJ,MAAM,CAIlB;IAED;;;OAGG;IACH,eAHW,MAAM,GACJ,IAAI,CAqBhB;IAED,4BAA4B;IAC5B,aADc,UAAU,CASvB;IAED;;;OAGG;IACH,YAHW,uBAAuB,GACrB,IAAI,CAIhB;IAED;;;OAGG;IACH,aAHW,uBAAuB,GACrB,IAAI,CAIhB;IAED;;;;;OAKG;IACH,aALW,uBAAuB,YACvB,CAAC,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,KAAK,IAAI,YACvC,OAAO,GACL,IAAI,CAmChB;IAED,0BAA0B;IAC1B,mBADY,MAAM,QAIjB;IAED,0BAA0B;IAC1B,oBADY,MAAM,QAIjB;IAED;;;;;OAKG;IACH,gBALW,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,UAAU,WAClD,MAAM,GAAG,MAAM,aACf,cAAc,GACZ,MAAM,CA0ElB;IAED;;;;OAIG;IACH,eAJW,MAAM,UACN,MAAM,GAAG,UAAU,GACjB,OAAO,CAanB;IAMD;;;OAGG;IACH,iBAHW,GAAG,GACD,CAAC,IAAI,UAAU,CAI3B;CASF;;sCAzcY,MAAM,GAAG,UAAU,GAAG,UAAU,GAAG,KAAK,CAAC,MAAM,GAAG,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC,GAAG,MAAM,GAAG,MAAM;uBAHpG,aAAa"}

package/types/BufferListStream.d.ts

@@ -0,0 +1,54 @@
+/**
+ * @typedef {import('./BufferList.js').BufferListAcceptedTypes} BufferListAcceptedTypes
+ */
+export class BufferListStream extends Duplex {
+    /**
+     * @param {any} b
+     * @returns {boolean}
+     */
+    static isBufferList(b: any): boolean;
+    /**
+     * @param {((err: Error | null, buffer?: Buffer) => void) | BufferListAcceptedTypes} [callback]
+     */
+    constructor(callback?: ((err: Error | null, buffer?: Buffer) => void) | BufferListAcceptedTypes);
+    _callback: ((err: Error | null, buffer?: Buffer) => void) | undefined;
+    /** @type {Buffer[]} */
+    _bufs: Buffer[];
+    /** @type {number} */
+    length: number;
+    /**
+     * @param {any} buf
+     * @param {string} encoding
+     * @param {Function} callback
+     */
+    _write(buf: any, encoding: string, callback: Function): void;
+    /** @param {number} size */
+    _read(size: number): boolean | undefined;
+    /**
+     * @param {any} [chunk]
+     * @param {any} [encoding]
+     * @param {any} [cb]
+     * @returns {this}
+     */
+    end(chunk?: any, encoding?: any, cb?: any): this;
+    /**
+     * @param {Error | null} err
+     * @param {Function} cb
+     */
+    _destroy(err: Error | null, cb: Function): void;
+    /** @param {any} [callback] */
+    _new(callback?: any): BufferListStream;
+    /**
+     * @param {any} b
+     * @returns {b is BufferList}
+     */
+    _isBufferList(b: any): b is BufferList;
+}
+export default BufferListStream;
+export { BufferList };
+/** @type {(b: any) => boolean} */
+export const isBufferList: (b: any) => boolean;
+export type BufferListAcceptedTypes = import("./BufferList.js").BufferListAcceptedTypes;
+import { Duplex } from 'node:stream';
+import { BufferList } from './BufferList.js';
+//# sourceMappingURL=BufferListStream.d.ts.map

package/types/BufferListStream.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BufferListStream.d.ts","sourceRoot":"","sources":["../BufferListStream.js"],"names":[],"mappings":"AAKA;;GAEG;AAEH;IAuGE;;;OAGG;IACH,uBAHW,GAAG,GACD,OAAO,CAInB;IA5GD;;OAEG;IACH,uBAFW,CAAC,CAAC,GAAG,EAAE,KAAK,GAAG,IAAI,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC,GAAG,uBAAuB,EAmClF;IA7BG,kBANc,KAAK,GAAG,IAAI,WAAW,MAAM,KAAK,IAAI,cAM3B;IAqB3B,uBAAuB;IACvB,OADW,MAAM,EAAE,CACJ;IACf,qBAAqB;IACrB,QADW,MAAM,CACF;IAOjB;;;;OAIG;IACH,YAJW,GAAG,YACH,MAAM,4BAQhB;IAED,2BAA2B;IAC3B,YADY,MAAM,uBAUjB;IAED;;;;;OAKG;IACH,YALW,GAAG,aACH,GAAG,OACH,GAAG,GACD,IAAI,CAWhB;IAED;;;OAGG;IACH,cAHW,KAAK,GAAG,IAAI,sBAOtB;IAED,8BAA8B;IAC9B,gBADY,GAAG,oBAGd;IAED;;;OAGG;IACH,iBAHW,GAAG,GACD,CAAC,IAAI,UAAU,CAI3B;CASF;;;AAaD,kCAAkC;AAClC,2BADW,CAAC,CAAC,EAAE,GAAG,KAAK,OAAO,CACqB;sCA/HtC,OAAO,iBAAiB,EAAE,uBAAuB;uBANvC,aAAa;2BACT,iBAAiB"}

package/types/augment.d.ts

@@ -0,0 +1,50 @@
+import { BufferList, BufferListAcceptedTypes } from './BufferList.js'
+
+// Buffer read methods dynamically assigned to BufferList.prototype
+interface BufferListReadMethods {
+  readDoubleBE(offset?: number): number
+  readDoubleLE(offset?: number): number
+  readFloatBE(offset?: number): number
+  readFloatLE(offset?: number): number
+  readBigInt64BE(offset?: number): bigint
+  readBigInt64LE(offset?: number): bigint
+  readBigUInt64BE(offset?: number): bigint
+  readBigUInt64LE(offset?: number): bigint
+  readInt32BE(offset?: number): number
+  readInt32LE(offset?: number): number
+  readUInt32BE(offset?: number): number
+  readUInt32LE(offset?: number): number
+  readInt16BE(offset?: number): number
+  readInt16LE(offset?: number): number
+  readUInt16BE(offset?: number): number
+  readUInt16LE(offset?: number): number
+  readInt8(offset?: number): number
+  readUInt8(offset?: number): number
+  readIntBE(offset: number, byteLength: number): number
+  readIntLE(offset: number, byteLength: number): number
+  readUIntBE(offset: number, byteLength: number): number
+  readUIntLE(offset: number, byteLength: number): number
+}
+
+// BufferList methods copied to BufferListStream.prototype at runtime
+interface BufferListMethods {
+  append(buf: BufferListAcceptedTypes): this
+  prepend(buf: BufferListAcceptedTypes): this
+  get(index: number): number | undefined
+  indexOf(search: string | number | Buffer | BufferList | Uint8Array, offset?: number | string, encoding?: BufferEncoding): number
+  slice(start?: number, end?: number): Buffer
+  shallowSlice(start?: number, end?: number): this
+  copy(dst: Buffer | null, dstStart?: number, srcStart?: number, srcEnd?: number): Buffer
+  duplicate(): this
+  consume(bytes: number): this
+  toString(encoding?: BufferEncoding, start?: number, end?: number): string
+  getBuffers(): Buffer[]
+}
+
+declare module './BufferList.js' {
+  interface BufferList extends BufferListReadMethods {}
+}
+
+declare module './BufferListStream.js' {
+  interface BufferListStream extends BufferListMethods, BufferListReadMethods {}
+}

package/types/index.d.ts

@@ -0,0 +1,4 @@
+/// <reference path="./augment.d.ts" />
+export { BufferList, BufferListAcceptedTypes } from './BufferList.js'
+export { BufferListStream, isBufferList } from './BufferListStream.js'
+export { default } from './BufferListStream.js'