dagger_gleam - v0.1.0

dagger/dsl/type_def

Types

Opts

</> 
pub type Opts {
  Opts(
    description: option.Option(String),
    source_map: option.Option(types.SourceMap),
    value: option.Option(String),
    deprecated: option.Option(String),
  )
}

Constructors

Values

as_enum

</> 
pub fn as_enum(parent: types.TypeDef) -> types.EnumTypeDef

If kind is ENUM, the enum-specific type definition. If kind is not ENUM, this will be null.

as_input

</> 
pub fn as_input(parent: types.TypeDef) -> types.InputTypeDef

If kind is INPUT, the input-specific type definition. If kind is not INPUT, this will be null.

as_interface

</> 
pub fn as_interface(
  parent: types.TypeDef,
) -> types.InterfaceTypeDef

If kind is INTERFACE, the interface-specific type definition. If kind is not INTERFACE, this will be null.

as_list

</> 
pub fn as_list(parent: types.TypeDef) -> types.ListTypeDef

If kind is LIST, the list-specific type definition. If kind is not LIST, this will be null.

as_object

</> 
pub fn as_object(parent: types.TypeDef) -> types.ObjectTypeDef

If kind is OBJECT, the object-specific type definition. If kind is not OBJECT, this will be null.

as_scalar

</> 
pub fn as_scalar(parent: types.TypeDef) -> types.ScalarTypeDef

If kind is SCALAR, the scalar-specific type definition. If kind is not SCALAR, this will be null.

deprecated

</> 
pub fn deprecated(opts: Opts, val: String) -> Opts

description

</> 
pub fn description(opts: Opts, val: String) -> Opts

id

</> 
pub fn id(parent: types.TypeDef) -> types.TypeDef

A unique identifier for this TypeDef.

kind

</> 
pub fn kind(
  parent: types.TypeDef,
  client client: types.Client,
  then handler: fn(Result(types.TypeDefKind, types.QueryError)) -> a,
) -> a

The kind of type this is (e.g. primitive, list, object).

none

</> 
pub fn none(opts: Opts) -> Opts

optional

</> 
pub fn optional(
  parent: types.TypeDef,
  client client: types.Client,
  then handler: fn(Result(Bool, types.QueryError)) -> a,
) -> a

Whether this type can be set to null. Defaults to false.

source_map

</> 
pub fn source_map(opts: Opts, val: types.SourceMap) -> Opts

type_def

</> 
pub fn type_def() -> types.TypeDef

value

</> 
pub fn value(opts: Opts, val: String) -> Opts

with_constructor

</> 
pub fn with_constructor(
  parent: types.TypeDef,
  function function: types.Function,
) -> types.TypeDef

Adds a function for constructing a new instance of an Object TypeDef, failing if the type is not an object.

with_enum

</> 
pub fn with_enum(
  parent: types.TypeDef,
  name name: String,
  with with_fn: fn(Opts) -> Opts,
) -> types.TypeDef

Returns a TypeDef of kind Enum with the provided name. Note that an enum’s values may be omitted if the intent is only to refer to an enum. This is how functions are able to return their own, or any other circular reference.

with_enum_member

</> 
pub fn with_enum_member(
  parent: types.TypeDef,
  name name: String,
  with with_fn: fn(Opts) -> Opts,
) -> types.TypeDef

Adds a static value for an Enum TypeDef, failing if the type is not an enum.

with_field

</> 
pub fn with_field(
  parent: types.TypeDef,
  name name: String,
  type_def type_def: types.TypeDef,
  with with_fn: fn(Opts) -> Opts,
) -> types.TypeDef

Adds a static field for an Object TypeDef, failing if the type is not an object.

with_function

</> 
pub fn with_function(
  parent: types.TypeDef,
  function function: types.Function,
) -> types.TypeDef

Adds a function for an Object or Interface TypeDef, failing if the type is not one of those kinds.

with_interface

</> 
pub fn with_interface(
  parent: types.TypeDef,
  name name: String,
  with with_fn: fn(Opts) -> Opts,
) -> types.TypeDef

Returns a TypeDef of kind Interface with the provided name.

with_kind

</> 
pub fn with_kind(
  parent: types.TypeDef,
  kind kind: types.TypeDefKind,
) -> types.TypeDef

Sets the kind of the type.

with_list_of

</> 
pub fn with_list_of(
  parent: types.TypeDef,
  element_type element_type: types.TypeDef,
) -> types.TypeDef

Returns a TypeDef of kind List with the provided type for its elements.

with_object

</> 
pub fn with_object(
  parent: types.TypeDef,
  name name: String,
  with with_fn: fn(Opts) -> Opts,
) -> types.TypeDef

Returns a TypeDef of kind Object with the provided name. Note that an object’s fields and functions may be omitted if the intent is only to refer to an object. This is how functions are able to return their own object, or any other circular reference.

with_optional

</> 
pub fn with_optional(
  parent: types.TypeDef,
  optional optional: Bool,
) -> types.TypeDef

Sets whether this type can be set to null.

with_scalar

</> 
pub fn with_scalar(
  parent: types.TypeDef,
  name name: String,
  with with_fn: fn(Opts) -> Opts,
) -> types.TypeDef

Returns a TypeDef of kind Scalar with the provided name.

✨ Search Document