UNPKG

@loopback/docs

Version:

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

272 lines (123 loc) 3.58 kB
--- lang: en title: 'API docs: graphql.graphqlserver' 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.graphqlserver.html --- <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@loopback/graphql](./graphql.md) &gt; [GraphQLServer](./graphql.graphqlserver.md) ## GraphQLServer class GraphQL Server **Signature:** ```typescript export declare class GraphQLServer extends Context implements Server ``` **Extends:** [Context](./context.context.md) **Implements:** [Server](./core.server.md) ## Constructors <table><thead><tr><th> Constructor </th><th> Modifiers </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [(constructor)(options, parent)](./graphql.graphqlserver._constructor_.md) </td><td markdown="1"> </td><td markdown="1"> Constructs a new instance of the `GraphQLServer` class </td></tr> </tbody></table> ## Properties <table><thead><tr><th> Property </th><th> Modifiers </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [expressApp](./graphql.graphqlserver.expressapp.md) </td><td markdown="1"> `readonly` </td><td markdown="1"> express.Application </td><td markdown="1"> </td></tr> <tr><td markdown="1"> [httpServer?](./graphql.graphqlserver.httpserver.md) </td><td markdown="1"> `readonly` </td><td markdown="1"> [HttpServer](./http-server.httpserver.md) </td><td markdown="1"> _(Optional)_ </td></tr> <tr><td markdown="1"> [listening](./graphql.graphqlserver.listening.md) </td><td markdown="1"> `readonly` </td><td markdown="1"> boolean </td><td markdown="1"> Is the GraphQL listening </td></tr> </tbody></table> ## Methods <table><thead><tr><th> Method </th><th> Modifiers </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [exportGraphQLSchema(outFile, log)](./graphql.graphqlserver.exportgraphqlschema.md) </td><td markdown="1"> </td><td markdown="1"> </td></tr> <tr><td markdown="1"> [getMiddlewareList()](./graphql.graphqlserver.getmiddlewarelist.md) </td><td markdown="1"> </td><td markdown="1"> Get a list of middleware </td></tr> <tr><td markdown="1"> [getResolverClasses()](./graphql.graphqlserver.getresolverclasses.md) </td><td markdown="1"> </td><td markdown="1"> Get a list of resolver classes </td></tr> <tr><td markdown="1"> [getSchema()](./graphql.graphqlserver.getschema.md) </td><td markdown="1"> </td><td markdown="1"> </td></tr> <tr><td markdown="1"> [middleware(middleware)](./graphql.graphqlserver.middleware.md) </td><td markdown="1"> </td><td markdown="1"> Register a GraphQL middleware </td></tr> <tr><td markdown="1"> [resolver(resolverClass, nameOrOptions)](./graphql.graphqlserver.resolver.md) </td><td markdown="1"> </td><td markdown="1"> Register a GraphQL resolver class </td></tr> <tr><td markdown="1"> [start()](./graphql.graphqlserver.start.md) </td><td markdown="1"> </td><td markdown="1"> </td></tr> <tr><td markdown="1"> [stop()](./graphql.graphqlserver.stop.md) </td><td markdown="1"> </td><td markdown="1"> </td></tr> </tbody></table>