Dagger.Check (dagger v0.20.7)

Dagger.Check

Summary

Types

t()

Functions

completed(check)

Whether the check completed

description(check)

The description of the check

error(check)

If the check failed, this is the error

id(check)

A unique identifier for this Check.

name(check)

Return the fully qualified name of the check

original_module(check)

The original module in which the check has been defined

passed(check)

Whether the check passed

path(check)

The path of the check within its module

result_emoji(check)

An emoji representing the result of the check

run(check)

Execute the check

Types

t()

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

Functions

completed(check)

@spec completed(t()) :: {:ok, boolean()} | {:error, term()}

Whether the check completed

description(check)

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

The description of the check

error(check)

@spec error(t()) :: Dagger.Error.t() | nil

If the check failed, this is the error

id(check)

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

A unique identifier for this Check.

name(check)

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

Return the fully qualified name of the check

original_module(check)

@spec original_module(t()) :: Dagger.Module.t()

The original module in which the check has been defined

passed(check)

@spec passed(t()) :: {:ok, boolean()} | {:error, term()}

Whether the check passed

path(check)

@spec path(t()) :: {:ok, [String.t()]} | {:error, term()}

The path of the check within its module

result_emoji(check)

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

An emoji representing the result of the check

run(check)

@spec run(t()) :: t()

Execute the check