@mikeyt23/node-cli-utils
    Preparing search index...

    Interface EmptyDirectoryOptions

    Options for emptyDirectory method.

    interface EmptyDirectoryOptions {
        allowedBaseDirectory: string | undefined;
        askForConfirmation: boolean;
        fileAndDirectoryNamesToSkip: string[];
        force: boolean;
        throwIfNotExists: boolean;
    }
    Index

    Properties

    allowedBaseDirectory askForConfirmation fileAndDirectoryNamesToSkip force throwIfNotExists

    Properties

    allowedBaseDirectory: string | undefined

    Allow operation on subdirectories below the specified base directory instead of using the current working directory by default.

    askForConfirmation: boolean

    Defaults to false. Good idea to set to true if using allowedBaseDirectory and/or full automation isn't needed.

    fileAndDirectoryNamesToSkip: string[]

    An optional array of file and directory names to skip, but only at the top level of the directoryToEmpty.

    force: boolean

    Defaults to false. This value is passed through to the NodeJS rm method.

    throwIfNotExists: boolean

    Defaults to false. Pass true if you want an exception thrown instead of an empty directory created when the directoryToEmpty param passed to emptyDirectory does not exist.

    Settings

    On This Page

    Properties