Pigeon v1.6.1 Pigeon.ADM.Config View Source

Validates configuration settings that initialize ADM.Worker instances.

Link to this section Summary

Functions

Returns a new ADM.Config with given opts.

Returns whether a given config has valid credentials.

Link to this section Types

Link to this type

t()

View Source
t() :: %Pigeon.ADM.Config{
  client_id: String.t() | nil,
  client_secret: String.t() | nil,
  name: atom() | nil
}

Link to this section Functions

Returns a new ADM.Config with given opts.

Examples

iex> Pigeon.ADM.Config.new(
...>   name: :test,
...>   client_id: "amzn.client.id",
...>   client_secret: "1234secret"
...> )
%Pigeon.ADM.Config{name: :test, client_id: "amzn.client.id",
client_secret: "1234secret"}

Returns whether a given config has valid credentials.

Examples

iex> :adm_default |> new() |> valid?()
true
Link to this function

validate!(config)

View Source
validate!(any()) :: :ok | no_return()