StrawHat.GraphQL v0.2.2 StrawHat.GraphQL.MutationResponse View Source

Absinthe Mutation Response utilities. Normally will be use in Absinthe resolvers.

Usage

On the resolver.

Examples

defmodule App.AccountResolver do

  alias StrawHat.GraphQL.MutationResponse

  def create_account(params, _) do
    case App.Account.create_account(params) do
      {:ok, account} -> MutationResponse.succeeded(account)
      {:error, reason} -> MutationResponse.failed(reason)
    end
  end
end

Link to this section Summary

Types

mutation_response()

successful: When the mutation succeeded or not.
payload: Data of the mutation payload.
errors: List of StrawHat.Error.t/0.

Functions

failed(changeset)

Returns a failed mutation response map.

response_with(arg1)

succeeded(payload)

Returns a succeeded mutation response map.

Link to this section Types

mutation_response()

mutation_response() :: %{
  successful: boolean(),
  payload: any(),
  errors: [StrawHat.Error.t()]
}

successful: When the mutation succeeded or not.
payload: Data of the mutation payload.
errors: List of StrawHat.Error.t/0.

Link to this section Functions

failed(changeset)

failed(Ecto.Changeset.t()) :: {:ok, mutation_response()}

failed(StrawHat.Error.t()) :: {:ok, mutation_response()}

failed(StrawHat.Error.ErrorList.t()) :: {:ok, mutation_response()}

failed(any()) :: no_return()

Returns a failed mutation response map.

response_with(arg1)

response_with({:ok, any()} | {:error, any()} | any()) ::
  {:ok, mutation_response()} | no_return()

succeeded(payload)

succeeded(any()) :: {:ok, mutation_response()}

Returns a succeeded mutation response map.