@harperdb/apollo

A HarperDB Component for running and developing Apollo GraphQL backend services.

!NPM Version

Most Apollo features are supported as this component relies on the ApolloServer provided by @apollo/server.

If you don't know where to get started, check out the apollo-example starter project.

Options

$3

$3

Specifies the directory that contains your configuration files.

$3

$3

Specify a path to a custom Apollo cache implementation.

Must be set to a path of a JavaScript file with a default export of an Apollo cache backend implementing the KeyValueCache interface.

For example:

``js
class CustomCache {
// ...
}

export default CustomCache;
`

$3

Specify a port for the Apollo server. Defaults to the HarperDB default port (generally 9926).

$3

Specify a path to the Apollo resolvers JavaScript file.

Must be set to a singular path of a JavaScript file containing a default export of Apollo resolver functions.

For example:

`js
const resolvers = {
Query: {
dog: //...
},
}

export default resolvers;
`

$3

Specify a path to an Apollo plugins JavaScript file.

Must be set to a singular path of a JavaScript file containing a default export of Apollo plugins.

For example:

`js
// Example setting custom response headers
const customPlugin = {
async requestDidStart() {
return {
async willSendResponse(requestContext) {
const { response } = requestContext;
response.http.headers.set('x-foo', 'bar');
},
};
},
};

const plugins = [customPlugin];

export default plugins;
`

$3

Specify a glob path to Apollo schema files.

Can be a singular path or a glob pattern. All schemas will be concatenated together and passed to the Apollo server.

For example, if all schemas are located in src/schemas/, the setting here would be ./src/schemas/*.graphql`

$3

Specify a secure port for the Apollo server. Defaults to the HarperDB default secure port.

$3

Enable/disable GraphQL introspection