Setting up a nodejs graphql server should be simple, right?
IMPORTANT Before you get started, just remember that this framework requires at least 1 Query and 1 Mutation to get it running.
npm install @mavvy/minigqlinstall typescript
npm install typescript @types/node --save-devSet type to module
{
"type": "module"
} {
"scripts": {
"start": "minigql start"
}
}{
"compilerOptions": {
"lib": ["es2020"],
"target": "es2020",
"module": "esnext",
"moduleResolution": "node",
"esModuleInterop": true,
"types": ["node"]
}
}export PORT = 3000create a schema.ts file under src directory
// src/schema.ts
export default `
type Todo {
name: String
}
input AddTodoInput {
name: String!
}
`create the files under src/resolvers directory
// src/resolvers/todos.ts
export const resolverType = 'Query';
export const returnType = '[Todo]';
export const handler = async () => {
return [{
name: 'My Todo One'
}];
}Optional. Resolver type: currently supported types are Query and Mutation. Subscription soon. Default is Query.
export const resolverType = 'Query';Optional. The return type of the gql resolver that is defined on your schema.ts file.
export const returnType = '[Product]';Optional. input type name for the resolver argument named input
export const inputVariable = 'NameInput!';Note: Make sure you define the NameInput on your schema.ts file like so:
//src/schema.ts
export default `
input NameInput {
name: String
}
`On your resolver, you can access it via params
export const resolver = async ({input}) => {
console.log(input); // {name: 'foo'}
}Required. The main resolver function to execute
export const handler = async () => {
return {name: 'foo'}
}| key | description |
|---|---|
| parentContext | The return value of the resolver for this field's parent |
| variables | An object that contains all GraphQL arguments provided for this field |
| input | Shortcut for the input property from the variables. Same as variables.input
|
| context | An object shared across all resolvers that are executing for a particular operation. |
| info | Contains information about the operation's execution state, including the field name, the path to the field from the root, and more. |
export const handler = async (handlerParams) => {
console.log(handlerParams.input);
}Create a server.ts file under src directory
// src/server.ts
import { InMemoryLRUCache } from '@apollo/utils.keyvaluecache';
export const apolloConfig = {
cache: new InMemoryLRUCache(),
};Apollo standAloneServer config
// src/server.ts
const getToken = (req) => req.headers.authentication;
export const serverConfig = {
context: async ({ req }) => ({
token: getToken(req),
}),
}Good location for running a database connection. etc.
// src/server.ts
import mongoose from 'mongoose';
export async function preStart() {
await mongoose.connect(process.env.MONGO_URI);
console.log('connected to db');
}