A custom GraphQL scalar type for Firebase and Google Cloud Firestore.

Installation

npm install --save firestore-graphql-scalars

or

yarn add firestore-graphql-scalars

Usage

To use this scalar you'll need to add it in two places, your schema and your resolvers map.

In your schema:

1scalar Timestamp

In your resolver map, first import them:

1import { timestampResolver } from 'firestore-graphql-scalars';

Then make sure they're in the root resolver map like this:

1const myResolverMap = {
2  Timestamp: timestampResolver,
3
4  Query: {
5    // more stuff here
6  },
7
8  Mutation: {
9    // more stuff here
10  },
11};

Alternatively, use the default import and ES6's spread operator syntax:

1import { resolvers } from 'firestore-graphql-scalars';

Then make sure they're in the root resolver map like this:

1const myResolverMap = {
2  ...resolvers,
3
4  Query: {
5    // more stuff here
6  },
7
8  Mutation: {
9    // more stuff here
10  },
11};

That's it. Now you can use these scalar types in your schema definition like this:

1type Person {
2  createdAt: Timestamp
3  ...
4}

These scalars can be used just like the base, built-in ones.

Usage with Apollo Server

1import { ApolloServer } from 'apollo-server';
2import { makeExecutableSchema } from '@graphql-tools/schema';
3import { typeDefs, resolvers } from 'firestore-graphql-scalars';
4
5const server = new ApolloServer({
6  schema: makeExecutableSchema({
7    typeDefs: [
8      // use spread syntax to add scalar definitions to your schema
9      ...typeDefs,
10      // DateTimeTypeDefinition,
11      // ...
12      // ... other type definitions ...
13    ],
14    resolvers: {
15      // use spread syntax to add scalar resolvers to your resolver map
16      ...resolvers,
17      // DateTimeResolver,
18      // ...
19      // ... remainder of resolver map ...
20    },
21  }),
22});
23
24server.listen().then(({ url }) => {
25  console.log(`🚀 Server ready at ${url}`);
26});

License

Released under the MIT license.

Contributing

Issues and Pull Requests are always welcome. ❤️

Thanks

This repository is a fork of graphql-scalars. It's inspired by @lookfirst's issue and juicylevel/coffee-service. Big thanks to the contributors of these repositories! 🙏