graphqldoc

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> <meta http-equiv="x-ua-compatible" content="ie=edge" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet"> <link type="text/css" rel="stylesheet" href="./styles/graphdoc.css" /> <title>String | Pokémon GraphQL API</title> <link href="https://fonts.googleapis.com/css?family=Ubuntu+Mono:400,700" rel="stylesheet"><link type="text/css" rel="stylesheet" href="./assets/code.css" /><script src="./assets/line-link.js"></script><link type="text/css" rel="stylesheet" href="./assets/require-by.css" /> </head> <body class="slds-scrollable--y"> <nav class="slds-grid slds-grid--vertical slds-col--rule-right"> <header class="slds-p-around--medium slds-col slds-shrik slds-grow-none"> <button class="slds-button slds-button--icon slds-float--right js-toggle-navigation less-than-medium"> <i class="material-icons">close</i> </button> <a href="https://github.com/lucasbento/graphql-pokemon" target="_blank" style="display:block;padding:1rem 35%"><img src="https://raw.githubusercontent.com/lucasbento/graphql-pokemon/master/content/logo.png" /></a> <div class="slds-p-top--small"> <input id="type-search" type="text" placeholder="Search a type" autofocus="" class="slds-input" /> </div> </header> <div id="navication-scroll" class="slds-scrollable--y slds-col slds-grow"> <div class="slds-grid slds-grid--vertical slds-navigation-list--vertical"> <h4 class="slds-text-title--caps slds-p-around--medium">Schema</h4> <ul> <li title="Query"> <a href="query.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate"> Query </a> </li> </ul> </div> <div class="slds-grid slds-grid--vertical slds-navigation-list--vertical"> <h4 class="slds-text-title--caps slds-p-around--medium">Scalars</h4> <ul> <li title="Boolean"> <a href="boolean.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate"> Boolean </a> </li> <li title="Float"> <a href="float.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate"> Float </a> </li> <li title="ID"> <a href="id.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate"> ID </a> </li> <li title="Int"> <a href="int.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate"> Int </a> </li> <li class="slds-is-active" title="String"> <a href="string.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate"> String </a> </li> </ul> </div> <div class="slds-grid slds-grid--vertical slds-navigation-list--vertical"> <h4 class="slds-text-title--caps slds-p-around--medium">Enums</h4> <ul> <li title="__DirectiveLocation"> <a href="directivelocation.spec.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate"> __DirectiveLocation </a> </li> <li title="__TypeKind"> <a href="typekind.spec.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate"> __TypeKind </a> </li> </ul> </div> <div class="slds-grid slds-grid--vertical slds-navigation-list--vertical"> <h4 class="slds-text-title--caps slds-p-around--medium">Objects</h4> <ul> <li title="Attack"> <a href="attack.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate"> Attack </a> </li> <li title="Pokemon"> <a href="pokemon.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate"> Pokemon </a> </li> <li title="PokemonAttack"> <a href="pokemonattack.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate"> PokemonAttack </a> </li> <li title="PokemonDimension"> <a href="pokemondimension.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate"> PokemonDimension </a> </li> <li title="PokemonEvolutionRequirement"> <a href="pokemonevolutionrequirement.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate"> PokemonEvolutionRequirement </a> </li> <li title="__Directive"> <a href="directive.spec.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate"> __Directive </a> </li> <li title="__EnumValue"> <a href="enumvalue.spec.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate"> __EnumValue </a> </li> <li title="__Field"> <a href="field.spec.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate"> __Field </a> </li> <li title="__InputValue"> <a href="inputvalue.spec.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate"> __InputValue </a> </li> <li title="__Schema"> <a href="schema.spec.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate"> __Schema </a> </li> <li title="__Type"> <a href="type.spec.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate"> __Type </a> </li> </ul> </div> <div class="slds-grid slds-grid--vertical slds-navigation-list--vertical"> <h4 class="slds-text-title--caps slds-p-around--medium">Directives</h4> <ul> <li title="deprecated"> <a href="deprecated.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate"> deprecated </a> </li> <li title="include"> <a href="include.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate"> include </a> </li> <li title="skip"> <a href="skip.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate"> skip </a> </li> </ul> </div> </div> </nav> <main><section class="title slds-theme--inverse"> <div class="container slds-grid"> <div> <button class="slds-button js-toggle-navigation less-than-medium"> <i class="material-icons slds-button__icon slds-button__icon--left">menu</i> <span class="slds-text-title--caps">Types</span> </button> </div> <div class="slds-col--bump-left"> <a class="slds-button js-toggle-navigation" target="_blank" href="https://graphql-pokemon.now.sh/"> <span class="slds-text-title--caps">GraphiQL</span> <i class="material-icons slds-button__icon slds-button__icon--rigth">open_in_new</i> </a> </div> </div> <div class="container"> <p class="slds-text-title--caps slds-text-color--weak">SCALAR</p> <h1 class="slds-text-heading--large">String</h1> <div class="slds-text-body--regular"><p>The <code>String</code> scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.</p> </div> </div> </section> <section> <div class="container"> <h2 id="graphql-schema-definition" class="graphdoc-section__title slds-text-heading--medium slds-m-top--small"> <a href="#graphql-schema-definition"> <i class="material-icons">link</i> </a> GraphQL Schema definition </h2> <code class="highlight"><table class="code"><tbody><tr class="row"><td id="L1" class="td-index">1</td><td id="LC1" class="td-code"><span class="keyword operator ts">scalar</span> <span class="identifier">String</span></td></tr></tbody></table></code> </div> </section> <section> <div class="container"> <h2 id="required-by" class="graphdoc-section__title slds-text-heading--medium slds-m-top--small"> <a href="#required-by"> <i class="material-icons">link</i> </a> Required by </h2> <ul class="require-by"><li><a href="attack.doc.html" title="Attack - Represents a Pokémon's attack types">Attack<em>Represents a Pokémon's attack types</em></a><li><li><a href="pokemon.doc.html" title="Pokemon - Represents a Pokémon">Pokemon<em>Represents a Pokémon</em></a><li><li><a href="pokemondimension.doc.html" title="PokemonDimension - Represents a Pokémon's dimensions">PokemonDimension<em>Represents a Pokémon's dimensions</em></a><li><li><a href="pokemonevolutionrequirement.doc.html" title="PokemonEvolutionRequirement - Represents a Pokémon's requirement to evolve">PokemonEvolutionRequirement<em>Represents a Pokémon's requirement to evolve</em></a><li><li><a href="query.doc.html" title="Query - Query any Pokémon by number or name">Query<em>Query any Pokémon by number or name</em></a><li><li><a href="directive.spec.html" title="__Directive - A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. 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.">__Directive<em>A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. 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.</em></a><li><li><a href="enumvalue.spec.html" title="__EnumValue - One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.">__EnumValue<em>One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.</em></a><li><li><a href="field.spec.html" title="__Field - Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.">__Field<em>Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.</em></a><li><li><a href="inputvalue.spec.html" title="__InputValue - Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.">__InputValue<em>Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.</em></a><li><li><a href="type.spec.html" title="__Type - The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.">__Type<em>The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.</em></a><li></ul> </div> </section> <footer> <div class="container slds-p-around--large"> <p class="slds-text-align--right slds-text-title--caps"> Generated with <a href="https://github.com/CodeSignal/graphqldoc#readme" target="_blank">graphqldoc 2.5.1</a> </p> </div> </footer> </main> <script src="./scripts/focus-active.js"></script> <script src="./scripts/filter-types.js"></script> <script src="./scripts/toggle-navigation.js"></script> <script> (function (i, s, o, g, r, a, m) { i['GoogleAnalyticsObject'] = r; i[r] = i[r] || function () { (i[r].q = i[r].q || []).push(arguments) }, i[r].l = 1 * new Date(); a = s.createElement(o), m = s.getElementsByTagName(o)[0]; a.async = 1; a.src = g; m.parentNode.insertBefore(a, m) })(window, document, 'script', 'https://www.google-analytics.com/analytics.js', 'ga'); ga('create', 'UA-54154153-2', 'auto'); ga('send', 'pageview'); </script> </body>