Skip to main content

Home > git-documentdb > FindOptions

FindOptions type#

Options for find and findFatDoc

Signature:
export declare type FindOptions = {
descending?: boolean;
recursive?: boolean;
prefix?: string;
forceDocType?: DocType;
};
References:

DocType

Remarks#

  • descending: Sort _ids or names in descendant order. Default is false (ascending).

  • recursive: Get documents recursively from all subdirectories. Default is true.

  • prefix: Get documents whose _ids or names start with the prefix.

  • forceDocType: Force return DocType.