graphql-bigint
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/graphql-bigint package

1.0.0 • Public • Published

graphql-bigint

A wider integer type for graphql-js than the default 32-bit GraphQLInt. This implementation gives you 53-bit integers.

The problem

The GraphQL spec limits its Int type to 32-bits. Maybe you've seen this error before:

GraphQLError: Argument "num" has invalid value 9007199254740990.
              Expected type "Int", found 9007199254740990.

Why? 64-bits would be too large for JavaScript's 53-bit limit. According to Lee Byron, a 52-bit integer spec would have been "too weird" see this issue.

Usage

$ npm install graphql-bigint

Use it the same as any other scalar type, either input or output.

const BigInt = require('graphql-bigint')
 
const SomeType = new GraphQLObjectType({
  name: 'SomeType',
  fields: {
    numberField: {
      type: BigInt,
      // this would throw an error with the GraphQLInt
      resolve: () => Number.MAX_SAFE_INTEGER 
    }
  }
})

Dependencies (0)

    Dev Dependencies (3)

    Package Sidebar

    Install

    npm i graphql-bigint

    Weekly Downloads

    6,431

    Version

    1.0.0

    License

    MIT

    Last publish

    Collaborators

    • acarl005