graphql-datetime

Standalone GraphQL Scalar type for Date values in JavaScript.

1type User {
2  id: ID!
3  name: String!
4  createdAt: DateTime!
5  lastActiveAt: DateTime!
6}
7
8extend type Query {
9  user: User!
10}
11
12extend type Mutation {
13  setUserLastActiveAt(id: ID!, lastActiveAt: lastActiveAt!): Boolean!
14}

Install

$ npm install --save graphql @jdrydn/graphql-datetime

From your codebase, you can either use predefined items (type definition & resolver) directly in your project or define the scalar yourself & include the scalar instance in your resolvers.

The following example uses graphql-tools & the predefined items:

1const assert = require('assert');
2const { typeDefs: dateTimeTypeDefs, resolvers: dateTimeResolvers } = require('@jdrydn/graphql-datetime');
3
4const typeDefs = /* GraphQL */`
5  type User {
6    id: ID!
7    name: String!
8    createdAt: DateTime!
9    lastActiveAt: DateTime!
10  }
11
12  extend type Query {
13    user: User!
14  }
15
16  extend type Mutation {
17    setUserLastActiveAt(id: ID!, lastActiveAt: lastActiveAt!): Boolean!
18  }
19`;
20
21const resolvers = {
22  Query: {
23    async user(_, { id }) {
24      const user = await getUser(id);
25      return user && user.id ? user : null;
26    },
27  },
28  Mutation: {
29    async setUserLastActiveAt(_, { id, lastActiveAt }) {
30      const user = await getUser(id);
31      assert(user && user.id, 'User not found');
32
33      // Set the last active at
34      user.lastActiveAt = lastActiveAt;
35
36      await setUser(id, user);
37      return true;
38    },
39  },
40};
41
42const schema = makeExecutableSchema({
43  typeDefs: [ typeDefs, dateTimeTypeDefs ],
44  resolvers: [ resolvers, dateTimeResolvers ],
45});

Whereas this example uses apollo-server & includes the scalar instance DateTime in its resolvers:

1const { ApolloServer } = require('apollo-server');
2const { DateTime } = require('@jdrydn/graphql-datetime');
3
4const typeDefs = /* GraphQL */`
5  type User {
6    id: ID!
7    name: String!
8    createdAt: DateTime!
9    lastActiveAt: DateTime!
10  }
11
12  extend type Query {
13    user: User!
14  }
15
16  extend type Mutation {
17    setUserLastActiveAt(id: ID!, lastActiveAt: lastActiveAt!): Boolean!
18  }
19
20  # @NOTE You must define the scalar yourself
21  scalar DateTime
22`;
23
24const resolvers = {
25  Query: {
26    async user(_, { id }) {
27      const user = await getUser(id);
28      return user && user.id ? user : null;
29    },
30  },
31  Mutation: {
32    async setUserLastActiveAt(_, { id, lastActiveAt }) {
33      const user = await getUser(id);
34      assert(user && user.id, 'User not found');
35
36      // Set the last active at
37      user.lastActiveAt = lastActiveAt;
38
39      await setUser(id, user);
40      return true;
41    },
42  },
43  DateTime,
44};
45
46const server = new ApolloServer({
47  typeDefs,
48  resolvers,
49});

Usage

Once the type definition & resolver is configured, you can send & receive Date values in GraphQL in both queries & mutations.

Query

1query GetUser {
2  user(id: "1") {
3    id
4    name
5    lastActiveAt
6  }
7}

1{
2  "data": {
3    "user": {
4      "id": "1",
5      "name": "jdrydn",
6      "lastActiveAt": "2022-05-01T09:00:00.000Z"
7    }
8  }
9}

Mutation

1mutation UpdateUser {
2  setUserLastActiveAt(id: "1", lastActiveAt: "2022-05-01T09:00:00.000Z")
3}

1{
2  "data": {
3    "setUserLastActiveAt": true
4  }
5}

Notes

• Any questions or suggestions please open an issue.