Dagger.Identifier (dagger v1.0.0-beta.19)

Copy Markdown View Source

A name parsed into words, which can be formatted in any casing.

Summary

Functions

Format the identifier in a casing.

A unique identifier for this Identifier.

The name as given.

The words that make up the name, in order.

Types

t()

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

Functions

format(identifier, casing, optional_args \\ [])

@spec format(t(), Dagger.Casing.t(), [{:acronyms, Dagger.AcronymStyle.t() | nil}]) ::
  {:ok, String.t()} | {:error, term()}

Format the identifier in a casing.

id(identifier)

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

A unique identifier for this Identifier.

name(identifier)

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

The name as given.

words(identifier)

@spec words(t()) :: {:ok, [Dagger.IdentifierWord.t()]} | {:error, term()}

The words that make up the name, in order.