com.walmartlabs.lacinia.selection
Protocols for selection-related objects accessible from the [[selection]] function, and as well as the schema type objects navigable to from the selection, or via [[select-type]].
Protocols for selection-related objects accessible from the [[selection]] function, and as well as the schema type objects navigable to from the selection, or via [[select-type]].
ArgumentDefcljprotocol
An argument definition, implements Type and QualifiedName.
An argument definition, implements [[Type]] and [[QualifiedName]].
ArgumentDefscljprotocol
Definition of arguments to a [[Field]].
Definition of arguments to a [[Field]].
argument-defsclj
(argument-defs element)Returns a map of keyword name to [[Argument]], or nil.
Returns a map of keyword name to [[Argument]], or nil.
Argumentscljprotocol
Implemented by Directive.
Implemented by [[Directive]].
argumentsclj
(arguments element)Returns a map of keyword name to argument value. May return nil if no arguments.
The value may reflect query variables or argument defaults.
Returns a map of keyword name to argument value. May return nil if no arguments. The value may reflect query variables or argument defaults.
Directivecljprotocol
Implements Arguments.
Implements [[Arguments]].
directive-typeclj
(directive-type d)Returns the type of directive as a keyword.
Returns the type of directive as a keyword.
Directivescljprotocol
An element that may contain directives.
An element that may contain directives.
directivesclj
(directives element)Returns a map of directives for this element; keys are keywords identifying
the directive, values are a seq of Directive of that type (directives
are inherently repeatable).
May return nil.
Returns a map of directives for this element; keys are keywords identifying the directive, values are a seq of [[Directive]] of that type (directives are inherently repeatable). May return nil.
FieldDefcljprotocol
A field within a TypeDef. Implements Type, Directives, ArgumentDefs, and QualifiedName.
A field within a [[TypeDef]]. Implements [[Type]], [[Directives]], [[ArgumentDefs]], and [[QualifiedName]].
field-nameclj
(field-name fs)Returns the name of the field (as an unqualified keyword).
Returns the name of the field (as an unqualified keyword).
Fieldscljprotocol
Implemented by the :object and :interface TypeDef kinds to expose the type's fields.
Implemented by the :object and :interface [[TypeDef]] kinds to expose the type's fields.
fieldsclj
(fields type)Returns a map of keyword to [[Field]].
Returns a map of keyword to [[Field]].
FieldSelectioncljprotocol
A SelectionSet that extracts a value from a field and records it into the
result as a name or alias; for non-scalar types, may have sub-selections.
Also implements Arguments, and Directives.
Directives here are the directives on the selection (the executable directives); access the underlying field to get the type system directives.
A [[SelectionSet]] that extracts a value from a field and records it into the result as a name or alias; for non-scalar types, may have sub-selections. Also implements [[Arguments]], and [[Directives]]. Directives here are the directives on the selection (the executable directives); access the underlying field to get the type system directives.
alias-nameclj
(alias-name fs)Returns the alias for the field selection, or name of the field.
Returns the alias for the field selection, or name of the field.
fieldclj
(field fs)Returns the definition of the FieldDef selected.
Returns the definition of the [[FieldDef]] selected.
root-value-typeclj
(root-value-type fs)Returns the root value TypeDef for this field (the actual type may
include list or non-null qualifiers).
Returns the root value [[TypeDef]] for this field (the actual type may include `list` or `non-null` qualifiers).
Kindcljprotocol
A Kind is a root type with qualifiers (list, or non-null). A root kind identifies a TypeDef.
A Kind can be converted to a GraphQL type string.
A Kind is a root type with qualifiers (list, or non-null). A root kind identifies a [[TypeDef]]. A Kind can be converted to a GraphQL type string.
as-type-stringclj
(as-type-string kind)Returns the kind as an GraphQL language string, e.g. [String!].
Returns the kind as an GraphQL language string, e.g. `[String!]`.
kind-typeclj
(kind-type kind)One of :non-null, :list, or :root.
One of :non-null, :list, or :root.
of-kindclj
(of-kind kind)Returns the nested Kind, or nil if a root kind.
Returns the nested [[Kind]], or nil if a root kind.
of-typeclj
(of-type kind)Returns the root TypeDef, or nil if not a root kind.
Returns the root [[TypeDef]], or nil if not a root kind.
QualifiedNamecljprotocol
qualified-nameclj
(qualified-name named)Returns a keyword whose namespace is the containing element; e.g., :User/idfor the id field of the User type.
Returns a keyword whose namespace is the containing element; e.g., `:User/id `for the `id` field of the `User` type.
SelectionSetcljprotocol
A selection that may contain sub-selections.
A selection that may contain sub-selections.
selection-kindclj
(selection-kind selection)The type of selection: either :field, :inline-fragment or :named-fragment.
For :field, the FieldSelection protocol will also be implemented.
The type of selection: either :field, :inline-fragment or :named-fragment. For :field, the [[FieldSelection]] protocol will also be implemented.
selectionsclj
(selections selection)Returns a seq of sub-selections (also SelectionSets) of this selection.
May be nil for a field that selects a scalar.
Returns a seq of sub-selections (also SelectionSets) of this selection. May be nil for a field that selects a scalar.
Typecljprotocol
For a typed element, such as a [[Field]] or an ArgumentDef, details the
schema type.
For a typed element, such as a [[Field]] or an [[ArgumentDef]], details the schema type.
kindclj
(kind element)The Kind of the element.
The [[Kind]] of the element.
root-typeclj
(root-type element)Returns the root TypeDef of the element.
Returns the root [[TypeDef]] of the element.
root-type-nameclj
(root-type-name element)Returns the keyword name of root type of the element.
Returns the keyword name of root type of the element.
TypeDefcljprotocol
A type defined in a GraphQL schema. Implements the Directives protocol as well.
A type defined in a GraphQL schema. Implements the [[Directives]] protocol as well.
type-categoryclj
(type-category type)Returns the category of the type, one of: :object, :union, :interface, :scalar, or :enum.
Returns the category of the type, one of: `:object`, `:union`, `:interface`, `:scalar`, or `:enum`.
type-nameclj
(type-name type)Returns the name of the type, as a keyword.
Returns the name of the type, as a keyword.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close