Interface CreateTextFileOptions

interface CreateTextFileOptions {
    encoding?: string;
    fromUserGesture?: boolean;
    overwrite?: boolean;
    overwriteEncoding?: boolean;
}

Hierarchy (view full)

Properties

encoding? fromUserGesture? overwrite? overwriteEncoding?

Properties

Optional encoding

encoding?: string

The encoding to use when updating a file.

Optional fromUserGesture

fromUserGesture?: boolean

Indicates that a user action triggered the opening, e.g. via mouse or keyboard use. Default is true.

Optional overwrite

overwrite?: boolean

Overwrite the file to create if it already exists on disk. Otherwise an error will be thrown (FILE_MODIFIED_SINCE).

Optional overwriteEncoding

overwriteEncoding?: boolean

If set to true, will enforce the selected encoding and not perform any detection using BOMs.

Settings

Member Visibility

Theme

On This Page

encodingfromUserGestureoverwriteoverwriteEncoding