Skip to content

Commit 5173c55

Browse files
atlowChemiRafaelGSS
authored andcommitted
doc: add new reporter events to custom reporter examples
Fixes: #48894 PR-URL: #48903 Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
1 parent c14ff69 commit 5173c55

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
@@ -687,6 +687,15 @@ const customReporter = new Transform({
687687
writableObjectMode: true,
688688
transform(event, encoding, callback) {
689689
switch (event.type) {
690+
case 'test:dequeue':
691+
callback(null, `test ${event.data.name} dequeued`);
692+
break;
693+
case 'test:enqueue':
694+
callback(null, `test ${event.data.name} enqueued`);
695+
break;
696+
case 'test:watch:drained':
697+
callback(null, 'test watch queue drained');
698+
break;
690699
case 'test:start':
691700
callback(null, `test ${event.data.name} started`);
692701
break;
@@ -700,6 +709,8 @@ const customReporter = new Transform({
700709
callback(null, 'test plan');
701710
break;
702711
case 'test:diagnostic':
712+
case 'test:stderr':
713+
case 'test:stdout':
703714
callback(null, event.data.message);
704715
break;
705716
case 'test:coverage': {
@@ -721,6 +732,15 @@ const customReporter = new Transform({
721732
writableObjectMode: true,
722733
transform(event, encoding, callback) {
723734
switch (event.type) {
735+
case 'test:dequeue':
736+
callback(null, `test ${event.data.name} dequeued`);
737+
break;
738+
case 'test:enqueue':
739+
callback(null, `test ${event.data.name} enqueued`);
740+
break;
741+
case 'test:watch:drained':
742+
callback(null, 'test watch queue drained');
743+
break;
724744
case 'test:start':
725745
callback(null, `test ${event.data.name} started`);
726746
break;
@@ -734,6 +754,8 @@ const customReporter = new Transform({
734754
callback(null, 'test plan');
735755
break;
736756
case 'test:diagnostic':
757+
case 'test:stderr':
758+
case 'test:stdout':
737759
callback(null, event.data.message);
738760
break;
739761
case 'test:coverage': {
@@ -754,6 +776,15 @@ Example of a custom reporter using a generator function:
754776
export default async function * customReporter(source) {
755777
for await (const event of source) {
756778
switch (event.type) {
779+
case 'test:dequeue':
780+
yield `test ${event.data.name} dequeued`;
781+
break;
782+
case 'test:enqueue':
783+
yield `test ${event.data.name} enqueued`;
784+
break;
785+
case 'test:watch:drained':
786+
yield 'test watch queue drained';
787+
break;
757788
case 'test:start':
758789
yield `test ${event.data.name} started\n`;
759790
break;
@@ -767,6 +798,8 @@ export default async function * customReporter(source) {
767798
yield 'test plan';
768799
break;
769800
case 'test:diagnostic':
801+
case 'test:stderr':
802+
case 'test:stdout':
770803
yield `${event.data.message}\n`;
771804
break;
772805
case 'test:coverage': {
@@ -783,6 +816,15 @@ export default async function * customReporter(source) {
783816
module.exports = async function * customReporter(source) {
784817
for await (const event of source) {
785818
switch (event.type) {
819+
case 'test:dequeue':
820+
yield `test ${event.data.name} dequeued`;
821+
break;
822+
case 'test:enqueue':
823+
yield `test ${event.data.name} enqueued`;
824+
break;
825+
case 'test:watch:drained':
826+
yield 'test watch queue drained';
827+
break;
786828
case 'test:start':
787829
yield `test ${event.data.name} started\n`;
788830
break;
@@ -796,6 +838,8 @@ module.exports = async function * customReporter(source) {
796838
yield 'test plan\n';
797839
break;
798840
case 'test:diagnostic':
841+
case 'test:stderr':
842+
case 'test:stdout':
799843
yield `${event.data.message}\n`;
800844
break;
801845
case 'test:coverage': {

0 commit comments

Comments
 (0)