happy-opfs
    Preparing search index...

    Type Alias TempOptions

    TempOptions:
        | { basename?: string; extname?: never; isDirectory?: boolean }
        | { basename?: string; extname?: string; isDirectory?: false }

    Options for mkTemp.

    The isDirectory and extname options are mutually exclusive. Setting both will result in a compile-time error; at runtime extname is ignored for directories.

    Type Declaration

    • { basename?: string; extname?: never; isDirectory?: boolean }
      • Optionalbasename?: string

        The basename of the file or directory. eg: mktemp -t basename.XXX

        tmp

      • Optionalextname?: never

        Must be omitted when isDirectory is true.

      • OptionalisDirectory?: boolean

        Whether to create a directory. eg: mktemp -d

        false

    • { basename?: string; extname?: string; isDirectory?: false }
      • Optionalbasename?: string

        The basename of the file or directory. eg: mktemp -t basename.XXX

        tmp

      • Optionalextname?: string

        The extension of the file. eg: mktemp --suffix .txt

      • OptionalisDirectory?: false

        Must be false or omitted when extname is provided.

        false

    // Create a temporary file
    await mkTemp();

    // Create a temporary directory
    await mkTemp({ isDirectory: true });

    // Create a temporary file with extension
    await mkTemp({ extname: '.txt' });

    Settings

    Member Visibility