Skip to main content

schema

ALLOWLIST​

const ALLOWLIST: object;

Defined in: schema.ts:104

Type Declaration​

ciProviders​

readonly ciProviders: readonly ["github-actions", "gitlab", "circleci", "azure-pipelines", "jenkins", "bitbucket", "buildkite", "travis", "vercel", "netlify", "cloudflare-pages", "aws-codebuild", "teamcity", "appveyor", "drone", "render", "other"] = CI_PROVIDERS;

deprecatedOptions​

readonly deprecatedOptions: readonly ["default", "group", "skip"] = DEPRECATED_OPTIONS;

diffMethods​

readonly diffMethods: readonly ["FORCE", "NONE"] = DIFF_METHODS;

events​

readonly events: readonly ["config", "create_scaffold", "create_wire"] = EVENTS;

formatterPackagePattern​

readonly formatterPackagePattern: "^@graphql-markdown/[a-z0-9-]+(/[a-z0-9-]+)*$" = "^@graphql-markdown/[a-z0-9-]+(/[a-z0-9-]+)*$";

formatterPresets​

readonly formatterPresets: readonly ["docfx", "docusaurus", "fumadocs", "honkit", "hugo", "mdbook", "mdx", "mkdocs", "starlight", "vocs"] = FORMATTER_PRESETS;

graphqlMajorUnknown​

readonly graphqlMajorUnknown: "unknown" = "unknown";

hierarchies​

readonly hierarchies: readonly ["api", "entity", "flat"] = HIERARCHIES;

keyTokenPattern​

readonly keyTokenPattern: string = KEY_TOKEN_PATTERN;

knownLoaders​

readonly knownLoaders: readonly ["UrlLoader", "JsonFileLoader", "GraphQLFileLoader", "CodeFileLoader", "GitLoader", "GithubLoader", "ApolloEngineLoader", "PrismaLoader", "@graphql-tools/url-loader", "@graphql-tools/json-file-loader", "@graphql-tools/graphql-file-loader", "@graphql-tools/code-file-loader", "@graphql-tools/git-loader", "@graphql-tools/github-loader", "@graphql-tools/apollo-engine-loader", "@graphql-tools/prisma-loader"] = KNOWN_LOADERS;

loaderKinds​

readonly loaderKinds: readonly ["url", "file-sdl", "file-json", "git", "github", "glob", "code-file", "inline-sdl", "unknown"] = LOADER_KINDS;

maskTokens​

readonly maskTokens: readonly ["<url>", "<path>", "<string>", "<function>", "<object>", "<custom-loader>", "<custom-formatter>", "<git>", "<github>", "<file:sdl>", "<file:json>", "<file:code>", "<glob>", "<inline-sdl>", "<unknown>"] = MASK_TOKENS;

modes​

readonly modes: readonly ["scaffold", "wire"] = MODES;

packageManagers​

readonly packageManagers: readonly ["npm", "pnpm", "yarn", "bun", "unknown"] = PACKAGE_MANAGERS;

triggers​

readonly triggers: readonly ["cli", "create", "docusaurus", "nuxt", "programmatic"] = TRIGGERS;

CI_PROVIDERS​

const CI_PROVIDERS: readonly [
  "github-actions",
  "gitlab",
  "circleci",
  "azure-pipelines",
  "jenkins",
  "bitbucket",
  "buildkite",
  "travis",
  "vercel",
  "netlify",
  "cloudflare-pages",
  "aws-codebuild",
  "teamcity",
  "appveyor",
  "drone",
  "render",
  "other",
];

Defined in: schema.ts:13

DEPRECATED_OPTIONS​

const DEPRECATED_OPTIONS: readonly ["default", "group", "skip"];

Defined in: schema.ts:52

DIFF_METHODS​

const DIFF_METHODS: readonly ["FORCE", "NONE"];

Defined in: schema.ts:51

EVENTS​

const EVENTS: readonly ["config", "create_scaffold", "create_wire"];

Defined in: schema.ts:5

Allowlist of every string a payload may carry, as plain data: enums plus mask tokens. Shared with the Worker, which rejects anything else.

FORMATTER_PRESETS​

const FORMATTER_PRESETS: readonly [
  "docfx",
  "docusaurus",
  "fumadocs",
  "honkit",
  "hugo",
  "mdbook",
  "mdx",
  "mkdocs",
  "starlight",
  "vocs",
];

Defined in: schema.ts:54

HIERARCHIES​

const HIERARCHIES: readonly ["api", "entity", "flat"];

Defined in: schema.ts:53

KEY_TOKEN_PATTERN​

const KEY_TOKEN_PATTERN: string;

Defined in: schema.ts:102

Pattern of masked object keys, e.g. <key:0>.

KNOWN_LOADERS​

const KNOWN_LOADERS: readonly [
  "UrlLoader",
  "JsonFileLoader",
  "GraphQLFileLoader",
  "CodeFileLoader",
  "GitLoader",
  "GithubLoader",
  "ApolloEngineLoader",
  "PrismaLoader",
  "@graphql-tools/url-loader",
  "@graphql-tools/json-file-loader",
  "@graphql-tools/graphql-file-loader",
  "@graphql-tools/code-file-loader",
  "@graphql-tools/git-loader",
  "@graphql-tools/github-loader",
  "@graphql-tools/apollo-engine-loader",
  "@graphql-tools/prisma-loader",
];

Defined in: schema.ts:66

LOADER_KINDS​

const LOADER_KINDS: readonly [
  "url",
  "file-sdl",
  "file-json",
  "git",
  "github",
  "glob",
  "code-file",
  "inline-sdl",
  "unknown",
];

Defined in: schema.ts:39

MASK_TOKENS​

const MASK_TOKENS: readonly [
  "<url>",
  "<path>",
  "<string>",
  "<function>",
  "<object>",
  "<custom-loader>",
  "<custom-formatter>",
  "<git>",
  "<github>",
  "<file:sdl>",
  "<file:json>",
  "<file:code>",
  "<glob>",
  "<inline-sdl>",
  "<unknown>",
];

Defined in: schema.ts:84

MODES​

const MODES: readonly ["scaffold", "wire"];

Defined in: schema.ts:50

PACKAGE_MANAGERS​

const PACKAGE_MANAGERS: readonly ["npm", "pnpm", "yarn", "bun", "unknown"];

Defined in: schema.ts:32

TRIGGERS​

const TRIGGERS: readonly [
  "cli",
  "create",
  "docusaurus",
  "nuxt",
  "programmatic",
];

Defined in: schema.ts:6