Franklin
v0.1.0

View Source Franklin.Articles.Commands.UpdateArticle (Franklin v0.1.0)

A command to represent the user-semantic intent of updating an existing Article entity.

Link to this section Summary

Types

attrs()
t()

Functions

new(attrs)

Attempts to return a UpdateArticle command using the passed in attributes.

Link to this section Types

Link to this type

attrs()

View Source 
@type attrs() :: %{
  body: String.t(),
  id: Ecto.UUID.t(),
  published_at: DateTime.t(),
  slug: String.t(),
  title: String.t()
}
Link to this type

t()

View Source 
@type t() :: %Franklin.Articles.Commands.UpdateArticle{
  body: String.t(),
  id: Ecto.UUID.t(),
  published_at: DateTime.t() | nil,
  slug: String.t(),
  title: String.t()
}

Link to this section Functions

Link to this function

new(attrs)

View Source 
@spec new(attrs()) :: {:ok, t()} | {:error, Franklin.ValidationErrorMap.t()}

Attempts to return a UpdateArticle command using the passed in attributes.

If the attributes are valid, returns: {:ok, command}. If the attributes are invalid, returns: {:error, validation_error_map}.