Interface SetOptions

Options for setting extended attributes. Extends the base Options with additional flags for create/replace behavior.

interface SetOptions {
    create?: boolean;
    encoding?: "buffer" | BufferEncoding;
    noFollow?: boolean;
    replace?: boolean;
}

Hierarchy (View Summary)

Properties

create? encoding? noFollow? replace?

Properties

Optionalcreate

create?: boolean

If true, fail if the attribute already exists.

Default

false

Optionalencoding

encoding?: "buffer" | BufferEncoding

Encoding for attribute values. If 'buffer' or undefined, the value is returned as a Buffer. Otherwise, the value is returned as a string using the specified encoding.

Default

undefined

OptionalnoFollow

noFollow?: boolean

If true, don't follow symlinks.

Default

false

Optionalreplace

replace?: boolean

If true, fail if the attribute does not exist.

Default

false

Settings

Member Visibility

On This Page

Properties