Skip to content

fix(NODE-3843): make GridFSBucketWriteStream.prototype.end() return this for compat with community nodejs types #3088

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 4, 2022
Merged

fix(NODE-3843): make GridFSBucketWriteStream.prototype.end() return this for compat with community nodejs types #3088

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions src/gridfs/upload.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,21 +172,21 @@ export class GridFSBucketWriteStream extends Writable implements NodeJS.Writable
* @param encoding - Optional encoding for the buffer
* @param callback - Function to call when all files and chunks have been persisted to MongoDB
*/
end(): void;
end(chunk: Buffer): void;
end(callback: Callback<GridFSFile | void>): void;
end(chunk: Buffer, callback: Callback<GridFSFile | void>): void;
end(chunk: Buffer, encoding: BufferEncoding): void;
end(): this;
end(chunk: Buffer): this;
end(callback: Callback<GridFSFile | void>): this;
end(chunk: Buffer, callback: Callback<GridFSFile | void>): this;
end(chunk: Buffer, encoding: BufferEncoding): this;
end(
chunk: Buffer,
encoding: BufferEncoding | undefined,
callback: Callback<GridFSFile | void>
): void;
): this;
end(
chunkOrCallback?: Buffer | Callback<GridFSFile | void>,
encodingOrCallback?: BufferEncoding | Callback<GridFSFile | void>,
callback?: Callback<GridFSFile | void>
): void {
): this {
const chunk = typeof chunkOrCallback === 'function' ? undefined : chunkOrCallback;
const encoding = typeof encodingOrCallback === 'function' ? undefined : encodingOrCallback;
callback =
Expand All @@ -196,7 +196,7 @@ export class GridFSBucketWriteStream extends Writable implements NodeJS.Writable
? encodingOrCallback
: callback;

if (checkAborted(this, callback)) return;
if (checkAborted(this, callback)) return this;

this.state.streamEnd = true;

Expand All @@ -208,12 +208,14 @@ export class GridFSBucketWriteStream extends Writable implements NodeJS.Writable

if (!chunk) {
waitForIndexes(this, () => !!writeRemnant(this));
return;
return this;
}

this.write(chunk, encoding, () => {
writeRemnant(this);
});

return this;
}
}

Expand Down