Liking cljdoc? Tell your friends :D

com.walmartlabs.lacinia.protocols

Protocols for selection-related objects accessible from the [[selection]] function, and as well as the schema type objects navigable to from the selection.

Protocols for selection-related objects accessible from the [[selection]] function, and
as well as the schema type objects navigable to from the selection.
raw docstring

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.
raw docstring

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.
raw docstring

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.
raw docstring

Fieldcljprotocol

A field within a Type. Implements Directives and QualifiedName.

A field within a [[Type]].  Implements [[Directives]] and [[QualifiedName]].

root-type-nameclj

(root-type-name field)

Returns the keyword name of root type of the field.

Returns the keyword name of root type of the field.
raw docstring

Fieldscljprotocol

Implemented by the :object and :interface Type kinds to expose fields.

Implemented by the :object and :interface [[Type]] kinds to expose fields.

fieldsclj

(fields type)

Returns a map of keyword to Field.

Returns a map of keyword to [[Field]].
raw docstring

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 QualifiedName, Arguments, and 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 [[QualifiedName]], [[Arguments]], and [[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.

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).

root-value-typeclj

(root-value-type fs)

Returns the root value type for this field (the actual type may include list or non-null qualifiers).

Returns the root value type for this field (the actual type may
include `list` or `non-null` qualifiers).
raw docstring

QualifiedNamecljprotocol

qualified-nameclj

(qualified-name named)

Returns a keyword whose namespace is the containing element; e.g., :User/id for 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

An selection that may contain sub-selections.

An 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.
raw docstring

Typecljprotocol

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-kindclj

(type-kind type)

Returns the kind of type, one of: :object, :union, :interface, :scalar, or :enum.

Returns the kind of 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.
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close