Interface GenericFindOptions

Options for some generic find command.

Field

sort - The sort order to pick which document to return if the filter selects multiple documents.

Field

projection - Specifies which fields should be included/excluded in the returned documents.

Field

limit - Max number of documents to return in the lifetime of the cursor.

Field

skip - Number of documents to skip if using a sort.

Field

includeSimilarity - If true, include the similarity score in the result via the $similarity field.

interface GenericFindOptions {
    includeSimilarity?: boolean;
    includeSortVector?: boolean;
    limit?: number;
    maxTimeMS?: "ERROR: The `maxTimeMS` option is no longer available; the timeouts system has been overhauled, and timeouts should now be set using `timeout`";
    projection?: Projection;
    skip?: number;
    sort?: Sort;
    timeout?: number | Pick<Partial<TimeoutDescriptor>, "requestTimeoutMs" | "generalMethodTimeoutMs">;
    vector?: "ERROR: Use `sort: { $vector: [...] }` instead";
    vectorize?: "ERROR: Use `sort: { $vectorize: \"...\" }` instead";
}

Hierarchy (view full)

  • WithTimeout<"generalMethodTimeoutMs">
    • GenericFindOptions

Properties

includeSimilarity? includeSortVector? limit? maxTimeMS? projection? skip? sort? timeout? vector? vectorize?

Properties

Optional includeSimilarity

includeSimilarity?: boolean

If true, include the similarity score in the result via the $similarity field.

Optional includeSortVector

includeSortVector?: boolean

If true, the sort vector will be available through await cursor.getSortVector()

Optional limit

limit?: number

The maximum number of records to return in the lifetime of the cursor.

Defaults to null, which means no limit.

Optional maxTimeMS

maxTimeMS?: "ERROR: The `maxTimeMS` option is no longer available; the timeouts system has been overhauled, and timeouts should now be set using `timeout`"

This temporary error-ing property exists for migration convenience, and will be removed in a future version.

Deprecated

  • The maxTimeMS option is no longer available; the timeouts system has been overhauled, and timeouts should now be set using timeout, and defaults in timeoutDefaults. You may generally Ctrl+R replace maxTimeMS with timeout to retain the same behavior.

Optional projection

projection?: Projection

The projection to apply to the returned records, to specify only a select set of fields to return.

If using a projection, it is heavily recommended to provide a custom type for the returned records as a generic typeparam to the find method.

Optional skip

skip?: number

The number of records to skip before starting to return records.

Defaults to null, which means no skip.

Optional sort

sort?: Sort

The order in which to apply the update if the filter selects multiple records.

Defaults to null, where the order is not guaranteed.

Optional timeout

timeout?: number | Pick<Partial<TimeoutDescriptor>, "requestTimeoutMs" | "generalMethodTimeoutMs">

The method timeout override.

See TimeoutDescriptor for much more information.

Optional vector

vector?: "ERROR: Use `sort: { $vector: [...] }` instead"

This temporary error-ing property exists for migration convenience, and will be removed in a future version.

Deprecated

  • Use sort: { $vector: [...] } instead.

Optional vectorize

vectorize?: "ERROR: Use `sort: { $vectorize: \"...\" }` instead"

This temporary error-ing property exists for migration convenience, and will be removed in a future version.

Deprecated

  • Use sort: { $vectorize: '...' } instead.

Settings

Member Visibility

Theme

On This Page

includeSimilarityincludeSortVectorlimitmaxTimeMSprojectionskipsorttimeoutvectorvectorize