Skip to main content

config

DeprecatedOption​

Enumeration Members​

DEFAULT​

DEFAULT: "default";
Defined in​

config.ts:43

GROUP​

GROUP: "group";
Defined in​

config.ts:44

SKIP​

SKIP: "skip";
Defined in​

config.ts:45

DiffMethod​

Enumeration Members​

FORCE​

FORCE: "FORCE";
Defined in​

config.ts:39

NONE​

NONE: "NONE";
Defined in​

config.ts:38

TypeHierarchy​

Enumeration Members​

API​

API: "api";
Defined in​

config.ts:32

ENTITY​

ENTITY: "entity";
Defined in​

config.ts:33

FLAT​

FLAT: "flat";
Defined in​

config.ts:34

ASSET_HOMEPAGE_LOCATION​

const ASSET_HOMEPAGE_LOCATION: string;

Defined in​

config.ts:50

DEFAULT_OPTIONS​

const DEFAULT_OPTIONS: Readonly<Pick<ConfigOptions, "customDirective" | "groupByDirective" | "loaders"> & Required<Omit<ConfigOptions, "customDirective" | "groupByDirective" | "loaders" | "printTypeOptions">>> & object;

Type declaration​

printTypeOptions​

printTypeOptions: Required<Omit<ConfigPrintTypeOptions, "hierarchy">> & object;
Type declaration​
hierarchy​
hierarchy: Required<Pick<TypeHierarchyObjectType, API>>;

Defined in​

config.ts:57

DOCS_URL​

const DOCS_URL: "https://graphql-markdown.dev/docs";

Defined in​

config.ts:48

PACKAGE_NAME​

const PACKAGE_NAME: "@graphql-markdown/docusaurus";

Defined in​

config.ts:49

buildConfig()​

function buildConfig(
   configFileOpts, 
   cliOpts?, 
id?): Promise<Options>

Parameters​

• configFileOpts: Maybe<ConfigOptions>

• cliOpts?: Maybe<CliOptions>

• id?: Maybe<string> = "default"

Returns​

Promise<Options>

Defined in​

config.ts:437

getCustomDirectives()​

function getCustomDirectives(customDirectiveOptions, skipDocDirective?): Maybe<CustomDirective>

Parameters​

• customDirectiveOptions: Maybe<CustomDirective>

• skipDocDirective?: Maybe<DirectiveName[]>

Returns​

Maybe<CustomDirective>

Defined in​

config.ts:192

getDiffMethod()​

function getDiffMethod(diff, force): TypeDiffMethod

Parameters​

• diff: TypeDiffMethod

• force: boolean = false

Returns​

TypeDiffMethod

Defined in​

config.ts:225

getDocDirective()​

function getDocDirective(name): DirectiveName

Parameters​

• name: Maybe<DirectiveName>

Returns​

DirectiveName

Defined in​

config.ts:108

getDocOptions()​

function getDocOptions(cliOpts?, configOptions?): Required<ConfigDocOptions>

Parameters​

• cliOpts?: Maybe<CliOptions & DeprecatedCliOptions>

• configOptions?: Maybe<ConfigDocOptions & DeprecatedConfigDocOptions>

Returns​

Required<ConfigDocOptions>

Defined in​

config.ts:275

getOnlyDocDirectives()​

function getOnlyDocDirectives(cliOpts, configFileOpts): DirectiveName[]

Parameters​

• cliOpts: Maybe<CliOptions>

• configFileOpts: Maybe<Pick<ConfigOptions, "onlyDocDirective">>

Returns​

DirectiveName[]

Defined in​

config.ts:124

getPrintTypeOptions()​

function getPrintTypeOptions(cliOpts, configOptions): Required<ConfigPrintTypeOptions>

Parameters​

• cliOpts: Maybe<CliOptions & DeprecatedCliOptions>

• configOptions: Maybe<ConfigPrintTypeOptions & DeprecatedConfigPrintTypeOptions>

Returns​

Required<ConfigPrintTypeOptions>

Defined in​

config.ts:372

getSkipDocDirectives()​

function getSkipDocDirectives(cliOpts, configFileOpts): DirectiveName[]

Parameters​

• cliOpts: Maybe<CliOptions>

• configFileOpts: Maybe<Pick<ConfigOptions, "printTypeOptions" | "skipDocDirective">>

Returns​

DirectiveName[]

Defined in​

config.ts:140

getTypeHierarchyOption()​

function getTypeHierarchyOption(cliOption?, configOption?): Maybe<Partial<Record<TypeHierarchyValueType, TypeHierarchyTypeOptions>>>

Parameters​

• cliOption?: Maybe<TypeHierarchyValueType>

• configOption?: Maybe<TypeHierarchyType>

Returns​

Maybe<Partial<Record<TypeHierarchyValueType, TypeHierarchyTypeOptions>>>

Defined in​

config.ts:292

getVisibilityDirectives()​

function getVisibilityDirectives(cliOpts, configFileOpts): object

Parameters​

• cliOpts: Maybe<CliOptions>

• configFileOpts: Maybe<Pick<ConfigOptions, "printTypeOptions" | "skipDocDirective" | "onlyDocDirective">>

Returns​

object

onlyDocDirective​

onlyDocDirective: DirectiveName[];

skipDocDirective​

skipDocDirective: DirectiveName[];

Defined in​

config.ts:167

parseDeprecatedDocOptions()​

function parseDeprecatedDocOptions(cliOpts, configOptions): Partial<object>

Parameters​

• cliOpts: Maybe<DeprecatedCliOptions>

• configOptions: Maybe<DeprecatedConfigDocOptions>

Returns​

Partial<object>

hide_table_of_contents​

hide_table_of_contents: boolean;

pagination_next​

pagination_next: null;

pagination_prev​

pagination_prev: null;

Defined in​

config.ts:234

parseDeprecatedPrintTypeOptions()​

function parseDeprecatedPrintTypeOptions(cliOpts, configOptions): Partial<object>

Parameters​

• cliOpts: Maybe<DeprecatedCliOptions>

• configOptions: Maybe<DeprecatedConfigPrintTypeOptions>

Returns​

Partial<object>

hierarchy​

hierarchy: TypeHierarchyType;

Defined in​

config.ts:340

parseGroupByOption()​

function parseGroupByOption(groupOptions): Maybe<GroupByDirectiveOptions>

Parameters​

• groupOptions: unknown

Returns​

Maybe<GroupByDirectiveOptions>

Defined in​

config.ts:408