Skip to content

Commit bd80e9f

Browse files
authored
🤖 Merge PR DefinitelyTyped#72217 node/fs: Add type definition for fs.read with buffer and options parameter by @y-hsgw
1 parent 75947d9 commit bd80e9f

File tree

4 files changed

+35
-0
lines changed

4 files changed

+35
-0
lines changed

‎types/node/fs.d.ts‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2544,6 +2544,17 @@ declare module "fs" {
25442544
options: ReadAsyncOptions<TBuffer>,
25452545
callback: (err: NodeJS.ErrnoException | null, bytesRead: number, buffer: TBuffer) => void,
25462546
): void;
2547+
export function read<TBuffer extends NodeJS.ArrayBufferView>(
2548+
fd: number,
2549+
buffer: TBuffer,
2550+
options: ReadSyncOptions,
2551+
callback: (err: NodeJS.ErrnoException | null, bytesRead: number, buffer: TBuffer) => void,
2552+
): void;
2553+
export function read<TBuffer extends NodeJS.ArrayBufferView>(
2554+
fd: number,
2555+
buffer: TBuffer,
2556+
callback: (err: NodeJS.ErrnoException | null, bytesRead: number, buffer: TBuffer) => void,
2557+
): void;
25472558
export function read(
25482559
fd: number,
25492560
callback: (err: NodeJS.ErrnoException | null, bytesRead: number, buffer: NodeJS.ArrayBufferView) => void,

‎types/node/test/fs.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,8 @@ import { CopyOptions, CopySyncOptions, cp, cpSync, glob, globSync } from "fs";
122122
(err: NodeJS.ErrnoException | null, bytesRead: number, buffer: NodeJS.ArrayBufferView) => {},
123123
);
124124
fs.read(1, { buffer: Buffer.from("test"), position: 123n }, () => {});
125+
fs.read(1, Buffer.from("test"), { position: 123n }, () => {});
126+
fs.read(1, Buffer.from("test"), () => {});
125127
// 2-param version using all-default options:
126128
fs.read(1, (err: NodeJS.ErrnoException | null, bytesRead: number, buffer: NodeJS.ArrayBufferView) => {});
127129
fs.read(1, () => {});

‎types/node/v18/fs.d.ts‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2556,6 +2556,17 @@ declare module "fs" {
25562556
options: ReadAsyncOptions<TBuffer>,
25572557
callback: (err: NodeJS.ErrnoException | null, bytesRead: number, buffer: TBuffer) => void,
25582558
): void;
2559+
export function read<TBuffer extends NodeJS.ArrayBufferView>(
2560+
fd: number,
2561+
buffer: TBuffer,
2562+
options: ReadSyncOptions,
2563+
callback: (err: NodeJS.ErrnoException | null, bytesRead: number, buffer: TBuffer) => void,
2564+
): void;
2565+
export function read<TBuffer extends NodeJS.ArrayBufferView>(
2566+
fd: number,
2567+
buffer: TBuffer,
2568+
callback: (err: NodeJS.ErrnoException | null, bytesRead: number, buffer: TBuffer) => void,
2569+
): void;
25592570
export function read(
25602571
fd: number,
25612572
callback: (err: NodeJS.ErrnoException | null, bytesRead: number, buffer: NodeJS.ArrayBufferView) => void,

‎types/node/v20/fs.d.ts‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2542,6 +2542,17 @@ declare module "fs" {
25422542
options: ReadAsyncOptions<TBuffer>,
25432543
callback: (err: NodeJS.ErrnoException | null, bytesRead: number, buffer: TBuffer) => void,
25442544
): void;
2545+
export function read<TBuffer extends NodeJS.ArrayBufferView>(
2546+
fd: number,
2547+
buffer: TBuffer,
2548+
options: ReadSyncOptions,
2549+
callback: (err: NodeJS.ErrnoException | null, bytesRead: number, buffer: TBuffer) => void,
2550+
): void;
2551+
export function read<TBuffer extends NodeJS.ArrayBufferView>(
2552+
fd: number,
2553+
buffer: TBuffer,
2554+
callback: (err: NodeJS.ErrnoException | null, bytesRead: number, buffer: TBuffer) => void,
2555+
): void;
25452556
export function read(
25462557
fd: number,
25472558
callback: (err: NodeJS.ErrnoException | null, bytesRead: number, buffer: NodeJS.ArrayBufferView) => void,

0 commit comments

Comments
 (0)