Interface VacuumOptions

Options for [[vacuum]].

interface VacuumOptions {
    base?: string;
    log?: ((prefix, message?, ...args) => void);
    purge?: boolean;
}

Properties

base? log? purge?

Properties

Optional base

base?: string

No directories at or above this level of the filesystem will be removed.

Optional log

log?: ((prefix, message?, ...args) => void)

A logging function that takes npmlog-compatible argument lists.

Type declaration

    • (prefix, message?, ...args): void

    • A logging function that takes npmlog-compatible argument lists.

      Parameters

      • prefix: undefined | string
      • Optional message: string
      • Rest ...args: any[]

      Returns void

Optional purge

purge?: boolean

If set, nuke the whole leaf directory, including its contents.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc