@graphql-tools/mock
Version:
A set of utils for faster development of GraphQL tools
18 lines (17 loc) • 1.07 kB
text/typescript
import { TypeSource } from '@graphql-tools/utils';
import { IMocks, IMockServer, MockGenerationBehavior } from './types.cjs';
/**
* A convenience wrapper on top of `addMocksToSchema`. It adds your mock resolvers
* to your schema and returns a client that will correctly execute your query with
* variables. Note: when executing queries from the returned server, context and
* root will both equal `{}`.
* @param schema The schema to which to add mocks. This can also be a set of type
* definitions instead.
* @param mocks The mocks to add to the schema.
* @param preserveResolvers Set to `true` to prevent existing resolvers from being
* overwritten to provide mock data. This can be used to mock some parts of the
* server and not others.
* @param mockGenerationBehavior Set to `'deterministic'` if the default random
* mock generation behavior causes flakiness.
*/
export declare function mockServer<TResolvers>(schema: TypeSource, mocks: IMocks<TResolvers>, preserveResolvers?: boolean, mockGenerationBehavior?: MockGenerationBehavior): IMockServer;