Interface DiveOptions

Options for [[dive]].

interface DiveOptions {
    all?: boolean;
    directories?: boolean;
    files?: boolean;
    ignore?: string | false | RegExp;
    recursive?: boolean;
}

Properties

all? directories? files? ignore? recursive?

Properties

Optional all

all?: boolean

If set to true, this will show "dot files" and files in "dot directories", e.g. ".gitignore" or ".git/HEAD".

Optional directories

directories?: boolean

If set to true, this will call action on directories, too.

Optional files

files?: boolean

If set to false, this won't call action on files any more.

Optional ignore

ignore?: string | false | RegExp

If set to a string or RegExp, all files and directories that match will be ignored.

Optional recursive

recursive?: boolean

If set to false, this will ignore subdirectories.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc