Current section
Files
Jump to
Current section
Files
documentation/dsls/DSL-AshOutstanding.Resource.md
<!--
This file was generated by Spark. Do not edit it by hand.
-->
# AshOutstanding.Resource
`Ash.Resource` extension for implementing `Outstanding` protocol.
## outstanding
Configuration for Outstanding implementation.
### Nested DSLs
* [customize](#outstanding-customize)
### Options
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`expect`](#outstanding-expect){: #outstanding-expect } | `atom \| list(atom) \| %{optional(:private?) => boolean, optional(:sensitive?) => boolean, optional(:include) => list(atom), optional(:exclude) => list(atom)}` | | Keys to expect in outstanding calculation. Accepts a single key or list of keys, where keys are atoms, or a behaviour configuration map. |
### outstanding.customize
```elixir
customize fun
```
A step to arbitrary customize outstanding
### Arguments
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`fun`](#outstanding-customize-fun){: #outstanding-customize-fun .spark-required} | `(any, any, any -> any)` | | A function to customize a result with. Receives a result and a resource record. |
<style type="text/css">.spark-required::after { content: "*"; color: red !important; }</style>