TestsStream
[<Interface>]
type TestsStream =
abstract member addListener (event: string, listener: obj array -> unit) : TestsStream
abstract member addListenerTestComplete (listener: TestComplete -> unit) : TestsStream
abstract member addListenerTestCoverage (listener: TestCoverage -> unit) : TestsStream
abstract member addListenerTestDequeue (listener: TestDequeue -> unit) : TestsStream
abstract member addListenerTestDiagnostic (listener: TestDiagnostic -> unit) : TestsStream
abstract member addListenerTestEnqueue (listener: TestEnqueue -> unit) : TestsStream
abstract member addListenerTestFail (listener: TestFail -> unit) : TestsStream
abstract member addListenerTestPass (listener: TestPass -> unit) : TestsStream
abstract member addListenerTestPlan (listener: TestPlan -> unit) : TestsStream
abstract member addListenerTestStart (listener: TestStart -> unit) : TestsStream
abstract member addListenerTestStderr (listener: TestStderr -> unit) : TestsStream
abstract member addListenerTestStdout (listener: TestStdout -> unit) : TestsStream
abstract member addListenerTestSummary (listener: TestSummary -> unit) : TestsStream
abstract member addListenerTestWatchDrained (listener: unit -> unit) : TestsStream
abstract member compose<'T when 'T :> ReadableStream> (stream: U4<'T,AsyncIterable<'T,obj,obj>,(obj -> unit),Iterable<'T,obj,obj>>, ?options: Options) : 'T
abstract member destroy (?error: exn) : TestsStream
abstract member emitTestComplete (data: TestComplete) : bool
abstract member emitTestCoverage (data: TestCoverage) : bool
abstract member emitTestDequeue (data: TestDequeue) : bool
abstract member emitTestDiagnostic (data: TestDiagnostic) : bool
abstract member emitTestEnqueue (data: TestEnqueue) : bool
abstract member emitTestFail (data: TestFail) : bool
abstract member emitTestPass (data: TestPass) : bool
abstract member emitTestPlan (data: TestPlan) : bool
abstract member emitTestStart (data: TestStart) : bool
abstract member emitTestStderr (data: TestStderr) : bool
abstract member emitTestStdout (data: TestStdout) : bool
abstract member emitTestSummary (data: TestSummary) : bool
abstract member emitTestWatchDrained () : bool
abstract member off (eventName: U2<string,Symbol>, listener: obj array -> unit) : TestsStream
abstract member on (event: string, listener: obj array -> unit) : TestsStream
abstract member onTestComplete (listener: TestComplete -> unit) : TestsStream
abstract member onTestCoverage (listener: TestCoverage -> unit) : TestsStream
abstract member onTestDequeue (listener: TestDequeue -> unit) : TestsStream
abstract member onTestDiagnostic (listener: TestDiagnostic -> unit) : TestsStream
abstract member onTestEnqueue (listener: TestEnqueue -> unit) : TestsStream
abstract member onTestFail (listener: TestFail -> unit) : TestsStream
abstract member onTestPass (listener: TestPass -> unit) : TestsStream
abstract member onTestPlan (listener: TestPlan -> unit) : TestsStream
abstract member onTestStart (listener: TestStart -> unit) : TestsStream
abstract member onTestStderr (listener: TestStderr -> unit) : TestsStream
abstract member onTestStdout (listener: TestStdout -> unit) : TestsStream
abstract member onTestSummary (listener: TestSummary -> unit) : TestsStream
abstract member onTestWatchDrained (listener: unit -> unit) : TestsStream
abstract member once (event: string, listener: obj array -> unit) : TestsStream
abstract member onceTestComplete (listener: TestComplete -> unit) : TestsStream
abstract member onceTestCoverage (listener: TestCoverage -> unit) : TestsStream
abstract member onceTestDequeue (listener: TestDequeue -> unit) : TestsStream
abstract member onceTestDiagnostic (listener: TestDiagnostic -> unit) : TestsStream
abstract member onceTestEnqueue (listener: TestEnqueue -> unit) : TestsStream
abstract member onceTestFail (listener: TestFail -> unit) : TestsStream
abstract member onceTestPass (listener: TestPass -> unit) : TestsStream
abstract member onceTestPlan (listener: TestPlan -> unit) : TestsStream
abstract member onceTestStart (listener: TestStart -> unit) : TestsStream
abstract member onceTestStderr (listener: TestStderr -> unit) : TestsStream
abstract member onceTestStdout (listener: TestStdout -> unit) : TestsStream
abstract member onceTestSummary (listener: TestSummary -> unit) : TestsStream
abstract member onceTestWatchDrained (listener: unit -> unit) : TestsStream
abstract member pause () : TestsStream
abstract member pipe<'T when 'T :> WritableStream> (destination: 'T, ?options: Options) : 'T
abstract member prependListener (event: string, listener: obj array -> unit) : TestsStream
abstract member prependListenerTestComplete (listener: TestComplete -> unit) : TestsStream
abstract member prependListenerTestCoverage (listener: TestCoverage -> unit) : TestsStream
abstract member prependListenerTestDequeue (listener: TestDequeue -> unit) : TestsStream
abstract member prependListenerTestDiagnostic (listener: TestDiagnostic -> unit) : TestsStream
abstract member prependListenerTestEnqueue (listener: TestEnqueue -> unit) : TestsStream
abstract member prependListenerTestFail (listener: TestFail -> unit) : TestsStream
abstract member prependListenerTestPass (listener: TestPass -> unit) : TestsStream
abstract member prependListenerTestPlan (listener: TestPlan -> unit) : TestsStream
abstract member prependListenerTestStart (listener: TestStart -> unit) : TestsStream
abstract member prependListenerTestStderr (listener: TestStderr -> unit) : TestsStream
abstract member prependListenerTestStdout (listener: TestStdout -> unit) : TestsStream
abstract member prependListenerTestSummary (listener: TestSummary -> unit) : TestsStream
abstract member prependListenerTestWatchDrained (listener: unit -> unit) : TestsStream
abstract member prependOnceListener (event: string, listener: obj array -> unit) : TestsStream
abstract member prependOnceListenerTestComplete (listener: TestComplete -> unit) : TestsStream
abstract member prependOnceListenerTestCoverage (listener: TestCoverage -> unit) : TestsStream
abstract member prependOnceListenerTestDequeue (listener: TestDequeue -> unit) : TestsStream
abstract member prependOnceListenerTestDiagnostic (listener: TestDiagnostic -> unit) : TestsStream
abstract member prependOnceListenerTestEnqueue (listener: TestEnqueue -> unit) : TestsStream
abstract member prependOnceListenerTestFail (listener: TestFail -> unit) : TestsStream
abstract member prependOnceListenerTestPass (listener: TestPass -> unit) : TestsStream
abstract member prependOnceListenerTestPlan (listener: TestPlan -> unit) : TestsStream
abstract member prependOnceListenerTestStart (listener: TestStart -> unit) : TestsStream
abstract member prependOnceListenerTestStderr (listener: TestStderr -> unit) : TestsStream
abstract member prependOnceListenerTestStdout (listener: TestStdout -> unit) : TestsStream
abstract member prependOnceListenerTestSummary (listener: TestSummary -> unit) : TestsStream
abstract member prependOnceListenerTestWatchDrained (listener: unit -> unit) : TestsStream
abstract member removeAllListeners (?eventName: U2<string,Symbol>) : TestsStream
abstract member removeListener (event: U2<string,Symbol>, listener: obj array -> unit) : TestsStream
abstract member removeListenerClose (listener: unit -> unit) : TestsStream
abstract member removeListenerData (listener: obj -> unit) : TestsStream
abstract member removeListenerEnd (listener: unit -> unit) : TestsStream
abstract member removeListenerError (listener: exn -> unit) : TestsStream
abstract member removeListenerPause (listener: unit -> unit) : TestsStream
abstract member removeListenerReadable (listener: unit -> unit) : TestsStream
abstract member removeListenerResume (listener: unit -> unit) : TestsStream
abstract member resume () : TestsStream
abstract member setEncoding (encoding: BufferEncoding) : TestsStream
abstract member setMaxListeners (n: float) : TestsStream
abstract member unpipe (?destination: WritableStream) : TestsStream
abstract member wrap (stream: ReadableStream) : TestsStream| Assembly | Xantham.Fable.Node |
| Implements | Readable |
A successful call to run() will return a new TestsStream object, streaming a series of events representing the execution of the tests.
Some of the events are guaranteed to be emitted in the same order as the tests are defined, while others are emitted in the order that the tests execute.
@since v18.9.0, v16.19.0
Declared inside
Compose | |
Pipe |
Methods
abstract member addListener (event: string, listener: obj array -> unit) : TestsStream
abstract member addListener (event: string, listener: obj array -> unit) : TestsStreamEvent emitter The defined events on documents including:
- close
- data
- end
- error
- pause
- readable
- resume
abstract member addListenerTestComplete (listener: TestComplete -> unit) : TestsStream
abstract member addListenerTestComplete (listener: TestComplete -> unit) : TestsStreamaddListener(event: "test:complete", listener: (data: EventData.TestComplete) => void): this
abstract member addListenerTestCoverage (listener: TestCoverage -> unit) : TestsStream
abstract member addListenerTestCoverage (listener: TestCoverage -> unit) : TestsStreamaddListener(event: "test:coverage", listener: (data: EventData.TestCoverage) => void): this
abstract member addListenerTestDequeue (listener: TestDequeue -> unit) : TestsStream
abstract member addListenerTestDequeue (listener: TestDequeue -> unit) : TestsStreamaddListener(event: "test:dequeue", listener: (data: EventData.TestDequeue) => void): this
abstract member addListenerTestDiagnostic (listener: TestDiagnostic -> unit) : TestsStream
abstract member addListenerTestDiagnostic (listener: TestDiagnostic -> unit) : TestsStreamaddListener(event: "test:diagnostic", listener: (data: EventData.TestDiagnostic) => void): this
abstract member addListenerTestEnqueue (listener: TestEnqueue -> unit) : TestsStream
abstract member addListenerTestEnqueue (listener: TestEnqueue -> unit) : TestsStreamaddListener(event: "test:enqueue", listener: (data: EventData.TestEnqueue) => void): this
abstract member addListenerTestFail (listener: TestFail -> unit) : TestsStream
abstract member addListenerTestFail (listener: TestFail -> unit) : TestsStreamaddListener(event: "test:fail", listener: (data: EventData.TestFail) => void): this
abstract member addListenerTestPass (listener: TestPass -> unit) : TestsStream
abstract member addListenerTestPass (listener: TestPass -> unit) : TestsStreamaddListener(event: "test:pass", listener: (data: EventData.TestPass) => void): this
abstract member addListenerTestPlan (listener: TestPlan -> unit) : TestsStream
abstract member addListenerTestPlan (listener: TestPlan -> unit) : TestsStreamaddListener(event: "test:plan", listener: (data: EventData.TestPlan) => void): this
abstract member addListenerTestStart (listener: TestStart -> unit) : TestsStream
abstract member addListenerTestStart (listener: TestStart -> unit) : TestsStreamaddListener(event: "test:start", listener: (data: EventData.TestStart) => void): this
abstract member addListenerTestStderr (listener: TestStderr -> unit) : TestsStream
abstract member addListenerTestStderr (listener: TestStderr -> unit) : TestsStreamaddListener(event: "test:stderr", listener: (data: EventData.TestStderr) => void): this
abstract member addListenerTestStdout (listener: TestStdout -> unit) : TestsStream
abstract member addListenerTestStdout (listener: TestStdout -> unit) : TestsStreamaddListener(event: "test:stdout", listener: (data: EventData.TestStdout) => void): this
abstract member addListenerTestSummary (listener: TestSummary -> unit) : TestsStream
abstract member addListenerTestSummary (listener: TestSummary -> unit) : TestsStreamaddListener(event: "test:summary", listener: (data: EventData.TestSummary) => void): this
abstract member addListenerTestWatchDrained (listener: unit -> unit) : TestsStream
abstract member addListenerTestWatchDrained (listener: unit -> unit) : TestsStreamaddListener(event: "test:watch:drained", listener: () => void): this
abstract member compose<'T when 'T :> ReadableStream> (stream: U4<'T,AsyncIterable<'T,obj,obj>,(obj -> unit),Iterable<'T,obj,obj>>, ?options: Options) : 'Tabstract member destroy (?error: exn) : TestsStream
abstract member destroy (?error: exn) : TestsStreamDestroy the stream. Optionally emit an 'error' event, and emit a 'close' event (unless emitClose is set to false). After this call, the readable stream will release any internal resources and subsequent calls to push() will be ignored.
Once destroy() has been called any further calls will be a no-op and no further errors except from _destroy() may be emitted as 'error'.
Implementors should not override this method, but instead implement readable._destroy().
@since v8.0.0
| Parameter | |
|---|---|
error | Error which will be passed as payload in 'error' event |
abstract member emitTestComplete (data: TestComplete) : bool
abstract member emitTestComplete (data: TestComplete) : boolemit(event: "test:complete", data: EventData.TestComplete): boolean
abstract member emitTestCoverage (data: TestCoverage) : bool
abstract member emitTestCoverage (data: TestCoverage) : boolemit(event: "test:coverage", data: EventData.TestCoverage): boolean
abstract member emitTestDequeue (data: TestDequeue) : bool
abstract member emitTestDequeue (data: TestDequeue) : boolemit(event: "test:dequeue", data: EventData.TestDequeue): boolean
abstract member emitTestDiagnostic (data: TestDiagnostic) : bool
abstract member emitTestDiagnostic (data: TestDiagnostic) : boolemit(event: "test:diagnostic", data: EventData.TestDiagnostic): boolean
abstract member emitTestEnqueue (data: TestEnqueue) : bool
abstract member emitTestEnqueue (data: TestEnqueue) : boolemit(event: "test:enqueue", data: EventData.TestEnqueue): boolean
abstract member emitTestFail (data: TestFail) : bool
abstract member emitTestFail (data: TestFail) : boolemit(event: "test:fail", data: EventData.TestFail): boolean
abstract member emitTestPass (data: TestPass) : bool
abstract member emitTestPass (data: TestPass) : boolemit(event: "test:pass", data: EventData.TestPass): boolean
abstract member emitTestPlan (data: TestPlan) : bool
abstract member emitTestPlan (data: TestPlan) : boolemit(event: "test:plan", data: EventData.TestPlan): boolean
abstract member emitTestStart (data: TestStart) : bool
abstract member emitTestStart (data: TestStart) : boolemit(event: "test:start", data: EventData.TestStart): boolean
abstract member emitTestStderr (data: TestStderr) : bool
abstract member emitTestStderr (data: TestStderr) : boolemit(event: "test:stderr", data: EventData.TestStderr): boolean
abstract member emitTestStdout (data: TestStdout) : bool
abstract member emitTestStdout (data: TestStdout) : boolemit(event: "test:stdout", data: EventData.TestStdout): boolean
abstract member emitTestSummary (data: TestSummary) : bool
abstract member emitTestSummary (data: TestSummary) : boolemit(event: "test:summary", data: EventData.TestSummary): boolean
abstract member emitTestWatchDrained () : bool
abstract member emitTestWatchDrained () : boolemit(event: "test:watch:drained"): boolean
abstract member off (eventName: U2<string,Symbol>, listener: obj array -> unit) : TestsStream
abstract member off (eventName: U2<string,Symbol>, listener: obj array -> unit) : TestsStreamAlias for emitter.removeListener().
@since v10.0.0
abstract member on (event: string, listener: obj array -> unit) : TestsStream
abstract member on (event: string, listener: obj array -> unit) : TestsStreamAdds the listener function to the end 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.on('connection', (stream) => {
console.log('someone connected!');
});
Returns a reference to the EventEmitter, so that calls can be chained.
By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a
abstract member onTestComplete (listener: TestComplete -> unit) : TestsStream
abstract member onTestComplete (listener: TestComplete -> unit) : TestsStreamon(event: "test:complete", listener: (data: EventData.TestComplete) => void): this
abstract member onTestCoverage (listener: TestCoverage -> unit) : TestsStream
abstract member onTestCoverage (listener: TestCoverage -> unit) : TestsStreamon(event: "test:coverage", listener: (data: EventData.TestCoverage) => void): this
abstract member onTestDequeue (listener: TestDequeue -> unit) : TestsStream
abstract member onTestDequeue (listener: TestDequeue -> unit) : TestsStreamon(event: "test:dequeue", listener: (data: EventData.TestDequeue) => void): this
abstract member onTestDiagnostic (listener: TestDiagnostic -> unit) : TestsStream
abstract member onTestDiagnostic (listener: TestDiagnostic -> unit) : TestsStreamon(event: "test:diagnostic", listener: (data: EventData.TestDiagnostic) => void): this
abstract member onTestEnqueue (listener: TestEnqueue -> unit) : TestsStream
abstract member onTestEnqueue (listener: TestEnqueue -> unit) : TestsStreamon(event: "test:enqueue", listener: (data: EventData.TestEnqueue) => void): this
abstract member onTestFail (listener: TestFail -> unit) : TestsStream
abstract member onTestFail (listener: TestFail -> unit) : TestsStreamon(event: "test:fail", listener: (data: EventData.TestFail) => void): this
abstract member onTestPass (listener: TestPass -> unit) : TestsStream
abstract member onTestPass (listener: TestPass -> unit) : TestsStreamon(event: "test:pass", listener: (data: EventData.TestPass) => void): this
abstract member onTestPlan (listener: TestPlan -> unit) : TestsStream
abstract member onTestPlan (listener: TestPlan -> unit) : TestsStreamon(event: "test:plan", listener: (data: EventData.TestPlan) => void): this
abstract member onTestStart (listener: TestStart -> unit) : TestsStream
abstract member onTestStart (listener: TestStart -> unit) : TestsStreamon(event: "test:start", listener: (data: EventData.TestStart) => void): this
abstract member onTestStderr (listener: TestStderr -> unit) : TestsStream
abstract member onTestStderr (listener: TestStderr -> unit) : TestsStreamon(event: "test:stderr", listener: (data: EventData.TestStderr) => void): this
abstract member onTestStdout (listener: TestStdout -> unit) : TestsStream
abstract member onTestStdout (listener: TestStdout -> unit) : TestsStreamon(event: "test:stdout", listener: (data: EventData.TestStdout) => void): this
abstract member onTestSummary (listener: TestSummary -> unit) : TestsStream
abstract member onTestSummary (listener: TestSummary -> unit) : TestsStreamon(event: "test:summary", listener: (data: EventData.TestSummary) => void): this
abstract member onTestWatchDrained (listener: unit -> unit) : TestsStream
abstract member onTestWatchDrained (listener: unit -> unit) : TestsStreamon(event: "test:watch:drained", listener: () => void): this
abstract member once (event: string, listener: obj array -> unit) : TestsStream
abstract member once (event: string, listener: obj array -> unit) : TestsStreamAdds a one-timelistener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.
server.once('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Returns a reference to the EventEmitter, so that calls can be chained.
By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a
abstract member onceTestComplete (listener: TestComplete -> unit) : TestsStream
abstract member onceTestComplete (listener: TestComplete -> unit) : TestsStreamonce(event: "test:complete", listener: (data: EventData.TestComplete) => void): this
abstract member onceTestCoverage (listener: TestCoverage -> unit) : TestsStream
abstract member onceTestCoverage (listener: TestCoverage -> unit) : TestsStreamonce(event: "test:coverage", listener: (data: EventData.TestCoverage) => void): this
abstract member onceTestDequeue (listener: TestDequeue -> unit) : TestsStream
abstract member onceTestDequeue (listener: TestDequeue -> unit) : TestsStreamonce(event: "test:dequeue", listener: (data: EventData.TestDequeue) => void): this
abstract member onceTestDiagnostic (listener: TestDiagnostic -> unit) : TestsStream
abstract member onceTestDiagnostic (listener: TestDiagnostic -> unit) : TestsStreamonce(event: "test:diagnostic", listener: (data: EventData.TestDiagnostic) => void): this
abstract member onceTestEnqueue (listener: TestEnqueue -> unit) : TestsStream
abstract member onceTestEnqueue (listener: TestEnqueue -> unit) : TestsStreamonce(event: "test:enqueue", listener: (data: EventData.TestEnqueue) => void): this
abstract member onceTestFail (listener: TestFail -> unit) : TestsStream
abstract member onceTestFail (listener: TestFail -> unit) : TestsStreamonce(event: "test:fail", listener: (data: EventData.TestFail) => void): this
abstract member onceTestPass (listener: TestPass -> unit) : TestsStream
abstract member onceTestPass (listener: TestPass -> unit) : TestsStreamonce(event: "test:pass", listener: (data: EventData.TestPass) => void): this
abstract member onceTestPlan (listener: TestPlan -> unit) : TestsStream
abstract member onceTestPlan (listener: TestPlan -> unit) : TestsStreamonce(event: "test:plan", listener: (data: EventData.TestPlan) => void): this
abstract member onceTestStart (listener: TestStart -> unit) : TestsStream
abstract member onceTestStart (listener: TestStart -> unit) : TestsStreamonce(event: "test:start", listener: (data: EventData.TestStart) => void): this
abstract member onceTestStderr (listener: TestStderr -> unit) : TestsStream
abstract member onceTestStderr (listener: TestStderr -> unit) : TestsStreamonce(event: "test:stderr", listener: (data: EventData.TestStderr) => void): this
abstract member onceTestStdout (listener: TestStdout -> unit) : TestsStream
abstract member onceTestStdout (listener: TestStdout -> unit) : TestsStreamonce(event: "test:stdout", listener: (data: EventData.TestStdout) => void): this
abstract member onceTestSummary (listener: TestSummary -> unit) : TestsStream
abstract member onceTestSummary (listener: TestSummary -> unit) : TestsStreamonce(event: "test:summary", listener: (data: EventData.TestSummary) => void): this
abstract member onceTestWatchDrained (listener: unit -> unit) : TestsStream
abstract member onceTestWatchDrained (listener: unit -> unit) : TestsStreamonce(event: "test:watch:drained", listener: () => void): this
abstract member pause () : TestsStream
abstract member pause () : TestsStreamThe readable.pause() method will cause a stream in flowing mode to stop emitting 'data' events, switching out of flowing mode. Any data that becomes available will remain in the internal buffer.
const readable = getReadableStreamSomehow();
readable.on('data', (chunk) => {
console.log(`Received ${chunk.length} bytes of data.`);
readable.pause();
console.log('There will be no additional data for 1 second.');
setTimeout(() => {
console.log('Now data will start flowing again.');
readable.resume();
}, 1000);
});
The readable.pause() method has no effect if there is a 'readable' event listener.
@since v0.9.4
abstract member prependListener (event: string, listener: obj array -> unit) : TestsStream
abstract member prependListener (event: string, listener: obj array -> unit) : TestsStreamAdds 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.
abstract member prependListenerTestComplete (listener: TestComplete -> unit) : TestsStream
abstract member prependListenerTestComplete (listener: TestComplete -> unit) : TestsStreamprependListener(event: "test:complete", listener: (data: EventData.TestComplete) => void): this
abstract member prependListenerTestCoverage (listener: TestCoverage -> unit) : TestsStream
abstract member prependListenerTestCoverage (listener: TestCoverage -> unit) : TestsStreamprependListener(event: "test:coverage", listener: (data: EventData.TestCoverage) => void): this
abstract member prependListenerTestDequeue (listener: TestDequeue -> unit) : TestsStream
abstract member prependListenerTestDequeue (listener: TestDequeue -> unit) : TestsStreamprependListener(event: "test:dequeue", listener: (data: EventData.TestDequeue) => void): this
abstract member prependListenerTestDiagnostic (listener: TestDiagnostic -> unit) : TestsStream
abstract member prependListenerTestDiagnostic (listener: TestDiagnostic -> unit) : TestsStreamprependListener(event: "test:diagnostic", listener: (data: EventData.TestDiagnostic) => void): this
abstract member prependListenerTestEnqueue (listener: TestEnqueue -> unit) : TestsStream
abstract member prependListenerTestEnqueue (listener: TestEnqueue -> unit) : TestsStreamprependListener(event: "test:enqueue", listener: (data: EventData.TestEnqueue) => void): this
abstract member prependListenerTestFail (listener: TestFail -> unit) : TestsStream
abstract member prependListenerTestFail (listener: TestFail -> unit) : TestsStreamprependListener(event: "test:fail", listener: (data: EventData.TestFail) => void): this
abstract member prependListenerTestPass (listener: TestPass -> unit) : TestsStream
abstract member prependListenerTestPass (listener: TestPass -> unit) : TestsStreamprependListener(event: "test:pass", listener: (data: EventData.TestPass) => void): this
abstract member prependListenerTestPlan (listener: TestPlan -> unit) : TestsStream
abstract member prependListenerTestPlan (listener: TestPlan -> unit) : TestsStreamprependListener(event: "test:plan", listener: (data: EventData.TestPlan) => void): this
abstract member prependListenerTestStart (listener: TestStart -> unit) : TestsStream
abstract member prependListenerTestStart (listener: TestStart -> unit) : TestsStreamprependListener(event: "test:start", listener: (data: EventData.TestStart) => void): this
abstract member prependListenerTestStderr (listener: TestStderr -> unit) : TestsStream
abstract member prependListenerTestStderr (listener: TestStderr -> unit) : TestsStreamprependListener(event: "test:stderr", listener: (data: EventData.TestStderr) => void): this
abstract member prependListenerTestStdout (listener: TestStdout -> unit) : TestsStream
abstract member prependListenerTestStdout (listener: TestStdout -> unit) : TestsStreamprependListener(event: "test:stdout", listener: (data: EventData.TestStdout) => void): this
abstract member prependListenerTestSummary (listener: TestSummary -> unit) : TestsStream
abstract member prependListenerTestSummary (listener: TestSummary -> unit) : TestsStreamprependListener(event: "test:summary", listener: (data: EventData.TestSummary) => void): this
abstract member prependListenerTestWatchDrained (listener: unit -> unit) : TestsStream
abstract member prependListenerTestWatchDrained (listener: unit -> unit) : TestsStreamprependListener(event: "test:watch:drained", listener: () => void): this
abstract member prependOnceListener (event: string, listener: obj array -> unit) : TestsStream
abstract member prependOnceListener (event: string, listener: obj array -> unit) : TestsStreamAdds a one-timelistener 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.
abstract member prependOnceListenerTestComplete (listener: TestComplete -> unit) : TestsStream
abstract member prependOnceListenerTestComplete (listener: TestComplete -> unit) : TestsStreamprependOnceListener(event: "test:complete", listener: (data: EventData.TestComplete) => void): this
abstract member prependOnceListenerTestCoverage (listener: TestCoverage -> unit) : TestsStream
abstract member prependOnceListenerTestCoverage (listener: TestCoverage -> unit) : TestsStreamprependOnceListener(event: "test:coverage", listener: (data: EventData.TestCoverage) => void): this
abstract member prependOnceListenerTestDequeue (listener: TestDequeue -> unit) : TestsStream
abstract member prependOnceListenerTestDequeue (listener: TestDequeue -> unit) : TestsStreamprependOnceListener(event: "test:dequeue", listener: (data: EventData.TestDequeue) => void): this
abstract member prependOnceListenerTestDiagnostic (listener: TestDiagnostic -> unit) : TestsStream
abstract member prependOnceListenerTestDiagnostic (listener: TestDiagnostic -> unit) : TestsStreamprependOnceListener(event: "test:diagnostic", listener: (data: EventData.TestDiagnostic) => void): this
abstract member prependOnceListenerTestEnqueue (listener: TestEnqueue -> unit) : TestsStream
abstract member prependOnceListenerTestEnqueue (listener: TestEnqueue -> unit) : TestsStreamprependOnceListener(event: "test:enqueue", listener: (data: EventData.TestEnqueue) => void): this
abstract member prependOnceListenerTestFail (listener: TestFail -> unit) : TestsStream
abstract member prependOnceListenerTestFail (listener: TestFail -> unit) : TestsStreamprependOnceListener(event: "test:fail", listener: (data: EventData.TestFail) => void): this
abstract member prependOnceListenerTestPass (listener: TestPass -> unit) : TestsStream
abstract member prependOnceListenerTestPass (listener: TestPass -> unit) : TestsStreamprependOnceListener(event: "test:pass", listener: (data: EventData.TestPass) => void): this
abstract member prependOnceListenerTestPlan (listener: TestPlan -> unit) : TestsStream
abstract member prependOnceListenerTestPlan (listener: TestPlan -> unit) : TestsStreamprependOnceListener(event: "test:plan", listener: (data: EventData.TestPlan) => void): this
abstract member prependOnceListenerTestStart (listener: TestStart -> unit) : TestsStream
abstract member prependOnceListenerTestStart (listener: TestStart -> unit) : TestsStreamprependOnceListener(event: "test:start", listener: (data: EventData.TestStart) => void): this
abstract member prependOnceListenerTestStderr (listener: TestStderr -> unit) : TestsStream
abstract member prependOnceListenerTestStderr (listener: TestStderr -> unit) : TestsStreamprependOnceListener(event: "test:stderr", listener: (data: EventData.TestStderr) => void): this
abstract member prependOnceListenerTestStdout (listener: TestStdout -> unit) : TestsStream
abstract member prependOnceListenerTestStdout (listener: TestStdout -> unit) : TestsStreamprependOnceListener(event: "test:stdout", listener: (data: EventData.TestStdout) => void): this
abstract member prependOnceListenerTestSummary (listener: TestSummary -> unit) : TestsStream
abstract member prependOnceListenerTestSummary (listener: TestSummary -> unit) : TestsStreamprependOnceListener(event: "test:summary", listener: (data: EventData.TestSummary) => void): this
abstract member prependOnceListenerTestWatchDrained (listener: unit -> unit) : TestsStream
abstract member prependOnceListenerTestWatchDrained (listener: unit -> unit) : TestsStreamprependOnceListener(event: "test:watch:drained", listener: () => void): this
abstract member removeAllListeners (?eventName: U2<string,Symbol>) : TestsStream
abstract member removeAllListeners (?eventName: U2<string,Symbol>) : TestsStreamRemoves all listeners, or those of the specified eventName.
It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).
Returns a reference to the EventEmitter, so that calls can be chained.
@since v0.1.26
abstract member removeListener (event: U2<string,Symbol>, listener: obj array -> unit) : TestsStream
abstract member removeListener (event: U2<string,Symbol>, listener: obj array -> unit) : TestsStreamRemoves the specified listener from the listener array for the event named eventName.
const callback = (stream) => {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);
removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.
Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them fromemit() in progress. Subsequent events behave as expected.
import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
const callbackA = () => {
console.log('A');
myEmitter.removeListener('event', callbackB);
};
const callbackB = () => {
console.log('B');
};
myEmitter.on('event', callbackA);
myEmitter.on('event', callbackB);
// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
// A
// B
// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
// A
Because listeners are managed using an internal array, calling this will change the position indices of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.
When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping') listener is removed:
import { EventEmitter } from 'node:events';
const ee = new EventEmitter();
function pong() {
console.log('pong');
}
ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);
ee.emit('ping');
ee.emit('ping');
Returns a reference to the EventEmitter, so that calls can be chained.
abstract member removeListenerClose (listener: unit -> unit) : TestsStream
abstract member removeListenerClose (listener: unit -> unit) : TestsStreamremoveListener(event: "close", listener: () => void): this
abstract member removeListenerData (listener: obj -> unit) : TestsStream
abstract member removeListenerData (listener: obj -> unit) : TestsStreamremoveListener(event: "data", listener: (chunk: any) => void): this
abstract member removeListenerEnd (listener: unit -> unit) : TestsStream
abstract member removeListenerEnd (listener: unit -> unit) : TestsStreamremoveListener(event: "end", listener: () => void): this
abstract member removeListenerError (listener: exn -> unit) : TestsStream
abstract member removeListenerError (listener: exn -> unit) : TestsStreamremoveListener(event: "error", listener: (err: Error) => void): this
abstract member removeListenerPause (listener: unit -> unit) : TestsStream
abstract member removeListenerPause (listener: unit -> unit) : TestsStreamremoveListener(event: "pause", listener: () => void): this
abstract member removeListenerReadable (listener: unit -> unit) : TestsStream
abstract member removeListenerReadable (listener: unit -> unit) : TestsStreamremoveListener(event: "readable", listener: () => void): this
abstract member removeListenerResume (listener: unit -> unit) : TestsStream
abstract member removeListenerResume (listener: unit -> unit) : TestsStreamremoveListener(event: "resume", listener: () => void): this
abstract member resume () : TestsStream
abstract member resume () : TestsStreamThe readable.resume() method causes an explicitly paused Readable stream to resume emitting 'data' events, switching the stream into flowing mode.
The readable.resume() method can be used to fully consume the data from a stream without actually processing any of that data:
getReadableStreamSomehow()
.resume()
.on('end', () => {
console.log('Reached the end, but did not read anything.');
});
The readable.resume() method has no effect if there is a 'readable' event listener.
@since v0.9.4
abstract member setEncoding (encoding: BufferEncoding) : TestsStream
abstract member setEncoding (encoding: BufferEncoding) : TestsStreamThe readable.setEncoding() method sets the character encoding for data read from the Readable stream.
By default, no encoding is assigned and stream data will be returned as Buffer objects. Setting an encoding causes the stream data to be returned as strings of the specified encoding rather than as Buffer objects. For instance, calling readable.setEncoding('utf8') will cause the output data to be interpreted as UTF-8 data, and passed as strings. Calling readable.setEncoding('hex') will cause the data to be encoded in hexadecimal string format.
The Readable stream will properly handle multi-byte characters delivered through the stream that would otherwise become improperly decoded if simply pulled from the stream as Buffer objects.
const readable = getReadableStreamSomehow();
readable.setEncoding('utf8');
readable.on('data', (chunk) => {
assert.equal(typeof chunk, 'string');
console.log('Got %d characters of string data:', chunk.length);
});
@since v0.9.4
| Parameter | |
|---|---|
encoding | The encoding to use. |
abstract member setMaxListeners (n: float) : TestsStream
abstract member setMaxListeners (n: float) : TestsStreamBy 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.
@since v0.3.5
abstract member unpipe (?destination: WritableStream) : TestsStream
abstract member unpipe (?destination: WritableStream) : TestsStreamThe readable.unpipe() method detaches a Writable stream previously attached using the pipe method.
If the destination is not specified, then all pipes are detached.
If the destination is specified, but no pipe is set up for it, then the method does nothing.
import fs from 'node:fs';
const readable = getReadableStreamSomehow();
const writable = fs.createWriteStream('file.txt');
// All the data from readable goes into 'file.txt',
// but only for the first second.
readable.pipe(writable);
setTimeout(() => {
console.log('Stop writing to file.txt.');
readable.unpipe(writable);
console.log('Manually close the file stream.');
writable.end();
}, 1000);
@since v0.9.4
| Parameter | |
|---|---|
destination | Optional specific stream to unpipe |
abstract member wrap (stream: ReadableStream) : TestsStream
abstract member wrap (stream: ReadableStream) : TestsStreamPrior to Node.js 0.10, streams did not implement the entire node:stream module API as it is currently defined. (See Compatibility for more information.)
When using an older Node.js library that emits 'data' events and has a pause method that is advisory only, the readable.wrap() method can be used to create a Readable stream that uses the old stream as its data source.
It will rarely be necessary to use readable.wrap() but the method has been provided as a convenience for interacting with older Node.js applications and libraries.
import { OldReader } from './old-api-module.js';
import { Readable } from 'node:stream';
const oreader = new OldReader();
const myReader = new Readable().wrap(oreader);
myReader.on('readable', () => {
myReader.read(); // etc.
});
@since v0.9.4
| Parameter | |
|---|---|
stream | An "old style" readable stream |