UNPKG

@loopback/docs

Version:

Documentation files rendered at [https://loopback.io](https://loopback.io)

165 lines (76 loc) 2.53 kB
--- lang: en title: 'API docs: graphql.graphqlserveroptions' keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI sidebar: lb4_sidebar editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/graphql permalink: /doc/en/lb4/apidocs.graphql.graphqlserveroptions.html --- <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@loopback/graphql](./graphql.md) &gt; [GraphQLServerOptions](./graphql.graphqlserveroptions.md) ## GraphQLServerOptions interface Options for GraphQL server **Signature:** ```typescript export interface GraphQLServerOptions<TContext extends BaseContext = BaseContext> extends HttpOptions ``` **Extends:** [HttpOptions](./http-server.httpoptions.md) ## Properties <table><thead><tr><th> Property </th><th> Modifiers </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [apollo?](./graphql.graphqlserveroptions.apollo.md) </td><td markdown="1"> </td><td markdown="1"> Partial&lt;ApolloServerOptionsWithStaticSchema&lt;TContext&gt;&gt; </td><td markdown="1"> _(Optional)_ ApolloServerExpress related configuration </td></tr> <tr><td markdown="1"> [asMiddlewareOnly?](./graphql.graphqlserveroptions.asmiddlewareonly.md) </td><td markdown="1"> </td><td markdown="1"> boolean </td><td markdown="1"> _(Optional)_ Use as a middleware for RestServer instead of a standalone server </td></tr> <tr><td markdown="1"> [expressSettings?](./graphql.graphqlserveroptions.expresssettings.md) </td><td markdown="1"> </td><td markdown="1"> Record&lt;string, unknown&gt; </td><td markdown="1"> _(Optional)_ Express settings </td></tr> <tr><td markdown="1"> [graphQLPath?](./graphql.graphqlserveroptions.graphqlpath.md) </td><td markdown="1"> </td><td markdown="1"> string </td><td markdown="1"> _(Optional)_ </td></tr> <tr><td markdown="1"> [middlewareOptions?](./graphql.graphqlserveroptions.middlewareoptions.md) </td><td markdown="1"> </td><td markdown="1"> Record&lt;string, unknown&gt; </td><td markdown="1"> _(Optional)_ Middleware options for GraphQL </td></tr> <tr><td markdown="1"> [validate?](./graphql.graphqlserveroptions.validate.md) </td><td markdown="1"> </td><td markdown="1"> boolean </td><td markdown="1"> _(Optional)_ </td></tr> </tbody></table>