Skip to content

Commit 4b3d964

Browse files
committed
doc: add new reporter events to custom reporter examples
Fixes: #48894
1 parent b361ad7 commit 4b3d964

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
@@ -664,6 +664,15 @@ const customReporter = new Transform({
664664
writableObjectMode: true,
665665
transform(event, encoding, callback) {
666666
switch (event.type) {
667+
case 'test:dequeue':
668+
callback(null, `test ${event.data.name} dequeued`);
669+
break;
670+
case 'test:enqueue':
671+
callback(null, `test ${event.data.name} enqueued`);
672+
break;
673+
case 'test:watch:drained':
674+
callback(null, 'test watch queue drained');
675+
break;
667676
case 'test:start':
668677
callback(null, `test ${event.data.name} started`);
669678
break;
@@ -677,6 +686,8 @@ const customReporter = new Transform({
677686
callback(null, 'test plan');
678687
break;
679688
case 'test:diagnostic':
689+
case 'test:stderr':
690+
case 'test:stdout':
680691
callback(null, event.data.message);
681692
break;
682693
case 'test:coverage': {
@@ -698,6 +709,15 @@ const customReporter = new Transform({
698709
writableObjectMode: true,
699710
transform(event, encoding, callback) {
700711
switch (event.type) {
712+
case 'test:dequeue':
713+
callback(null, `test ${event.data.name} dequeued`);
714+
break;
715+
case 'test:enqueue':
716+
callback(null, `test ${event.data.name} enqueued`);
717+
break;
718+
case 'test:watch:drained':
719+
callback(null, 'test watch queue drained');
720+
break;
701721
case 'test:start':
702722
callback(null, `test ${event.data.name} started`);
703723
break;
@@ -711,6 +731,8 @@ const customReporter = new Transform({
711731
callback(null, 'test plan');
712732
break;
713733
case 'test:diagnostic':
734+
case 'test:stderr':
735+
case 'test:stdout':
714736
callback(null, event.data.message);
715737
break;
716738
case 'test:coverage': {
@@ -731,6 +753,15 @@ Example of a custom reporter using a generator function:
731753
export default async function * customReporter(source) {
732754
for await (const event of source) {
733755
switch (event.type) {
756+
case 'test:dequeue':
757+
yield `test ${event.data.name} dequeued`;
758+
break;
759+
case 'test:enqueue':
760+
yield `test ${event.data.name} enqueued`;
761+
break;
762+
case 'test:watch:drained':
763+
yield 'test watch queue drained';
764+
break;
734765
case 'test:start':
735766
yield `test ${event.data.name} started\n`;
736767
break;
@@ -744,6 +775,8 @@ export default async function * customReporter(source) {
744775
yield 'test plan';
745776
break;
746777
case 'test:diagnostic':
778+
case 'test:stderr':
779+
case 'test:stdout':
747780
yield `${event.data.message}\n`;
748781
break;
749782
case 'test:coverage': {
@@ -760,6 +793,15 @@ export default async function * customReporter(source) {
760793
module.exports = async function * customReporter(source) {
761794
for await (const event of source) {
762795
switch (event.type) {
796+
case 'test:dequeue':
797+
yield `test ${event.data.name} dequeued`;
798+
break;
799+
case 'test:enqueue':
800+
yield `test ${event.data.name} enqueued`;
801+
break;
802+
case 'test:watch:drained':
803+
yield 'test watch queue drained';
804+
break;
763805
case 'test:start':
764806
yield `test ${event.data.name} started\n`;
765807
break;
@@ -773,6 +815,8 @@ module.exports = async function * customReporter(source) {
773815
yield 'test plan\n';
774816
break;
775817
case 'test:diagnostic':
818+
case 'test:stderr':
819+
case 'test:stdout':
776820
yield `${event.data.message}\n`;
777821
break;
778822
case 'test:coverage': {

0 commit comments

Comments
 (0)