Skip to content

Update docs for preparation.ex #2317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update docs for preparation.ex #2317

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d8258a
Update docs for preparation.ex
m0rt3nlund Sep 10, 2025
c95894e
Add a bit more information about what supports callback does
m0rt3nlund Sep 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions lib/ash/resource/preparation/preparation.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ defmodule Ash.Resource.Preparation do
`c:init/1` is defined automatically by `use Ash.Resource.Preparation`, but can be implemented if you want to validate/transform any
options passed to the module.

`c:supports/1` is also required and returns a list containing any or all of the following: `[Ash.Changeset, Ash.Query, Ash.ActionInput]` based on what your `c:prepare/3` implementation supports

The main function is `c:prepare/3`. It takes the query, any options that were provided
when this preparation was configured on a resource, and the context, which currently only has
the actor.
Expand Down
Loading