Skip to content

Commit 2467b82

Browse files
authored
docs(NODE-3492): Deprecate CloseCursorOptions (#2925)
1 parent 48d6da9 commit 2467b82

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

src/cursor/abstract_cursor.ts

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,11 @@ export const CURSOR_FLAGS = [
5151
'partial'
5252
] as const;
5353

54-
/** @public */
55-
// TODO: Remove this as the option is never used. (NODE-3489)
54+
/** @public
55+
* @deprecated This interface is deprecated */
5656
export interface CursorCloseOptions {
5757
/** Bypass calling killCursors when closing the cursor. */
58+
/** @deprecated the skipKillCursors option is deprecated */
5859
skipKillCursors?: boolean;
5960
}
6061

@@ -373,9 +374,15 @@ export abstract class AbstractCursor<
373374
});
374375
}
375376

376-
close(): Promise<void>;
377+
close(): void;
377378
close(callback: Callback): void;
379+
/**
380+
* @deprecated options argument is deprecated
381+
*/
378382
close(options: CursorCloseOptions): Promise<void>;
383+
/**
384+
* @deprecated options argument is deprecated
385+
*/
379386
close(options: CursorCloseOptions, callback: Callback): void;
380387
close(options?: CursorCloseOptions | Callback, callback?: Callback): Promise<void> | void {
381388
if (typeof options === 'function') (callback = options), (options = {});

0 commit comments

Comments
 (0)