OpenOptions

Defined in: plugins/fs/guest-js/index.ts:499

Properties

append?

optional append: boolean

Defined in: plugins/fs/guest-js/index.ts:518

Sets the option for the append mode. This option, when true, means that writes will append to a file instead of overwriting previous contents. Note that setting { write: true, append: true } has the same effect as setting only { append: true }.

baseDir?

optional baseDir: BaseDirectory

Defined in: plugins/fs/guest-js/index.ts:546

Base directory for path

create?

optional create: boolean

Defined in: plugins/fs/guest-js/index.ts:531

Sets the option to allow creating a new file, if one doesn’t already exist at the specified path. Requires write or append access to be used.

createNew?

optional createNew: boolean

Defined in: plugins/fs/guest-js/index.ts:538

Defaults to false. If set to true, no file, directory, or symlink is allowed to exist at the target location. Requires write or append access to be used. When createNew is set to true, create and truncate are ignored.

mode?

optional mode: number

Defined in: plugins/fs/guest-js/index.ts:544

Permissions to use if creating the file (defaults to 0o666, before the process’s umask). Ignored on Windows.

read?

optional read: boolean

Defined in: plugins/fs/guest-js/index.ts:504

Sets the option for read access. This option, when true, means that the file should be read-able if opened.

truncate?

optional truncate: boolean

Defined in: plugins/fs/guest-js/index.ts:525

Sets the option for truncating a previous file. If a file is successfully opened with this option set it will truncate the file to 0 size if it already exists. The file must be opened with write access for truncate to work.

write?

optional write: boolean

Defined in: plugins/fs/guest-js/index.ts:511

Sets the option for write access. This option, when true, means that the file should be write-able if opened. If the file already exists, any write calls on it will overwrite its contents, by default without truncating it.