SCALAR
String
The String
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.
link GraphQL Schema definition
- scalar String
link Require by
- AttSpecAttribute Specification
- BlockPart of a sequence, roughly equivalent to a USFM paragraph
- cellA table cell
- cIndexA chapter index entry
- cvNavigationVarious answers to 'previous' and 'next' with respect to a verse
- cvVerseElement
- DocSetA collection of documents that share the same set of selector values
- DocumentA document, typically corresponding to USFM for one book
- idPartsType-dependent parts of the ID header
- InputItemObjectItem for arguments
- InputKeyValueInput Key/Value Object
- inputSelectorSpecInput specification of a selector
- ItemItem
- ItemGroupA collection of items, with scope context
- KeyMatchesKey/Regex tuple
- KeyValueKey/Value tuple
- KeyValuesInput Key/Values Object
- kvEntryKey/Items tuple
- kvSequenceA contiguous flow of content for key-values
- Mutationnull
- nodeA tree node
- origMapped verse information
- QueryThe top level of Proskomma queries
- regexIndexInformation about a regex match on an enum
- rowEqualsSpecRow Equals Specification
- rowMatchSpecRow Match Specification
- selectorSpecSpecification of a selector
- SequenceA contiguous flow of content
- tableSequenceA contiguous flow of content for a table
- treeSequenceThe nodes of a tree
- verseNumberInformation about a verse number (which may be part of a verse range)
- verseRangeInformation about a verse range (which may only cover one verse)
- __DirectiveA 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.
- __EnumValueOne 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.
- __FieldObject 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.
- __InputValueArguments 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.
- __SchemaA GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.
- __TypeThe 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, description and optional `specifiedByURL`, 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.