🤖 Merge PR DefinitelyTyped#70447 feat: add types for buffercursor by @gierschv

Author: gierschv

types/buffercursor/.npmignore

@@ -0,0 +1,5 @@
+*
+!**/*.d.ts
+!**/*.d.cts
+!**/*.d.mts
+!**/*.d.*.ts

types/buffercursor/buffercursor-tests.ts

@@ -0,0 +1,47 @@
+import BufferCursor from 'buffercursor';
+import { Buffer } from 'node:buffer';
+
+const buffer = Buffer.from([0x00, 0x01, 0x02, 0x03]);
+const cursor = new BufferCursor(buffer);
+
+const firstByte = cursor.readUInt8();
+console.log(firstByte);
+
+const secondByte = cursor.readUInt8();
+console.log(secondByte);
+
+cursor.seek(2);
+const thirdByte = cursor.readUInt8();
+console.log(thirdByte);
+
+cursor.seek(0);
+cursor.writeUInt8(0xFF);
+cursor.seek(0);
+const overwrittenByte = cursor.readUInt8();
+console.log(overwrittenByte);
+
+try {
+    cursor.seek(100);
+} catch (error) {
+    if (error instanceof BufferCursor.BufferCursorOverflow) {
+        console.log('Caught overflow error as expected');
+    }
+}
+
+cursor.seek(0);
+cursor.writeInt16BE(0x1234);
+cursor.seek(0);
+const readInt16 = cursor.readInt16BE();
+console.log(readInt16);
+
+cursor.fill(0xAB, 4);
+cursor.seek(0);
+const filledValue = cursor.readUInt32BE();
+console.log(filledValue.toString(16));
+
+cursor.seek(buffer.length - 1);
+try {
+    cursor.readUInt16BE();
+} catch (error) {
+    console.log('Caught boundary overflow error as expected');
+}

types/buffercursor/index.d.ts

@@ -0,0 +1,69 @@
+/// <reference types="node" />
+
+import VError = require('verror');
+
+/**
+ * A cursor for reading from and writing to a buffer.
+ */
+declare class BufferCursor {
+    constructor(buff: Buffer, noAssert?: boolean);
+
+    buffer: Buffer;
+    length: number;
+
+    seek(pos: number): BufferCursor;
+    eof(): boolean;
+    tell(): number;
+    slice(length?: number): BufferCursor;
+    toString(encoding?: BufferEncoding, length?: number): string;
+
+    readUInt8(): number;
+    readInt8(): number;
+    readInt16BE(): number;
+    readInt16LE(): number;
+    readUInt16BE(): number;
+    readUInt16LE(): number;
+    readUInt32LE(): number;
+    readUInt32BE(): number;
+    readInt32LE(): number;
+    readInt32BE(): number;
+    readFloatBE(): number;
+    readFloatLE(): number;
+    readDoubleBE(): number;
+    readDoubleLE(): number;
+
+    write(value: string, length?: number, encoding?: BufferEncoding): BufferCursor;
+    fill(value: any, length?: number): BufferCursor;
+    copy(source: Buffer | BufferCursor, sourceStart?: number, sourceEnd?: number): BufferCursor;
+
+    writeUInt8(value: number): BufferCursor;
+    writeInt8(value: number): BufferCursor;
+    writeUInt16BE(value: number): BufferCursor;
+    writeUInt16LE(value: number): BufferCursor;
+    writeInt16BE(value: number): BufferCursor;
+    writeInt16LE(value: number): BufferCursor;
+    writeUInt32BE(value: number): BufferCursor;
+    writeUInt32LE(value: number): BufferCursor;
+    writeInt32BE(value: number): BufferCursor;
+    writeInt32LE(value: number): BufferCursor;
+    writeFloatBE(value: number): BufferCursor;
+    writeFloatLE(value: number): BufferCursor;
+    writeDoubleBE(value: number): BufferCursor;
+    writeDoubleLE(value: number): BufferCursor;
+
+    static BufferCursorOverflow: typeof BufferCursorOverflow;
+}
+
+/**
+ * Custom error type for buffer cursor overflows.
+ */
+declare class BufferCursorOverflow extends VError {
+    kind: string;
+    length: number;
+    position: number;
+    size: number;
+
+    constructor(length: number, position: number, size: number);
+}
+
+export = BufferCursor;

types/buffercursor/package.json

@@ -0,0 +1,21 @@
+{
+    "private": true,
+    "name": "@types/buffercursor",
+    "version": "0.0.9999",
+    "projects": [
+        "http://github.com/tjfontaine/node-buffercursor"
+    ],
+    "dependencies": {
+        "@types/node": "*",
+        "@types/verror": "^1.10.10"
+    },
+    "devDependencies": {
+        "@types/buffercursor": "workspace:."
+    },
+    "owners": [
+        {
+            "name": "Vincent Giersch",
+            "githubUsername": "gierschv"
+        }
+    ]
+}

types/buffercursor/tsconfig.json

@@ -0,0 +1,20 @@
+{
+    "compilerOptions": {
+        "module": "node16",
+        "lib": [
+            "es6",
+            "dom"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "buffercursor-tests.ts"
+    ]
+}