@impargo/apollo-server
v1.0.0
Published
This is a simple Node.js module that provides a function for creating an Apollo Server instance. It uses the apollo-server package to create an instance of the ApolloServer class.
Downloads
3
Keywords
Readme
Apollo Server
This is a simple Node.js module that provides a function for creating an Apollo Server instance. It uses the apollo-server package to create an instance of the ApolloServer class.
Installation
To install the module, run the following command:
yarn add @impargo/apollo-server
Usage
The module exports a single function called apolloServer that takes an object with the following properties:
- schema: An instance of the GraphQLSchema class that defines the GraphQL schema for the server.
- context: A function that returns the context object for each GraphQL operation. The context object is passed to all resolvers, so it can be used to store data that needs to be shared across resolvers.
- plugins (optional): An array of plugins to use with the server. Each plugin is an object that has a requestDidStart method that is called when a GraphQL request starts. The method is passed an object that contains information about the request and the server context.
- introspection (optional): A boolean value that determines whether the server should support GraphQL introspection queries.
- stopOnTerminationSignals (optional): A boolean value that determines whether the server should stop gracefully when a termination signal is received (e.g. SIGINT or SIGTERM). The apolloServer function returns a Promise that resolves to an instance of the ApolloServer class.
Here'san example of how to use the module:
import { apolloServer } from '@impargo/apollo-server'
import { buildSchema } from 'graphql'
async function startServer() {
const schema = buildSchema(`
type Query {
hello: String
}
`)
const context = () => {
return { someData: 'example' }
}
const { server, url } = await apolloServer({ schema, context })
console.log(`Server ready at ${url}`)
}
startServer()
In this example, we define a simple GraphQL schema with a single hello query. We also define a context function that returns an object with some data. Finally, we call the apolloServer function with the schema and context, and start the server by calling the listen method on the returned ApolloServer instance.
If an error occurs while starting the server, the function will log an error message using the @impargo/logger package and exit the process with exit code 1.
License
This module is licensed under the MIT License.