Skip to main content

options

SectionLevels​

Defined in: printer-legacy/src/const/options.ts:32

Enumeration Members​

LEVEL​

LEVEL: "#";

Defined in: printer-legacy/src/const/options.ts:38

NONE​

NONE: "";

Defined in: printer-legacy/src/const/options.ts:37

Deprecated​

Use SectionLevels.LEVEL instead.

TypeHierarchy​

Defined in: printer-legacy/src/const/options.ts:23

Enumeration Members​

API​

API: "api";

Defined in: printer-legacy/src/const/options.ts:24

ENTITY​

ENTITY: "entity";

Defined in: printer-legacy/src/const/options.ts:28

FLAT​

FLAT: "flat";

Defined in: printer-legacy/src/const/options.ts:29

DEFAULT_OPTIONS​

const DEFAULT_OPTIONS: Required<
  Omit<
    PrintTypeOptions,
    | "afterDiffCheckHook"
    | "afterGenerateIndexMetafileHook"
    | "afterRenderHomepageHook"
    | "afterRenderRootTypesHook"
    | "afterRenderTypeEntitiesHook"
    | "afterSchemaLoadHook"
    | "beforeDiffCheckHook"
    | "beforeGenerateIndexMetafileHook"
    | "beforeRenderHomepageHook"
    | "beforeRenderRootTypesHook"
    | "beforeRenderTypeEntitiesHook"
    | "beforeSchemaLoadHook"
    | "collapsible"
    | "exampleSection"
    | "formatCategoryFolderName"
    | "groups"
    | "level"
    | "meta"
    | "onlyDocDirectives"
    | "parentType"
    | "schema"
    | "skipDocDirectives"
  >
> &
  object;

Defined in: printer-legacy/src/const/options.ts:57

Clean runtime options passed through the printer.

Type Declaration​

collapsible​

collapsible: Maybe<CollapsibleOption>;

exampleSection​

exampleSection: PrintTypeOptions["exampleSection"];

groups​

groups: Maybe<SchemaEntitiesGroupMap>;

level​

level: Maybe<SectionLevelValue>;

onlyDocDirectives​

onlyDocDirectives: GraphQLDirective[];

parentType​

parentType: Maybe<string>;

schema​

schema: Maybe<GraphQLSchema>;

skipDocDirectives​

skipDocDirectives: GraphQLDirective[];
const PRINT_TYPE_DEFAULT_OPTIONS: Required<
  Omit<PrinterConfigPrintTypeOptions, "exampleSection">
> &
  object;

Defined in: printer-legacy/src/const/options.ts:41

Type Declaration​

exampleSection​

exampleSection: PrintTypeOptions["exampleSection"];