config
DeprecatedOption
Defined in: packages/core/src/config.ts:40
Enumeration Members
DEFAULT
DEFAULT: "default";
Defined in: packages/core/src/config.ts:41
GROUP
GROUP: "group";
Defined in: packages/core/src/config.ts:42
SKIP
SKIP: "skip";
Defined in: packages/core/src/config.ts:43
DiffMethod
Defined in: packages/core/src/config.ts:35
Enumeration Members
FORCE
FORCE: "FORCE";
Defined in: packages/core/src/config.ts:37
NONE
NONE: "NONE";
Defined in: packages/core/src/config.ts:36
TypeHierarchy
Defined in: packages/core/src/config.ts:29
Enumeration Members
API
API: "api";
Defined in: packages/core/src/config.ts:30
ENTITY
ENTITY: "entity";
Defined in: packages/core/src/config.ts:31
FLAT
FLAT: "flat";
Defined in: packages/core/src/config.ts:32
ASSET_HOMEPAGE_LOCATION
const ASSET_HOMEPAGE_LOCATION: string;
Defined in: packages/core/src/config.ts:48
DEFAULT_HIERARCHY
const DEFAULT_HIERARCHY: object;
Defined in: packages/core/src/config.ts:55
Type declaration
api
api: object = {};
DEFAULT_OPTIONS
const DEFAULT_OPTIONS: Readonly<Pick<ConfigOptions, "customDirective" | "groupByDirective" | "loaders"> & Required<Omit<ConfigOptions, "customDirective" | "groupByDirective" | "loaders" | "printTypeOptions">>> & object;
Defined in: packages/core/src/config.ts:57
Type declaration
printTypeOptions
printTypeOptions: Required<Omit<ConfigPrintTypeOptions, "hierarchy">> & object;
Type declaration
hierarchy
hierarchy: Required<Pick<TypeHierarchyObjectType, API>>;
DOCS_URL
const DOCS_URL: "https://graphql-markdown.dev/docs";
Defined in: packages/core/src/config.ts:46
PACKAGE_NAME
const PACKAGE_NAME: "@graphql-markdown/docusaurus";
Defined in: packages/core/src/config.ts:47
buildConfig()
function buildConfig(
configFileOpts,
cliOpts?,
id?): Promise<Options>
Defined in: packages/core/src/config.ts:376
Parameters
configFileOpts
Maybe
<ConfigOptions
>
cliOpts?
Maybe
<CliOptions
>
id?
Maybe
<string
> = "default"
Returns
Promise
<Options
>
getCustomDirectives()
function getCustomDirectives(customDirectiveOptions, skipDocDirective?): Maybe<CustomDirective>
Defined in: packages/core/src/config.ts:189
Parameters
customDirectiveOptions
Maybe
<CustomDirective
>
skipDocDirective?
Maybe
<DirectiveName
[]>
Returns
Maybe
<CustomDirective
>
getDiffMethod()
function getDiffMethod(diff, force): TypeDiffMethod
Defined in: packages/core/src/config.ts:222
Parameters
diff
TypeDiffMethod
force
boolean
= false
Returns
TypeDiffMethod
getDocDirective()
function getDocDirective(name): DirectiveName
Defined in: packages/core/src/config.ts:105
Parameters
name
Maybe
<DirectiveName
>
Returns
DirectiveName
getDocOptions()
function getDocOptions(cliOpts?, configOptions?): Required<ConfigDocOptions>
Defined in: packages/core/src/config.ts:238
Parameters
cliOpts?
Maybe
<CliOptions
& Omit
<DeprecatedCliOptions
, "never"
>>
configOptions?
Maybe
<ConfigDocOptions
& Omit
<DeprecatedConfigDocOptions
, "never"
>>
Returns
Required
<ConfigDocOptions
>
getOnlyDocDirectives()
function getOnlyDocDirectives(cliOpts, configFileOpts): DirectiveName[]
Defined in: packages/core/src/config.ts:121
Parameters
cliOpts
Maybe
<CliOptions
>
configFileOpts
Maybe
<Pick
<ConfigOptions
, "onlyDocDirective"
>>
Returns
DirectiveName
[]
getPrintTypeOptions()
function getPrintTypeOptions(cliOpts, configOptions): Required<ConfigPrintTypeOptions>
Defined in: packages/core/src/config.ts:311
Parameters
cliOpts
Maybe
<CliOptions
& Omit
<DeprecatedCliOptions
, "never"
>>
configOptions
Maybe
<ConfigPrintTypeOptions
& Omit
<DeprecatedConfigPrintTypeOptions
, "never"
>>
Returns
Required
<ConfigPrintTypeOptions
>
getSkipDocDirectives()
function getSkipDocDirectives(cliOpts, configFileOpts): DirectiveName[]
Defined in: packages/core/src/config.ts:137
Parameters
cliOpts
Maybe
<CliOptions
>
configFileOpts
Maybe
<Pick
<ConfigOptions
, "printTypeOptions"
| "skipDocDirective"
>>
Returns
DirectiveName
[]
getTypeHierarchyOption()
function getTypeHierarchyOption(cliOption?, configOption?): Maybe<Partial<Record<TypeHierarchyValueType, TypeHierarchyTypeOptions>>>
Defined in: packages/core/src/config.ts:260
Parameters
cliOption?
Maybe
<TypeHierarchyValueType
>
configOption?
Maybe
<TypeHierarchyType
>
Returns
Maybe
<Partial
<Record
<TypeHierarchyValueType
, TypeHierarchyTypeOptions
>>>
getVisibilityDirectives()
function getVisibilityDirectives(cliOpts, configFileOpts): object
Defined in: packages/core/src/config.ts:164
Parameters
cliOpts
Maybe
<CliOptions
>
configFileOpts
Maybe
<Pick
<ConfigOptions
, "printTypeOptions"
| "skipDocDirective"
| "onlyDocDirective"
>>
Returns
object
onlyDocDirective
onlyDocDirective: DirectiveName[];
skipDocDirective
skipDocDirective: DirectiveName[];
parseDeprecatedDocOptions()
function parseDeprecatedDocOptions(_cliOpts, _configOptions): Record<string, never>
Defined in: packages/core/src/config.ts:231
Parameters
_cliOpts
Maybe
<Omit
<DeprecatedCliOptions
, "never"
>>
_configOptions
Maybe
<Omit
<DeprecatedConfigDocOptions
, "never"
>>
Returns
Record
<string
, never
>
parseDeprecatedPrintTypeOptions()
function parseDeprecatedPrintTypeOptions(_cliOpts, _configOptions): Record<string, never>
Defined in: packages/core/src/config.ts:304
Parameters
_cliOpts
Maybe
<Omit
<DeprecatedCliOptions
, "never"
>>
_configOptions
Maybe
<Omit
<DeprecatedConfigPrintTypeOptions
, "never"
>>
Returns
Record
<string
, never
>
parseGroupByOption()
function parseGroupByOption(groupOptions): Maybe<GroupByDirectiveOptions>
Defined in: packages/core/src/config.ts:347
Parameters
groupOptions
unknown
Returns
Maybe
<GroupByDirectiveOptions
>