Skip to content

Commit c015e54

Browse files
feat(NODE-5319): mark search index api public (#3741)
1 parent d8a5271 commit c015e54

File tree

3 files changed

+6
-16
lines changed

3 files changed

+6
-16
lines changed

src/collection.ts

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1050,8 +1050,6 @@ export class Collection<TSchema extends Document = Document> {
10501050
}
10511051

10521052
/**
1053-
* @internal
1054-
*
10551053
* Returns all search indexes for the current collection.
10561054
*
10571055
* @param options - The options for the list indexes operation.
@@ -1060,8 +1058,6 @@ export class Collection<TSchema extends Document = Document> {
10601058
*/
10611059
listSearchIndexes(options?: ListSearchIndexesOptions): ListSearchIndexesCursor;
10621060
/**
1063-
* @internal
1064-
*
10651061
* Returns all search indexes for the current collection.
10661062
*
10671063
* @param name - The name of the index to search for. Only indexes with matching index names will be returned.
@@ -1087,8 +1083,6 @@ export class Collection<TSchema extends Document = Document> {
10871083
}
10881084

10891085
/**
1090-
* @internal
1091-
*
10921086
* Creates a single search index for the collection.
10931087
*
10941088
* @param description - The index description for the new search index.
@@ -1102,8 +1096,6 @@ export class Collection<TSchema extends Document = Document> {
11021096
}
11031097

11041098
/**
1105-
* @internal
1106-
*
11071099
* Creates multiple search indexes for the current collection.
11081100
*
11091101
* @param descriptions - An array of `SearchIndexDescription`s for the new search indexes.
@@ -1120,8 +1112,6 @@ export class Collection<TSchema extends Document = Document> {
11201112
}
11211113

11221114
/**
1123-
* @internal
1124-
*
11251115
* Deletes a search index by index name.
11261116
*
11271117
* @param name - The name of the search index to be deleted.
@@ -1136,8 +1126,6 @@ export class Collection<TSchema extends Document = Document> {
11361126
}
11371127

11381128
/**
1139-
* @internal
1140-
*
11411129
* Updates a search index by replacing the existing index definition with the provided definition.
11421130
*
11431131
* @param name - The name of the search index to update.

src/cursor/list_search_indexes_cursor.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@ import type { Collection } from '../collection';
22
import type { AggregateOptions } from '../operations/aggregate';
33
import { AggregationCursor } from './aggregation_cursor';
44

5-
/** @internal */
5+
/** @public */
66
export type ListSearchIndexesOptions = AggregateOptions;
77

8-
/** @internal */
8+
/** @public */
99
export class ListSearchIndexesCursor extends AggregationCursor<{ name: string }> {
1010
/** @internal */
1111
constructor(

src/operations/search_indexes/create.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,15 @@ import type { ClientSession } from '../../sessions';
66
import type { Callback } from '../../utils';
77
import { AbstractOperation } from '../operation';
88

9-
/** @internal */
9+
/**
10+
* @public
11+
*/
1012
export interface SearchIndexDescription {
1113
/** The name of the index. */
1214
name?: string;
1315

1416
/** The index definition. */
15-
description: Document;
17+
definition: Document;
1618
}
1719

1820
/** @internal */

0 commit comments

Comments
 (0)