@graphql-yoga/render-graphiql/dist/packages/graphql-yoga/src/plugins/use-graphiql.d.cts

import "./types.cjs";

//#region ../graphql-yoga/src/plugins/use-graphiql.d.ts
type TabDefinition = {
  headers?: string | null;
  query: string | null;
  variables?: string | null;
};
type GraphiQLOptions = {
  /**
   * Headers to be set when opening a new tab
   */
  defaultHeaders?: string;
  /**
   * An optional GraphQL string to use when no query is provided and no stored
   * query exists from a previous session.  If undefined is provided, GraphiQL
   * will use its own default query.
   */
  defaultQuery?: string;
  /**
   * This prop can be used to define the default set of tabs, with their
   * queries, variables, and headers. It will be used as default only if there
   * is no tab state persisted in storage.
   */
  defaultTabs?: TabDefinition[];
  /**
   * The initial headers to render inside the header editor. Defaults to `"{}"`.
   * The value should be a JSON encoded string, for example:
   * `headers: JSON.stringify({Authorization: "Bearer your-auth-key"})`
   */
  headers?: string;
  /**
   * This prop toggles if the contents of the headers editor are persisted in
   * storage.
   */
  shouldPersistHeaders?: boolean | undefined;
  /**
   * More info there: https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials
   */
  credentials?: RequestCredentials;
  /**
   * The favicon URL to display for the page. Defaults to Yoga logo.
   */
  favicon?: string;
  /**
   * The title to display at the top of the page. Defaults to `"Yoga GraphiQL"`.
   */
  title?: string;
  /**
   * Logo to be displayed in the top right corner of GraphiQL.
   */
  logo?: string;
  /**
   * Protocol for subscriptions
   */
  subscriptionsProtocol?: 'SSE' | 'GRAPHQL_SSE' | 'WS' | 'LEGACY_WS';
  /**
   * Extra headers you always want to pass with users' headers input
   */
  additionalHeaders?: Record<string, string>;
  /**
   * HTTP method to use when querying the original schema.
   */
  method?: 'GET' | 'POST';
  /**
   * Whether to use the GET HTTP method for queries when querying the original schema
   */
  useGETForQueries?: boolean;
  /**
   * "external" fragments that will be included in the query document (depending on usage)
   */
  externalFragments?: string;
  /**
   * The maximum number of executed operations to store.
   * @default 20
   */
  maxHistoryLength?: number;
  /**
   * Whether target GraphQL server support deprecation of input values.
   * @default false
   */
  inputValueDeprecation?: boolean;
  /**
   * Custom operation name for the introspection query.
   */
  introspectionQueryName?: string;
  /**
   * Whether to include schema description in introspection query.
   * @default false
   */
  schemaDescription?: boolean;
  /**
   * Editor theme
   * @default "graphiql"
   */
  editorTheme?: string;
  /**
   *  Sets the key map to use when using the editor.
   * @default 'sublime'
   */
  keyMap?: 'sublime' | 'emacs' | 'vim';
  defaultEditorToolsVisibility?: boolean | 'variables' | 'headers';
  isHeadersEditorEnabled?: boolean;
  disableTabs?: boolean;
  /**
   * Whether to include `isRepeatable` flag on directives.
   * @default false
   */
  directiveIsRepeatable?: boolean;
  experimentalFragmentVariables?: boolean;
  /**
   * Set to `true` in order to convert all GraphQL comments (marked with # sign) to descriptions (""")
   * GraphQL has built-in support for transforming descriptions to comments (with `print`), but not while
   * parsing. Turning the flag on will support the other way as well (`parse`)
   */
  commentDescriptions?: boolean;
  /**
   * Timeout in milliseconds
   */
  timeout?: number;
  /**
   * Retry attempts
   */
  retry?: number;
  /**
   * The endpoint requests should be sent.
   * Defaults to the graphql endpoint ("/graphql" by default).
   */
  endpoint?: string;
};
//#endregion
export { GraphiQLOptions };