WriteFileOptions

Hierarchy

WriteFileOptions

Index

Properties

append
binary
cwd
header
project
ready

Properties

Optional append

append?: boolean

If true, contents are appended to the file, otherwise the file is overwritten with the new content.

default: false

Optional binary

binary?: boolean

If true, writes a binary file instead of a text file.

default: false

Optional cwd

cwd?: string

The directory where the operation takes place.

default: "/inform"

Optional header

header?: boolean

If true, an Inform 7 header is added to the start of the file. On Inform 6 this option does nothing.

default: true

Optional project

project?: string

The project name that's used in the Inform 7 header. Does nothing on Inform 6 or if the header option is not set.

default: "VORPLE"

Optional ready

ready?: boolean

If true, the header gets a "ready" mark (*) to signal Inform 7 that the file can be read. Otherwise the header is marked not ready (-). Does nothing on Inform 6 or if the header option is not set.

default: true