Utf8StreamOptions

sealed external interface Utf8StreamOptions(source)

Properties

Link copied to clipboard
abstract var append: Boolean?

Appends writes to dest file instead of truncating it.

Link copied to clipboard

Which type of data you can send to the write function, supported values are 'utf8' or 'buffer'.

Link copied to clipboard
abstract var dest: String?

A path to a file to be written to (mode controlled by the append option).

Link copied to clipboard
abstract var fd: Double?

A file descriptor, something that is returned by fs.open() or fs.openSync().

Link copied to clipboard
abstract var fs: Any?

An object that has the same API as the fs module, useful for mocking, testing, or customizing the behavior of the stream.

Link copied to clipboard
abstract var fsync: Boolean?

Perform a fs.fsyncSync() every time a write is completed.

Link copied to clipboard
abstract var maxLength: Double?

The maximum length of the internal buffer. If a write operation would cause the buffer to exceed maxLength, the data written is dropped and a drop event is emitted with the dropped data

Link copied to clipboard
abstract var maxWrite: Double?

The maximum number of bytes that can be written;

Link copied to clipboard
abstract var minLength: Double?

The minimum length of the internal buffer that is required to be full before flushing.

Link copied to clipboard
abstract var mkdir: Boolean?

Ensure directory for dest file exists when true.

Link copied to clipboard
abstract var mode: Any?

Specify the creating file mode (see fs.open()).

Link copied to clipboard
abstract var periodicFlush: Double?

Calls flush every periodicFlush milliseconds.

Link copied to clipboard
abstract var retryEAGAIN: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, writeBufferLen: Number, remainingBufferLen: Number) -> Boolean?

A function that will be called when write(), writeSync(), or flushSync() encounters an EAGAIN or EBUSY error. If the return value is true the operation will be retried, otherwise it will bubble the error. The err is the error that caused this function to be called, writeBufferLen is the length of the buffer that was written, and remainingBufferLen is the length of the remaining buffer that the stream did not try to write.

Link copied to clipboard
abstract var sync: Boolean?

Perform writes synchronously.