Interface SearchOptions

Represents the options for searching.

interface SearchOptions {
    createIfNotFound?: boolean;
    createOptions?: CreateOptions;
    findAll?: boolean;
    maxDepth?: number;
}

Index

Properties

createIfNotFound? createOptions? findAll? maxDepth?

Properties

`Optional`createIfNotFound

createIfNotFound?: boolean

Indicates whether to create the item if it is not found.

`Optional`createOptions

createOptions?: CreateOptions

The options for creating the item.

`Optional`findAll

findAll?: boolean

Indicates whether to find all matches or stop at the first match.

`Optional`maxDepth

maxDepth?: number

The maximum depth to search. 1 means only the immediate children of the base object.