GiraphQL
Search…
Directives
A plugin for using schema directives with schemas generated by GiraphQL.
Schema Directives are not intended to be used with code first schemas, but there is a large existing community with several very useful directives based
Usage
Install
1
yarn add @giraphql/plugin-directives
Copied!
Setup
1
import DirectivePlugin from '@giraphql/plugin-directives';
2
import { rateLimitDirective } from 'graphql-rate-limit-directive';
3
​
4
const builder = new SchemaBuilder<
5
Directives: {
6
rateLimit: {
7
locations: 'OBJECT' | 'FIELD_DEFINITION';
8
args: { limit: number, duration: number };
9
},
10
useGraphQLToolsUnorderedDirectives: true,
11
>({
12
plugins: [DirectivePlugin],
13
});
14
​
15
builder.queryType({
16
directives: {
17
rateLimit: { limit: 5, duration: 60 },
18
},
19
fields: (t) => ({
20
hello: t.string({ resolve: () => 'world' });
21
});
22
});
23
​
24
const { rateLimitDirectiveTransformer } = rateLimitDirective();
25
const schema = rateLimitDirectiveTransformer(builder.toSchema({}));
Copied!
The directives plugin allows you to define types for the directives your schema will use the
SchemaTypes parameter. Each directive can define a set of locations the directive can appear, and an object type representing the arguments the directive accepts.The valid locations for directives are:
ARGUMENT_DEFINITION|ENUM_VALUEENUMFIELD_DEFINITIONINPUT_FIELD_DEFINITIONINPUT_OBJECTINTERFACEOBJECTSCALARSCHEMAUNION
GiraphQL does not apply the directives itself, this plugin simply adds directive information to the extensions property of the underlying GraphQL type so that it can be consumed by other tools like
graphql-tools.By default this plugin uses the format that Gatsby uses (described here). This format was not supported by older versions of
graphql-tools. To support older versions of graphql-tools or directives that provide a schema visitor based on an older graphql-tools version like the rate-limit directive from the example above you can set the useGraphQLToolsUnorderedDirectives option. This option does not preserve the order that directives are defined in. This will be okay for most cases, but may cause issues if your directives need to be applied in a specific order.To define directives on your fields or types, you can add a
directives property in any of the supported locations using one of the following 2 formats:1
{
2
directives: [
3
{
4
name: "validation",
5
args: {
6
regex: "/abc+/"
7
}
8
},
9
{
10
name: "required",
11
args: {},
12
}
13
],
14
// or
15
directives: {
16
validation: {
17
regex: "/abc+/"
18
},
19
required: {}
20
}
21
}
Copied!
Each of these applies the same 2 directives. The first format is preferred, especially when using directives that are sensitive to ordering, or can be repeated multiple times for the same location.
Last modified 2mo ago