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

docs: update dsl extension docs

Browse source
This commit is contained in:
Zach Daniel 2020-09-25 14:34:31 -04:00
parent 6d719516c2
commit bce4f910f5
No known key found for this signature in database
GPG key ID: C377365383138D4B
1 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
lib/ash/dsl/extension.ex
View file

@ -3,7 +3,9 @@ defmodule Ash.Dsl.Extension do
An extension to the Ash DSL.
This allows configuring custom DSL components, whos configurations
can then be read back.
can then be read back. This guide is still a work in progress, but should
serve as a decent example of what is possible. Open issues on Github if you
have any issues/something is unclear.
The example at the bottom shows how you might build a (not very contextually
relevant) DSL extension that would be used like so:
@ -18,7 +20,7 @@ defmodule Ash.Dsl.Extension do
end
end
For (a not very contextually relevant) example:
The extension:
defmodule MyApp.CarExtension do
@car_schema [
@ -96,6 +98,8 @@ defmodule Ash.Dsl.Extension do
MyApp.Cars.cars(MyResource)
# [%MyApp.Car{...}, %MyApp.Car{...}]
See the documentation for `Ash.Dsl.Section` and `Ash.Dsl.Entity` for more information
"""
@callback sections() :: [Ash.Dsl.Section.t()]