Interface: TwistersBuffer

Hierarchy

• TwistersBuffer

Implemented by

• LineBuffer

Index

Properties

• isDisabled

Methods

• cleanup
• init
• teardown
• updateBegin
• updateEnd
• write

Properties

Readonly isDisabled

• isDisabled: boolean

Should be true if related stream is not TTY.

Methods

Optional cleanup

▸ cleanup(): void

Called after the last update.

Returns: void

---

Optional init

▸ init(): void

Called before the first update.

Returns: void

---

Optional teardown

▸ teardown(): void

Called the first time a removed message is encountered.

Returns: void

---

Optional updateBegin

▸ updateBegin(): void

Called before writing a group of buffered messages.

Returns: void

---

Optional updateEnd

▸ updateEnd(): void

Called after writing a group of buffered messages.

Returns: void

---

write

▸ write(text: string | null, isBuffered: boolean): void

Called to write text to the stream.

Implementation Notes:

• The updateStart method will be called to start an update batch before writing buffered messages.
• The updateEnd method will be called to signify the end of an update batch after messages are written.
• Unbuffered messages will NOT be written AFTER buffered messages within an update batch.
• Unbuffered messages may be written outside of an update batch.

Parameters:

Name	Type
text	string | null
isBuffered	boolean

Returns: void