Skip to content

Commit

Permalink
fs: fix typings
Browse files Browse the repository at this point in the history
PR-URL: #53626
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
anonrig authored and targos committed Sep 21, 2024
1 parent 87167fa commit 2fb7cc9
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 18 deletions.
27 changes: 12 additions & 15 deletions lib/fs.js
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ function exists(path, callback) {
validateFunction(callback, 'cb');

function suppressedCallback(err) {
callback(err ? false : true);
callback(!err);
}

try {
Expand Down Expand Up @@ -759,8 +759,8 @@ function readSync(fd, buffer, offsetOrOptions, length, position) {
* @param {(
* err?: Error,
* bytesRead?: number,
* buffers?: ArrayBufferView[];
* ) => any} callback
* buffers?: ArrayBufferView[]
* ) => any} callback
* @returns {void}
*/
function readv(fd, buffers, position, callback) {
Expand Down Expand Up @@ -813,9 +813,9 @@ function readvSync(fd, buffers, position) {
* @param {number | null} [position]
* @param {(
* err?: Error,
* bytesWritten?: number;
* bytesWritten?: number,
* buffer?: Buffer | TypedArray | DataView
* ) => any} callback
* ) => any} callback
* @returns {void}
*/
function write(fd, buffer, offsetOrOptions, length, position, callback) {
Expand Down Expand Up @@ -891,6 +891,8 @@ ObjectDefineProperty(write, kCustomPromisifyArgsSymbol,
* length?: number;
* position?: number | null;
* }} [offsetOrOptions]
* @param {number} [length]
* @param {number} [position]
* @returns {number}
*/
function writeSync(fd, buffer, offsetOrOptions, length, position) {
Expand Down Expand Up @@ -1084,14 +1086,11 @@ function truncateSync(path, len) {
}
// Allow error to be thrown, but still close fd.
const fd = fs.openSync(path, 'r+');
let ret;

try {
ret = fs.ftruncateSync(fd, len);
fs.ftruncateSync(fd, len);
} finally {
fs.closeSync(fd);
}
return ret;
}

/**
Expand Down Expand Up @@ -1450,8 +1449,8 @@ function readdirSyncRecursive(basePath, options) {
* }} [options]
* @param {(
* err?: Error,
* files?: string[] | Buffer[] | Dirent[];
* ) => any} callback
* files?: string[] | Buffer[] | Dirent[]
* ) => any} callback
* @returns {void}
*/
function readdir(path, options, callback) {
Expand Down Expand Up @@ -1957,13 +1956,11 @@ function lchmodSync(path, mode) {

// Prefer to return the chmod error, if one occurs,
// but still try to close, and report closing errors if they occur.
let ret;
try {
ret = fs.fchmodSync(fd, mode);
fs.fchmodSync(fd, mode);
} finally {
fs.closeSync(fd);
}
return ret;
}

/**
Expand Down Expand Up @@ -2838,7 +2835,7 @@ function realpath(p, options, callback) {

// On windows, check that the root exists. On unix there is no need.
if (isWindows && !knownHard.has(base)) {
fs.lstat(base, (err, stats) => {
fs.lstat(base, (err) => {
if (err) return callback(err);
knownHard.add(base);
LOOP();
Expand Down
9 changes: 6 additions & 3 deletions typings/internalBinding/fs.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ declare namespace InternalFSBinding {
}

function access(path: StringOrBuffer, mode: number, req: FSReqCallback): void;
function access(path: StringOrBuffer, mode: number, req: undefined, ctx: FSSyncContext): void;
function access(path: StringOrBuffer, mode: number): void;
function access(path: StringOrBuffer, mode: number, usePromises: typeof kUsePromises): Promise<void>;

function chmod(path: string, mode: number, req: FSReqCallback): void;
Expand All @@ -70,7 +70,7 @@ declare namespace InternalFSBinding {
function chown(path: string, uid: number, gid: number): void;

function close(fd: number, req: FSReqCallback): void;
function close(fd: number, req: undefined, ctx: FSSyncContext): void;
function close(fd: number): void;

function copyFile(src: StringOrBuffer, dest: StringOrBuffer, mode: number, req: FSReqCallback): void;
function copyFile(src: StringOrBuffer, dest: StringOrBuffer, mode: number, req: undefined, ctx: FSSyncContext): void;
Expand Down Expand Up @@ -154,7 +154,7 @@ declare namespace InternalFSBinding {
function mkdir(path: string, mode: number, recursive: false, usePromises: typeof kUsePromises): Promise<void>;

function open(path: StringOrBuffer, flags: number, mode: number, req: FSReqCallback<number>): void;
function open(path: StringOrBuffer, flags: number, mode: number, req: undefined, ctx: FSSyncContext): number;
function open(path: StringOrBuffer, flags: number, mode: number): number;

function openFileHandle(path: StringOrBuffer, flags: number, mode: number, usePromises: typeof kUsePromises): Promise<FileHandle>;

Expand All @@ -176,6 +176,8 @@ declare namespace InternalFSBinding {
function readdir(path: StringOrBuffer, encoding: unknown, withFileTypes: true, usePromises: typeof kUsePromises): Promise<[string[], number[]]>;
function readdir(path: StringOrBuffer, encoding: unknown, withFileTypes: false, usePromises: typeof kUsePromises): Promise<string[]>;

function readFileUtf8(path: StringOrBuffer, flags: number): string;

function readlink(path: StringOrBuffer, encoding: unknown, req: FSReqCallback<string | Buffer>): void;
function readlink(path: StringOrBuffer, encoding: unknown, req: undefined, ctx: FSSyncContext): string | Buffer;
function readlink(path: StringOrBuffer, encoding: unknown, usePromises: typeof kUsePromises): Promise<string | Buffer>;
Expand Down Expand Up @@ -273,6 +275,7 @@ export interface FsBinding {
read: typeof InternalFSBinding.read;
readBuffers: typeof InternalFSBinding.readBuffers;
readdir: typeof InternalFSBinding.readdir;
readFileUtf8: typeof InternalFSBinding.readFileUtf8;
readlink: typeof InternalFSBinding.readlink;
realpath: typeof InternalFSBinding.realpath;
rename: typeof InternalFSBinding.rename;
Expand Down

0 comments on commit 2fb7cc9

Please sign in to comment.