Skip to content

Commit ec0a6c1

Browse files
atlowChemitargos
authored andcommitted
doc: add new reporter events to custom reporter examples
Fixes: #48894 PR-URL: #48903 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent e8a32fb commit ec0a6c1

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

doc/api/test.md

+44
Original file line numberDiff line numberDiff line change
@@ -672,6 +672,15 @@ const customReporter = new Transform({
672672
writableObjectMode: true,
673673
transform(event, encoding, callback) {
674674
switch (event.type) {
675+
case 'test:dequeue':
676+
callback(null, `test ${event.data.name} dequeued`);
677+
break;
678+
case 'test:enqueue':
679+
callback(null, `test ${event.data.name} enqueued`);
680+
break;
681+
case 'test:watch:drained':
682+
callback(null, 'test watch queue drained');
683+
break;
675684
case 'test:start':
676685
callback(null, `test ${event.data.name} started`);
677686
break;
@@ -685,6 +694,8 @@ const customReporter = new Transform({
685694
callback(null, 'test plan');
686695
break;
687696
case 'test:diagnostic':
697+
case 'test:stderr':
698+
case 'test:stdout':
688699
callback(null, event.data.message);
689700
break;
690701
case 'test:coverage': {
@@ -706,6 +717,15 @@ const customReporter = new Transform({
706717
writableObjectMode: true,
707718
transform(event, encoding, callback) {
708719
switch (event.type) {
720+
case 'test:dequeue':
721+
callback(null, `test ${event.data.name} dequeued`);
722+
break;
723+
case 'test:enqueue':
724+
callback(null, `test ${event.data.name} enqueued`);
725+
break;
726+
case 'test:watch:drained':
727+
callback(null, 'test watch queue drained');
728+
break;
709729
case 'test:start':
710730
callback(null, `test ${event.data.name} started`);
711731
break;
@@ -719,6 +739,8 @@ const customReporter = new Transform({
719739
callback(null, 'test plan');
720740
break;
721741
case 'test:diagnostic':
742+
case 'test:stderr':
743+
case 'test:stdout':
722744
callback(null, event.data.message);
723745
break;
724746
case 'test:coverage': {
@@ -739,6 +761,15 @@ Example of a custom reporter using a generator function:
739761
export default async function * customReporter(source) {
740762
for await (const event of source) {
741763
switch (event.type) {
764+
case 'test:dequeue':
765+
yield `test ${event.data.name} dequeued`;
766+
break;
767+
case 'test:enqueue':
768+
yield `test ${event.data.name} enqueued`;
769+
break;
770+
case 'test:watch:drained':
771+
yield 'test watch queue drained';
772+
break;
742773
case 'test:start':
743774
yield `test ${event.data.name} started\n`;
744775
break;
@@ -752,6 +783,8 @@ export default async function * customReporter(source) {
752783
yield 'test plan';
753784
break;
754785
case 'test:diagnostic':
786+
case 'test:stderr':
787+
case 'test:stdout':
755788
yield `${event.data.message}\n`;
756789
break;
757790
case 'test:coverage': {
@@ -768,6 +801,15 @@ export default async function * customReporter(source) {
768801
module.exports = async function * customReporter(source) {
769802
for await (const event of source) {
770803
switch (event.type) {
804+
case 'test:dequeue':
805+
yield `test ${event.data.name} dequeued`;
806+
break;
807+
case 'test:enqueue':
808+
yield `test ${event.data.name} enqueued`;
809+
break;
810+
case 'test:watch:drained':
811+
yield 'test watch queue drained';
812+
break;
771813
case 'test:start':
772814
yield `test ${event.data.name} started\n`;
773815
break;
@@ -781,6 +823,8 @@ module.exports = async function * customReporter(source) {
781823
yield 'test plan\n';
782824
break;
783825
case 'test:diagnostic':
826+
case 'test:stderr':
827+
case 'test:stdout':
784828
yield `${event.data.message}\n`;
785829
break;
786830
case 'test:coverage': {

0 commit comments

Comments
 (0)