ash-project/ash
1
0
Fork 0
mirror of https://github.com/ash-project/ash.git synced 2024-09-20 13:33:20 +12:00
Code Issues Projects Releases Packages Wiki Activity

Improve documentation for Ash.Changeset.add_error/3 (#572)

Browse source
This commit is contained in:
Moxley Stratton 2023-05-05 17:23:03 -07:00 committed by GitHub
parent c174713b70
commit 84aff5a999
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
lib/ash/changeset/changeset.ex
View file

@ -185,6 +185,16 @@ defmodule Ash.Changeset do
valid?: boolean
}
@type error_info ::
String.t()
| [
{:field, atom()}
| {:fields, [atom()]}
| {:message, String.t()}
| {:value, any()}
]
| %{:__struct__ => atom(), required(atom()) => any()}
alias Ash.Error.{
Changes.InvalidArgument,
Changes.InvalidAttribute,
@ -3656,8 +3666,22 @@ defmodule Ash.Changeset do
%{changeset | handle_errors: func}
end
@doc "Adds an error to the changesets errors list, and marks the change as `valid?: false`"
@spec add_error(t(), term | String.t() | list(term | String.t())) :: t()
@doc """
Adds an error to the changesets errors list, and marks the change as `valid?: false`.
## Error Data
The given `errors` argument can be a string, a keyword list, a struct, or a list of any of the three.
If `errors` is a keyword list, or a list of keyword lists, the following keys are supported in the keyword list:
- `field` (atom) - the field that the error is for. This is required, unless `fields` is given.
- `fields` (list of atoms) - the fields that the error is for. This is required, unless `field` is given.
- `message` (string) - the error message
- `value` (any) - (optional) the field value that caused the error
"""
@spec add_error(t(), error_info() | [error_info()]) :: t()
@spec add_error(t(), error_info() | [error_info()], Keyword.t()) :: t()
def add_error(changeset, errors, path \\ [])
def add_error(changeset, errors, path) when is_list(errors) do