Exciting news!Announcing our $4.6M Series Seed. Learn more
Socket
LoveBlogFAQ
Install
Log in

@pothos/plugin-directives

Package Overview
Dependencies
0
Maintainers
1
Versions
12
Issues
File Explorer

Advanced tools

@pothos/plugin-directives

Directive plugin for Pothos, enables using graphql-tools based directives with Pothos

    3.4.0latest

Version published
Maintainers
1
Yearly downloads
2,473

Weekly downloads

Changelog

Source

@pothos/[email protected]

Minor Changes

  • ecb2714c: Add types entry to export map in package.json and update dev dependencies

    This should fix compatibility with typescripts new "moduleResolution": "node12"

Readme

Source

Directives Plugin

A plugin for using schema directives with schemas generated by Pothos.

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

yarn add @pothos/plugin-directives

Setup

import DirectivePlugin from '@pothos/plugin-directives'; import { rateLimitDirective } from 'graphql-rate-limit-directive'; const builder = new SchemaBuilder<{ Directives: { rateLimit: { locations: 'OBJECT' | 'FIELD_DEFINITION'; args: { limit: number, duration: number }; }; }; }>({ plugins: [DirectivePlugin], useGraphQLToolsUnorderedDirectives: true, }); builder.queryType({ directives: { rateLimit: { limit: 5, duration: 60 }, }, fields: (t) => ({ hello: t.string({ resolve: () => 'world' }); }); }); const { rateLimitDirectiveTransformer } = rateLimitDirective(); const schema = rateLimitDirectiveTransformer(builder.toSchema({}));

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_VALUE
  • ENUM
  • FIELD_DEFINITION
  • INPUT_FIELD_DEFINITION
  • INPUT_OBJECT
  • INTERFACE
  • OBJECT
  • SCALAR
  • SCHEMA
  • UNION

Pothos 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:

{ directives: [ { name: "validation", args: { regex: "/abc+/" } }, { name: "required", args: {}, } ], // or directives: { validation: { regex: "/abc+/" }, required: {} } }

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.

Keywords

Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc