graphql-scalar-types
Advanced tools
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
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();
Constructs a builder with a name for the GraphQLScalar.
Parameters
name stringExamples
const GraphQLStringBuilder = GraphQLScalarTypes.string('Name');
const GraphQLNumberBuilder = GraphQLScalarTypes.number('Age');
const GraphQLBooleanBuilder = GraphQLScalarTypes.boolean('SpecialFalsy');
Gives a description to the GraphQLScalar.
Parameters
description stringMakes the GraphQLScalar reject null as a value.
Parameters
isNonNull boolean Default value is true. (optional, default true)Clones the builder.
Generates the GraphQLScalar.
Returns GraphQLScalarType<TInternal, TExternal>
Extends Base
Boolean scalar type that represents boolean data.
By itself, it is essentially the GraphQLBoolean type.
Converts additional values to true during serialization.
Accepts a value or an array of values.
Parameters
params ...anyConverts additional values to false during serialization.
Accepts a value or an array of values.
Parameters
params ...anyExtends Base
String scalar type that takes in string data.
By itself, it is essentially the GraphQLString type.
Extends Base
Number scalar type that represents numerical data.
By itself, it is essentially the GraphQLFloat type.
Specifies the minimum number allowed (inclusive).
Parameters
limit numberSpecifies the maximum number allowed (inclusive).
Parameters
limit numberSpecifies that the value must be greater than the limit.
Parameters
limit numberSpecifies that the value must be lesser than the limit.
Parameters
limit numberRequires 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.
Specifies the maximum number of decimal places allowed.
Parameters
limit numberSpecifies that the number must be a multiple of base.
Parameters
base numberSpecifies that the number must be positive (>0).
Specifies that the number must be negative (<0).
Extends Base
String scalar type that represents string data.
By itself, it is essentially the GraphQLString type.
Specifies the minimum number of string characters allowed.
Parameters
limit numberSpecifies the maximum number of string characters allowed.
Parameters
limit numberSpecifies the exact number of string characters required.
Parameters
limit numberSpecifies the length of the string to be truncated to if it exceeds.
Parameters
limit numberRequires the string value to only contain a-z, A-Z, and 0-9.
Requires the string value to be a credit card number.
Requires the string value to match the regex test.
Parameters
pattern RegExpoptions boolean name for regexp pattern and invert to disallow pattern instead. (optional, default {name:'',invert:false})Replaces the regex matches of the string with the replacement. Equivalent to String.prototype.replace.
Parameters
Trims the string.
Requires the string to be a valid base64 string.
Requires the string to be a valid hexadecimal string.
Given a value and a GraphQL type, determine if the value will be accepted for that type.
Parameters
value anytype GraphQLInputType2.0.0
npm i graphql is now neededFAQs
The easy way to build graphql types
The npm package graphql-scalar-types receives a total of 87 weekly downloads. As such, graphql-scalar-types popularity was classified as not popular.
We found that graphql-scalar-types demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Following last week’s supply chain attack, Nx published findings on the GitHub Actions exploit and moved npm publishing to Trusted Publishers.
Security News
AGENTS.md is a fast-growing open format giving AI coding agents a shared, predictable way to understand project setup, style, and workflows.
Security News
/Research
Malicious npm package impersonates Nodemailer and drains wallets by hijacking crypto transactions across multiple blockchains.