Type

sealed trait Type extends Product

A GraphQL type definition.

trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def <:<(other: Type): Boolean

true if this type is a subtype of other.

true if this type is a subtype of other.

def =:=(other: Type): Boolean

Is this type equivalent to other.

Is this type equivalent to other.

Note that plain == will distinguish types from type aliases, which is typically not desirable, so =:= is usually the most appropriate comparison operator.

If the underlying type of this type is a scalar or an enum then yield it otherwise yield None.

If the underlying type of this type is a scalar or an enum then yield it otherwise yield None.

Strip off aliases

Strip off aliases

true if a non-TypeRef or a TypeRef to a defined type

true if a non-TypeRef or a TypeRef to a defined type

def field(fieldName: String): Option[Type]

Yield the type of the field of this type named fieldName or None if there is no such field.

Yield the type of the field of this type named fieldName or None if there is no such field.

def hasField(fieldName: String): Boolean

true if this type has a field named fieldName, false otherwise.

true if this type has a field named fieldName, false otherwise.

Is this type a leaf type?

Is this type a leaf type?

true if after stripping of aliases the underlying type a scalar or an enum, false otherwise.

Is this type a list.

Is this type a list.

Is this type nullable?

Is this type nullable?

Is the underlying of this type a leaf type?

Is the underlying of this type a leaf type?

Strip off all aliases, nullability and enclosing list types until an underlying leaf type is reached, in which case yield true, or an a object, interface or union type which is reached, in which case yield false.

The element type of this type.

The element type of this type.

If this type is is a list, yield the non-list underlying type. Otherwise yield None.

def list: Type

This type if it is a (nullable) list, ListType(this) otherwise.

This type if it is a (nullable) list, ListType(this) otherwise.

def nominal_=:=(other: Type): Boolean

A non-nullable version of this type.

A non-nullable version of this type.

If this type is nullable, yield the non-nullable underlying type. Otherwise yield this type.

This type if it is nullable, Nullable(this) otherwise.

This type if it is nullable, Nullable(this) otherwise.

def path(fns: List[String]): Option[Type]

Yield the type of the field at the end of the path fns starting from this type, or None if there is no such field.

Yield the type of the field at the end of the path fns starting from this type, or None if there is no such field.

Does the path fns from this type specify multiple values.

Does the path fns from this type specify multiple values.

true if navigating through the path fns from this type might specify 0 or more values. This will be the case if the path passes through at least one field of a List type.

Does the path fns from this type specify a nullable type.

Does the path fns from this type specify a nullable type.

true if navigating through the path fns from this type might specify an optional value. This will be the case if the path passes through at least one field of a nullable type.

def underlyingField(fieldName: String): Option[Type]

Yield the type of the field named fieldName of the object type underlying this type.

Yield the type of the field named fieldName of the object type underlying this type.

Strip off all aliases, nullability and enclosing list types until an underlying object type is reached which has a field named fieldName, in which case yield the type of that field; if there is no such field, yields None.

Yield the leaf type underlying this type.

Yield the leaf type underlying this type.

Strip off all aliases, nullability and enclosing list types until an underlying leaf type is reached, in which case yield it, or an a object, interface or union type which is reached, in which case yield None.

Yield the object type underlying this type.

Yield the object type underlying this type.

Strip off all aliases, nullability and enclosing list types until an underlying object type is reached, in which case yield it, or a non-object type which isn't further reducible is reached, in which case yield None.

def variantField(fieldName: String): Boolean

true if this type has a field named fieldName which is undefined in some interface it implements

true if this type has a field named fieldName which is undefined in some interface it implements

def withField[T](fieldName: String)(body: Type => Result[T]): Result[T]
def withUnderlyingField[T](fieldName: String)(body: Type => Result[T]): Result[T]

Inherited methods

def canEqual(that: Any): Boolean
Inherited from:
Equals
Inherited from:
Product
def productElement(n: Int): Any
Inherited from:
Product
Inherited from:
Product
Inherited from:
Product
Inherited from:
Product