Skip to Content
GraphQL Tools
DocumentationAPI@graphql-tools/mocksrcfunctionsaddMocksToSchema

Function: addMocksToSchema()

addMocksToSchema<TResolvers>(__namedParameters): GraphQLSchema

Defined in: packages/mock/src/addMocksToSchema.ts:93

Given a schema and a MockStore, returns an executable schema that will use the provided MockStore to execute queries.

const schema = buildSchema(` type User { id: ID! name: String! } type Query { me: User! } `) const store = createMockStore({ schema }); const mockedSchema = addMocksToSchema({ schema, store });

If a resolvers parameter is passed, the query execution will use the provided resolvers if, one exists, instead of the default mock resolver.

const schema = buildSchema(` type User { id: ID! name: String! } type Query { me: User! } type Mutation { setMyName(newName: String!): User! } `) const store = createMockStore({ schema }); const mockedSchema = addMocksToSchema({ schema, store, resolvers: { Mutation: { setMyName: (_, { newName }) => { const ref = store.get('Query', 'ROOT', 'viewer'); store.set(ref, 'name', newName); return ref; } } } });

Query and Mutation type will use key 'ROOT'.

Type Parameters

TResolvers

TResolvers = IResolvers

Parameters

__namedParameters

IMockOptions<TResolvers>

Returns

GraphQLSchema