@redocly/graphql-docs
Version:
Redocly GraphQL docs
21 lines (20 loc) • 1 kB
TypeScript
import type { GraphQLArgument, GraphQLField, GraphQLOutputType } from 'graphql';
import type { OperationType } from './operation-type.js';
export interface OperationExampleProps {
operationType: OperationType;
operation: GraphQLField<any, any>;
expandLevel: number;
multilineArguments: boolean;
translate: (key: string, defaultMessage?: string) => string;
}
export declare function getOperationExample({ operationType, operation, expandLevel, multilineArguments, translate, }: OperationExampleProps): string;
export interface OperationResponseExampleProps {
responseType: GraphQLOutputType;
expandLevel: number;
}
export declare function getOperationResponseExample({ responseType, expandLevel, }: OperationResponseExampleProps): object;
export interface OperationVariablesExampleProps {
args: ReadonlyArray<GraphQLArgument>;
expandLevel: number;
}
export declare function getOperationVariablesExample({ args, expandLevel, }: OperationVariablesExampleProps): object;