Utf8Stream

Defined in: src/node/utf8stream.ts:105

An optimized UTF-8 stream writer that allows for flushing all of the internal buffering on demand.

Extends

EventEmitter<fs.Utf8StreamEventMap>

Implements

EventEmitter
Utf8Stream

Constructors

Constructor

new Utf8Stream(options?): Utf8Stream

Defined in: src/node/utf8stream.ts:150

Parameters

options?

Utf8StreamOptions = {}

Returns

Utf8Stream

Overrides

EventEmitter<fs.Utf8StreamEventMap>.constructor

Properties

constructor

constructor: typeof Utf8Stream

Defined in: src/node/utf8stream.ts:137

The initial value of Object.prototype.constructor is the standard built-in Object constructor.

[kUtf8StreamFS]

static [kUtf8StreamFS]: FS = _utf8StreamFS

Defined in: src/node/utf8stream.ts:138

prefixed

static prefixed: string | boolean

Defined in: node_modules/eventemitter3/index.d.ts:9

Inherited from

EventEmitter.prefixed

Accessors

append

Get Signature

get append(): boolean

Defined in: src/node/utf8stream.ts:473

Whether the stream is appending to the file or truncating it

Returns

boolean

Implementation of

fs.Utf8Stream.append

contentMode

Get Signature

get contentMode(): "buffer" | "utf8"

Defined in: src/node/utf8stream.ts:483

The type of data that can be written to the stream

Returns

"buffer" | "utf8"

Implementation of

fs.Utf8Stream.contentMode

fd

Get Signature

get fd(): number

Defined in: src/node/utf8stream.ts:440

The file descriptor that is being written to

Returns

number

Implementation of

fs.Utf8Stream.fd

file

Get Signature

get file(): string

Defined in: src/node/utf8stream.ts:435

The file that is being written to

Returns

string

Implementation of

fs.Utf8Stream.file

fsync

Get Signature

get fsync(): boolean

Defined in: src/node/utf8stream.ts:468

Whether the stream performs a fsyncSync after every write

Returns

boolean

Implementation of

fs.Utf8Stream.fsync

maxLength

Get Signature

get maxLength(): number

Defined in: src/node/utf8stream.ts:453

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

Returns

number

Implementation of

fs.Utf8Stream.maxLength

minLength

Get Signature

get minLength(): number

Defined in: src/node/utf8stream.ts:445

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

Returns

number

Implementation of

fs.Utf8Stream.minLength

mkdir

Get Signature

get mkdir(): boolean

Defined in: src/node/utf8stream.ts:488

Whether the directory for file is created if it does not exist

Returns

boolean

Implementation of

fs.Utf8Stream.mkdir

mode

Get Signature

get mode(): Mode

Defined in: src/node/utf8stream.ts:430

The mode of the file that is being written to

Returns

Mode

Implementation of

fs.Utf8Stream.mode

periodicFlush

Get Signature

get periodicFlush(): number

Defined in: src/node/utf8stream.ts:478

The number of milliseconds between flushes. 0 means no periodic flushes are performed.

Returns

number

Implementation of

fs.Utf8Stream.periodicFlush

sync

Get Signature

get sync(): boolean

Defined in: src/node/utf8stream.ts:463

Whether the stream is writing synchronously or asynchronously

Returns

boolean

Implementation of

fs.Utf8Stream.sync

writing

Get Signature

get writing(): boolean

Defined in: src/node/utf8stream.ts:458

Whether the stream is currently writing data to the file

Returns

boolean

Implementation of

fs.Utf8Stream.writing

Methods

[dispose]()

[dispose](): void

Defined in: src/node/utf8stream.ts:492

Returns

void

Implementation of

fs.Utf8Stream.[dispose]

addListener()

addListener<T>(event, fn, context?): this

Defined in: src/node/utf8stream.ts:739

Type Parameters

T

T extends keyof Utf8StreamEventMap

Parameters

event

T

fn

(…args) => void

context?

any

Returns

this

Implementation of

NodeEventEmitter.addListener

Overrides

EventEmitter.addListener

destroy()

destroy(): void

Defined in: src/node/utf8stream.ts:424

Close the stream immediately, without flushing the internal buffer.

Returns

void

Implementation of

fs.Utf8Stream.destroy

emit()

emit<T>(event, …args): boolean

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

Type Parameters

T

T extends keyof Utf8StreamEventMap

Parameters

event

T

args

…ArgumentMap<Utf8StreamEventMap>[Extract<T, keyof Utf8StreamEventMap>]

Returns

boolean

Implementation of

NodeEventEmitter.emit

Inherited from

EventEmitter.emit

end()

end(): void

Defined in: src/node/utf8stream.ts:403

Close the stream gracefully, flushing the internal buffer before closing.

Returns

void

Implementation of

fs.Utf8Stream.end

eventNames()

eventNames(): keyof Utf8StreamEventMap[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered listeners.

Returns

keyof Utf8StreamEventMap[]

Implementation of

NodeEventEmitter.eventNames

Inherited from

EventEmitter.eventNames

flush()

flush(cb?): void

Defined in: src/node/utf8stream.ts:285

Writes the current buffer to the file if a write was not in progress. Does nothing if minLength is zero or if it is already writing.

Parameters

cb?

((err) => void) | null

Returns

void

Implementation of

fs.Utf8Stream.flush

flushSync()

flushSync(): void

Defined in: src/node/utf8stream.ts:315

Flushes the buffered data synchronously. This is a costly operation.

Returns

void

Implementation of

fs.Utf8Stream.flushSync

getMaxListeners()

getMaxListeners(): never

Defined in: src/node/utf8stream.ts:760

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to events.defaultMaxListeners.

Returns

never

Since

v1.0.0

Implementation of

NodeEventEmitter.getMaxListeners

listenerCount()

listenerCount(event): number

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

Parameters

event

keyof Utf8StreamEventMap

Returns

number

Implementation of

NodeEventEmitter.listenerCount

Inherited from

EventEmitter.listenerCount

listeners()

listeners<T>(event): (…args) => void[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

Type Parameters

T

T extends keyof Utf8StreamEventMap

Parameters

event

T

Returns

(…args) => void[]

Implementation of

NodeEventEmitter.listeners

Inherited from

EventEmitter.listeners

off()

off<T>(event, fn?, context?, once?): this

Defined in: src/node/utf8stream.ts:748

Type Parameters

T

T extends keyof Utf8StreamEventMap

Parameters

event

T

fn?

(…args) => void

context?

any

once?

boolean

Returns

this

Implementation of

NodeEventEmitter.off

Overrides

EventEmitter.off

on()

on<T>(event, fn, context?): this

Defined in: src/node/utf8stream.ts:734

Add a listener for a given event.

Type Parameters

T

T extends keyof Utf8StreamEventMap

Parameters

event

T

fn

(…args) => void

context?

any

Returns

this

Implementation of

NodeEventEmitter.on

Overrides

EventEmitter.on

once()

once<T>(event, fn, context?): this

Defined in: src/node/utf8stream.ts:743

Add a one-time listener for a given event.

Type Parameters

T

T extends keyof Utf8StreamEventMap

Parameters

event

T

fn

(…args) => void

context?

any

Returns

this

Implementation of

NodeEventEmitter.once

Overrides

EventEmitter.once

prependListener()

prependListener(): never

Defined in: src/node/utf8stream.ts:764

Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

server.prependListener('connection', (stream) => {
  console.log('someone connected!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

Returns

never

Since

v6.0.0

Implementation of

NodeEventEmitter.prependListener

prependOnceListener()

prependOnceListener(): never

Defined in: src/node/utf8stream.ts:768

Adds a one-time listener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

server.prependOnceListener('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

Returns

never

Since

v6.0.0

Implementation of

NodeEventEmitter.prependOnceListener

rawListeners()

rawListeners(): never

Defined in: src/node/utf8stream.ts:772

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));

// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];

// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();

// Logs "log once" to the console and removes the listener
logFnWrapper();

emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');

// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');

Returns

never

Since

v9.4.0

Implementation of

NodeEventEmitter.rawListeners

removeAllListeners()

removeAllListeners(event?): this

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

Parameters

event?

keyof Utf8StreamEventMap

Returns

this

Implementation of

NodeEventEmitter.removeAllListeners

Inherited from

EventEmitter.removeAllListeners

removeListener()

removeListener<T>(event, fn?, context?, once?): this

Defined in: src/node/utf8stream.ts:752

Remove the listeners of a given event.

Type Parameters

T

T extends keyof Utf8StreamEventMap

Parameters

event

T

fn?

(…args) => void

context?

any

once?

boolean

Returns

this

Implementation of

NodeEventEmitter.removeListener

Overrides

EventEmitter.removeListener

reopen()

reopen(file?): void

Defined in: src/node/utf8stream.ts:372

Reopen the file in place, useful for log rotation.

Parameters

file?

PathLike

Returns

void

Implementation of

fs.Utf8Stream.reopen

setMaxListeners()

setMaxListeners(): never

Defined in: src/node/utf8stream.ts:756

By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

Returns a reference to the EventEmitter, so that calls can be chained.

Returns

never

Since

v0.3.5

Implementation of

NodeEventEmitter.setMaxListeners

write()

write(data): boolean

Defined in: src/node/utf8stream.ts:241

When contentMode is utf8, data must be a string. When it is buffer, data must be a Buffer.

Parameters

data

string | Buffer<ArrayBufferLike>

Returns

boolean

Whether the internal buffer is below the high water mark

Implementation of

fs.Utf8Stream.write

Contribute Sponsor