Dagger.FieldTypeDef (dagger v0.19.6)

View Source

A definition of a field on a custom object defined in a Module.

A field on an object has a static value, as opposed to a function on an object whose value is computed by invoking code (and can accept arguments).

Summary

Types

t()

Functions

deprecated(field_type_def)

The reason this enum member is deprecated, if any.

description(field_type_def)

A doc string for the field, if any.

id(field_type_def)

A unique identifier for this FieldTypeDef.

name(field_type_def)

The name of the field in lowerCamelCase format.

source_map(field_type_def)

The location of this field declaration.

type_def(field_type_def)

The type of the field.

Types

t()

@type t() :: %Dagger.FieldTypeDef{client: term(), query_builder: term()}

Functions

deprecated(field_type_def)

@spec deprecated(t()) :: {:ok, String.t() | nil} | {:error, term()}

The reason this enum member is deprecated, if any.

description(field_type_def)

@spec description(t()) :: {:ok, String.t()} | {:error, term()}

A doc string for the field, if any.

id(field_type_def)

@spec id(t()) :: {:ok, Dagger.FieldTypeDefID.t()} | {:error, term()}

A unique identifier for this FieldTypeDef.

name(field_type_def)

@spec name(t()) :: {:ok, String.t()} | {:error, term()}

The name of the field in lowerCamelCase format.

source_map(field_type_def)

@spec source_map(t()) :: Dagger.SourceMap.t() | nil

The location of this field declaration.

type_def(field_type_def)

@spec type_def(t()) :: Dagger.TypeDef.t()

The type of the field.