Interface IOptions

Constructor options

interface IOptions {
    auto?: boolean;
    driveName?: string;
    filter?: (value: Contents.IModel) => null | Partial<IScore>;
    filterDirectories?: boolean;
    includeHiddenFiles?: boolean;
    manager: IDocumentManager;
    refreshInterval?: number;
    refreshStandby?: Standby | () => boolean | Standby;
    state?: IStateDB<ReadonlyPartialJSONValue>;
    translator?: ITranslator;
    useFuzzyFilter?: boolean;
}

Hierarchy (View Summary)

Properties

auto? driveName? filter? filterDirectories? includeHiddenFiles? manager refreshInterval? refreshStandby? state? translator? useFuzzyFilter?

Properties

Optionalauto

auto?: boolean

Whether a file browser automatically loads its initial path. The default is true.

OptionaldriveName

driveName?: string

An optional Contents.IDrive name for the model. If given, the model will prepend driveName: to all paths used in file operations.

Optionalfilter

filter?: (value: Contents.IModel) => null | Partial<IScore>

Filter function on file browser item model

OptionalfilterDirectories

filterDirectories?: boolean

Filter directories

OptionalincludeHiddenFiles

includeHiddenFiles?: boolean

Whether hidden files should be included in the items.

manager

manager: IDocumentManager

A document manager instance.

OptionalrefreshInterval

refreshInterval?: number

The time interval for browser refreshing, in ms.

OptionalrefreshStandby

refreshStandby?: Standby | () => boolean | Standby

When the model stops polling the API. Defaults to when-hidden.

Optionalstate

state?: IStateDB<ReadonlyPartialJSONValue>

An optional state database. If provided, the model will restore which folder was last opened when it is restored.

Optionaltranslator

translator?: ITranslator

The application language translator.

OptionaluseFuzzyFilter

useFuzzyFilter?: boolean

Use Fuzzy Filter

Settings

Member Visibility

On This Page

Properties