View Source argo_graphql_type_definition (argo v1.0.6)

Summary

Types

Functions

Link to this function

add_directive_const(TypeDefinition, DirectiveConst)

View Source
-spec add_directive_const(TypeDefinition, DirectiveConst) -> TypeDefinition
                       when
                           TypeDefinition :: t(),
                           DirectiveConst :: argo_graphql_directive_const:t().
-spec builtin(TypeName) -> {ok, TypeDefinition} | error
           when TypeName :: argo_types:name(), TypeDefinition :: t().
Link to this function

enum_type_definition(Name, EnumTypeDefinition)

View Source
-spec enum_type_definition(Name, EnumTypeDefinition) -> TypeDefinition
                        when
                            Name :: argo_types:name(),
                            EnumTypeDefinition :: argo_graphql_enum_type_definition:t(),
                            TypeDefinition :: t().
Link to this function

find_field_definition(TypeDefinition, FieldName, ServiceDocument)

View Source
-spec find_field_definition(TypeDefinition, FieldName, ServiceDocument) -> {ok, FieldDefinition} | error
                         when
                             TypeDefinition :: t(),
                             FieldName :: argo_types:name(),
                             ServiceDocument :: argo_graphql_service_document:t(),
                             FieldDefinition :: argo_graphql_field_definition:t().
Link to this function

format(Formatter1, Type)

View Source
-spec format(Formatter1, Type :: t()) -> Formatter2
          when Formatter1 :: argo_graphql_formatter:t(), Formatter2 :: argo_graphql_formatter:t().
-spec format_error(dynamic(), dynamic()) -> dynamic().
Link to this function

from_language(LanguageTypeDefinition)

View Source
-spec from_language(LanguageTypeDefinition) -> TypeDefinition
                 when
                     LanguageTypeDefinition :: argo_graphql_language_type_definition:t(),
                     TypeDefinition :: t().
Link to this function

get_field_definition(TypeDefinition, FieldName, ServiceDocument)

View Source
-spec get_field_definition(TypeDefinition, FieldName, ServiceDocument) -> FieldDefinition
                        when
                            TypeDefinition :: t(),
                            FieldName :: argo_types:name(),
                            ServiceDocument :: argo_graphql_service_document:t(),
                            FieldDefinition :: argo_graphql_field_definition:t().
Link to this function

get_implementations(InterfaceTypeDefinition, ServiceDocument)

View Source
-spec get_implementations(InterfaceTypeDefinition, ServiceDocument) -> [TypeName]
                       when
                           InterfaceTypeDefinition :: t(),
                           ServiceDocument :: argo_graphql_service_document:t(),
                           TypeName :: argo_types:name().
Link to this function

get_shape(TypeDefinition, ServiceDocument)

View Source
-spec get_shape(TypeDefinition, ServiceDocument) -> Shape
             when
                 TypeDefinition :: t(),
                 ServiceDocument :: argo_graphql_service_document:t(),
                 Shape :: shape().
Link to this function

input_object_type_definition(Name, InputObjectTypeDefinition)

View Source
-spec input_object_type_definition(Name, InputObjectTypeDefinition) -> TypeDefinition
                                when
                                    Name :: argo_types:name(),
                                    InputObjectTypeDefinition ::
                                        argo_graphql_input_object_type_definition:t(),
                                    TypeDefinition :: t().
Link to this function

interface_type_definition(Name, InterfaceTypeDefinition)

View Source
-spec interface_type_definition(Name, InterfaceTypeDefinition) -> TypeDefinition
                             when
                                 Name :: argo_types:name(),
                                 InterfaceTypeDefinition ::
                                     argo_graphql_interface_type_definition:t(),
                                 TypeDefinition :: t().
Link to this function

is_ambiguous(Definition)

View Source
-spec is_ambiguous(Definition) -> boolean() when Definition :: t().
Schema extensions without additional operation type definitions must not be followed by a { (such as a query shorthand) to avoid parsing ambiguity. The same limitation applies to the type definitions and extensions below.
Link to this function

is_input_type(Definition)

View Source
-spec is_input_type(Definition) -> boolean() when Definition :: t().
Link to this function

object_type_definition(Name, ObjectTypeDefinition)

View Source
-spec object_type_definition(Name, ObjectTypeDefinition) -> TypeDefinition
                          when
                              Name :: argo_types:name(),
                              ObjectTypeDefinition :: argo_graphql_object_type_definition:t(),
                              TypeDefinition :: t().
Link to this function

scalar_type_definition(Name, ScalarTypeDefinition)

View Source
-spec scalar_type_definition(Name, ScalarTypeDefinition) -> TypeDefinition
                          when
                              Name :: argo_types:name(),
                              ScalarTypeDefinition :: argo_graphql_scalar_type_definition:t(),
                              TypeDefinition :: t().
Link to this function

set_description(TypeDefinition, OptionDescription)

View Source
-spec set_description(TypeDefinition, OptionDescription) -> TypeDefinition
                   when
                       TypeDefinition :: t(),
                       OptionDescription :: none | {some, unicode:unicode_binary()}.
Link to this function

union_type_definition(Name, UnionTypeDefinition)

View Source
-spec union_type_definition(Name, UnionTypeDefinition) -> TypeDefinition
                         when
                             Name :: argo_types:name(),
                             UnionTypeDefinition :: argo_graphql_union_type_definition:t(),
                             TypeDefinition :: t().