Skip to main content

print-type-events

Print type event constants.

Events emitted during the printing phase of type documentation generation. These events allow interception and modification of the generated code output.

PrintTypeEvents​

const PrintTypeEvents: object;

Defined in: events/print-type-events.ts:24

Event names for printing type documentation.

Type Declaration​

AFTER_PRINT_CODE​

readonly AFTER_PRINT_CODE: "print:afterPrintCode" = "print:afterPrintCode";

Emitted after generating the code block for a type (output can be modified)

AFTER_PRINT_TYPE​

readonly AFTER_PRINT_TYPE: "print:afterPrintType" = "print:afterPrintType";

Emitted after generating the full type documentation (output can be modified)

BEFORE_PRINT_CODE​

readonly BEFORE_PRINT_CODE: "print:beforePrintCode" = "print:beforePrintCode";

Emitted before generating the code block for a type

BEFORE_PRINT_TYPE​

readonly BEFORE_PRINT_TYPE: "print:beforePrintType" = "print:beforePrintType";

Emitted before generating the full type documentation

Example​

import {
  getEvents,
  PrintTypeEvents,
  PrintTypeEvent,
} from "@graphql-markdown/core";

const events = getEvents();
events.on(PrintTypeEvents.AFTER_PRINT_CODE, (event: PrintTypeEvent) => {
  // Modify the generated code
  event.output = event.output.toUpperCase();
});