graphql-scalar-types
v2.0.0
Published
The easy way to build graphql types
Downloads
132
Maintainers
Readme
GraphQL Scalar Types
GraphQL scalar types for validation of GraphQL objects.
The flexibility of GraphQL means validation for your schemas is possible. GraphQL Scalar Types allows you to build types easily using a fluent interface, similar to libraries like Joi.
npm i graphql graphql-scalar-types
Example
import 'GraphQLScalarTypes' from 'graphql-scalar-types';
export const GraphQLName = GraphQLScalarTypes.string('Name').min(0).max(36).create();
export const GraphQLAge = GraphQLScalarTypes.number('Age').min(0).max(120).create();
API
constructor
Constructs a builder with a name for the GraphQLScalar.
Parameters
name
string
Examples
const GraphQLStringBuilder = GraphQLScalarTypes.string('Name');
const GraphQLNumberBuilder = GraphQLScalarTypes.number('Age');
const GraphQLBooleanBuilder = GraphQLScalarTypes.boolean('SpecialFalsy');
describe
Gives a description to the GraphQLScalar.
Parameters
description
string
nonNull
Makes the GraphQLScalar reject null
as a value.
Parameters
isNonNull
boolean Default value is true. (optional, defaulttrue
)
clone
Clones the builder.
create
Generates the GraphQLScalar.
Returns GraphQLScalarType<TInternal, TExternal>
BooleanScalar
Extends Base
Boolean scalar type that represents boolean data.
By itself, it is essentially the GraphQLBoolean
type.
truthy
Converts additional values to true
during serialization.
Accepts a value or an array of values.
Parameters
params
...any
falsy
Converts additional values to false
during serialization.
Accepts a value or an array of values.
Parameters
params
...any
DateScalar
Extends Base
String scalar type that takes in string data.
By itself, it is essentially the GraphQLString
type.
NumberScalar
Extends Base
Number scalar type that represents numerical data.
By itself, it is essentially the GraphQLFloat
type.
min
Specifies the minimum number allowed (inclusive).
Parameters
limit
number
max
Specifies the maximum number allowed (inclusive).
Parameters
limit
number
greater
Specifies that the value must be greater than the limit.
Parameters
limit
number
lesser
Specifies that the value must be lesser than the limit.
Parameters
limit
number
integer
Requires the number to be an integer from -(2^31) and 2^31 - 1. As per the GraphQL Spec, Integers are only treated as valid when a valid 32-bit signed integer, providing the broadest support across platforms.
precision
Specifies the maximum number of decimal places allowed.
Parameters
limit
number
multiple
Specifies that the number must be a multiple of base.
Parameters
base
number
positive
Specifies that the number must be positive (>0).
negative
Specifies that the number must be negative (<0).
StringScalar
Extends Base
String scalar type that represents string data.
By itself, it is essentially the GraphQLString
type.
min
Specifies the minimum number of string characters allowed.
Parameters
limit
number
max
Specifies the maximum number of string characters allowed.
Parameters
limit
number
length
Specifies the exact number of string characters required.
Parameters
limit
number
truncate
Specifies the length of the string to be truncated to if it exceeds.
Parameters
limit
number
alphanum
Requires the string value to only contain a-z, A-Z, and 0-9.
creditCard
Requires the string value to be a credit card number.
regex
Requires the string value to match the regex test.
Parameters
pattern
RegExpoptions
booleanname
for regexp pattern andinvert
to disallow pattern instead. (optional, default{name:'',invert:false}
)
replace
Replaces the regex matches of the string with the replacement
. Equivalent to String.prototype.replace
.
Parameters
trim
Trims the string.
uppercase
lowercase
base64
Requires the string to be a valid base64 string.
hex
Requires the string to be a valid hexadecimal string.
validate
Given a value and a GraphQL type, determine if the value will be accepted for that type.
Parameters
value
anytype
GraphQLInputType