public/graphql-docs/object/__directive/index.html
<!DOCTYPE html><html lang="en"> <head> <meta charset="utf-8"> <meta name="description" content="__Directive GraphQL documentation"> <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no"> <title>__Directive</title> <link rel="stylesheet" href="/graphql-docs/assets/style.css"> <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/3.2.2/anchor.min.js"></script> <script> // Add anchors on DOMContentLoaded document.addEventListener("DOMContentLoaded", function(event) { anchors.options = { placement: 'left', visible: 'hover', icon: '¶' }; anchors.add('h2, h3, h4, h5, h6, .anchored'); }); </script> </head> <body> <div id="wrap"> <div id="header"> </div> <div id="sidebar"> <ul class="categories"> <li> <ul class="menu-root"> <li> <a href="/graphql-docs">GraphQL Reference</a> </ul> </li> <li> <p>Queries</p> <ul class="menu-root"> <li> <a href="/graphql-docs/operation/query/" class="sidebar-link"> Query </a> </li> <li> <a href="/graphql-docs/operation/mutation/" class="sidebar-link"> Mutation </a> </li> </ul> </li> <li> <p><a href="/graphql-docs/object">Objects</a></p> <ul class="menu-root"> <li> <a href="/graphql-docs/object/loginpayload/" class="sidebar-link"> LoginPayload </a> </li> <li> <a href="/graphql-docs/object/signoutpayload/" class="sidebar-link"> SignOutPayload </a> </li> <li> <a href="/graphql-docs/object/signuppayload/" class="sidebar-link"> SignUpPayload </a> </li> <li> <a href="/graphql-docs/object/user/" class="sidebar-link"> User </a> </li> <li> <a href="/graphql-docs/object/validationerrors/" class="sidebar-link"> ValidationErrors </a> </li> <li> <a href="/graphql-docs/object/__directive/" class="sidebar-link"> __Directive </a> </li> <li> <a href="/graphql-docs/object/__enumvalue/" class="sidebar-link"> __EnumValue </a> </li> <li> <a href="/graphql-docs/object/__field/" class="sidebar-link"> __Field </a> </li> <li> <a href="/graphql-docs/object/__inputvalue/" class="sidebar-link"> __InputValue </a> </li> <li> <a href="/graphql-docs/object/__schema/" class="sidebar-link"> __Schema </a> </li> <li> <a href="/graphql-docs/object/__type/" class="sidebar-link"> __Type </a> </li> </ul> </li> <li> <p><a href="/graphql-docs/operation/mutation">Mutations</a></p> <ul class="menu-root"> <li> <a href="/graphql-docs/mutation/login/" class="sidebar-link"> login </a> </li> <li> <a href="/graphql-docs/mutation/signout/" class="sidebar-link"> signOut </a> </li> <li> <a href="/graphql-docs/mutation/signup/" class="sidebar-link"> signUp </a> </li> </ul> </li> <li> <p><a href="/graphql-docs/interface">Interfaces</a></p> <ul class="menu-root"> </ul> </li> <li> <p><a href="/graphql-docs/enum">Enums</a></p> <ul class="menu-root"> <li> <a href="/graphql-docs/enum/__directivelocation/" class="sidebar-link"> __DirectiveLocation </a> </li> <li> <a href="/graphql-docs/enum/__typekind/" class="sidebar-link"> __TypeKind </a> </li> </ul> </li> <li> <p><a href="/graphql-docs/union">Unions</a></p> <ul class="menu-root"> </ul> </li> <li> <p><a href="/graphql-docs/input_object">Input Objects</a></p> <ul class="menu-root"> </ul> </li> <li> <p><a href="/graphql-docs/scalar">Scalars</a></p> <ul class="menu-root"> <li> <a href="/graphql-docs/scalar/boolean/" class="sidebar-link"> Boolean </a> </li> <li> <a href="/graphql-docs/scalar/id/" class="sidebar-link"> ID </a> </li> <li> <a href="/graphql-docs/scalar/string/" class="sidebar-link"> String </a> </li> </ul> </li> <li> <p><a href="/graphql-docs/directive">Directives</a></p> <ul class="menu-root"> <li> <a href="/graphql-docs/directive/deprecated/" class="sidebar-link"> deprecated </a> </li> <li> <a href="/graphql-docs/directive/include/" class="sidebar-link"> include </a> </li> <li> <a href="/graphql-docs/directive/skip/" class="sidebar-link"> skip </a> </li> </ul> </li></ul> </div> <div id="content"> <h1><a id="__directive" class="anchor" href="#__directive" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>__Directive</h1><p>A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document.</p><p>In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.</p><h2><a id="fields" class="anchor" href="#fields" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Fields</h2><div class="field-entry "> <span id="name" class="field-name anchored">name (<code><a href="/graphql-docs/scalar/string">String!</a></code>)</span> <div class="description-wrapper"> </div></div><div class="field-entry "> <span id="description" class="field-name anchored">description (<code><a href="/graphql-docs/scalar/string">String</a></code>)</span> <div class="description-wrapper"> </div></div><div class="field-entry "> <span id="locations" class="field-name anchored">locations (<code><a href="/graphql-docs/enum/__directivelocation">[__DirectiveLocation!]!</a></code>)</span> <div class="description-wrapper"> </div></div><div class="field-entry "> <span id="args" class="field-name anchored">args (<code><a href="/graphql-docs/object/__inputvalue">[__InputValue!]!</a></code>)</span> <div class="description-wrapper"> </div></div><div class="field-entry "> <span id="onoperation" class="field-name anchored">onOperation (<code><a href="/graphql-docs/scalar/boolean">Boolean!</a></code>)</span> <div class="description-wrapper"><div class="deprecation-notice "> <span class="deprecation-title">Deprecation notice</span> <p>Use <code>locations</code>.</p></div> </div></div><div class="field-entry "> <span id="onfragment" class="field-name anchored">onFragment (<code><a href="/graphql-docs/scalar/boolean">Boolean!</a></code>)</span> <div class="description-wrapper"><div class="deprecation-notice "> <span class="deprecation-title">Deprecation notice</span> <p>Use <code>locations</code>.</p></div> </div></div><div class="field-entry "> <span id="onfield" class="field-name anchored">onField (<code><a href="/graphql-docs/scalar/boolean">Boolean!</a></code>)</span> <div class="description-wrapper"><div class="deprecation-notice "> <span class="deprecation-title">Deprecation notice</span> <p>Use <code>locations</code>.</p></div> </div></div> </div> <!-- mobile only --> <div id="mobile-header"> <a class="menu-button" onclick="document.body.classList.toggle('sidebar-open')"></a> <a class="logo" href="/graphql-docs"> </a> </div> <div id="mobile-shade"></div> </div> </body></html>