ponder-enrich-gql-docs-middleware/lib/src/introspection.d.ts

A middleware for Ponder that allows devs to enrich their GraphQL docs with docstrings

import type { DocStrings, IntrospectionSchema } from "./types";
/**
 * Enhances an introspection schema with additional documentation strings.
 *
 * @param introspectionData - The original introspection schema
 * @param docs - Documentation strings to add to the schema
 * @returns The enhanced schema with added documentation
 * @throws {Error} If the introspection data structure is invalid
 *
 * @example
 * ```typescript
 * const docs = {
 *   User: "Represents a user",
 *   "User.balance": "User's balance"
 * };
 *
 * const enhancedSchema = addDocStringsToIntrospection(schema, docs);
 * ```
 */
export declare function addDocStringsToIntrospection(introspectionData: IntrospectionSchema, docs: DocStrings): IntrospectionSchema;