Graphql Mask is a simple utility for removing everything in a query (or its variables) that is not defined in a schema. Use it by passing in an arguments object containing the schema to mask against, the query to be masked, and optionally, the variables to be masked:
const { maskedQuery, maskedVariables } = graphqlMask({
schema,
query,
variables
});$ npm install graphql-mask
# or
$ yarn add graphql-maskFiltering a query:
const graphqlMask = require("graphql-mask");
// const graphqlMask = require("graphql-mask/es5"); if you need to use this in a browser
const { maskedQuery } = graphqlMask({
schema: `
type Query {
something: String!
somethingElse: Int
}
`,
query: `
query ExampleQuery {
something
somethingElse
somethingNotInSchema
}
`}
})
console.log(maskedQuery)This will print...
query ExampleQuery {
something
somethingElse
}Since GraphQL 14 now supports the extension of input types, you can now use grapqhl-mask to filter input variables as well:
const { maskedQuery, maskedVariables } = graphqlMask({
schema: `
type Query {
something: String!
}
type Mutation {
mutateSomething(something: SomethingInput): SomethingOutput
}
input SomethingInput {
thisThing: String
}
type SomethingOutput {
thisThing: String
}
`,
query: `
mutation ExampleMutation($something: SomethingInput) {
mutationSomething(something: $something) {
thisThing
thatThing
}
}
`,
variables: {
something: {
thisThing: "Apple",
thatThing: "Orange"
}
}
});
console.log(maskedQuery);
console.log(maskedVariables);This will print...
mutation ExampleMutation($something: SomethingInput) {
mutationSomething(something: $something) {
thisThing
}
}and
{
something: {
thisThing: "Apple",
}
}To support filtering of both query and input variables, the following usage has been deprecated as of v0.1.0. This method of invoking graphql-mask is still supported, but wil result in warning messages.
const result = graphqlMask(
`
type Query {
something: String!
somethingElse: Int
}
`,
`
query ExampleQuery {
something
somethingElse
somethingNotInSchema
}
`
);
console.log(result);This will print...
query ExampleQuery {
something
somethingElse
}
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "github-actions[bot]")
![greenkeeper[bot] avatar](https://avatars.githubusercontent.com/in/505?v=4 "greenkeeper[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent