Package version:

Interface GetDocumentOptions<TModel, TFields>

Options for retrieving a single document.

interface GetDocumentOptions<TModel, TFields> {
    selectedFields?: SelectArray<TFields>;
    xMsEnableElevatedRead?: boolean;
    xMsQuerySourceAuthorization?: string;
}

Properties

selectedFields?: SelectArray<TFields>

List of field names to retrieve for the document; Any field not retrieved will be missing from the returned document.

xMsEnableElevatedRead?: boolean

A value that enables elevated read that bypass document level permission checks for the query operation.

xMsQuerySourceAuthorization?: string

Token identifying the user for which the query is being executed. This token is used to enforce security restrictions on documents.