james/smokestack
1
0
Fork 0
Code Issues 4 Pull requests 1 Projects Releases 17 Packages Wiki Activity

chore(deps): update dependency spark to v1.1.55 #37

Merged
renovate merged 2 commits from renovate/spark-1.x-lockfile into main 2024-03-14 17:15:12 +13:00
Conversation 0 Commits 2 Files changed 2 +20 -11
1 changed files with 20 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit 22358bc5ad - Show all commits

31
documentation/dsls/DSL:-Smokestack.cheatmd → documentation/dsls/DSL:-Smokestack.md
View file

@ -1,3 +1,6 @@
<!--
This file was generated by Spark. Do not edit it by hand.
-->
# DSL: Smokestack.Dsl
The DSL definition for the Smokestack DSL.
@ -83,15 +86,16 @@ Define factories for a resource
### Options
| Name | Type | Default | Docs |
| --- | --- | --- | --- |
| `api` | `module` | | The default Ash API to use when evaluating loads |
|------|------|---------|------|
| [`api`](#smokestack-api){: #smokestack-api } | `module` | | The default Ash API to use when evaluating loads |
## smokestack.factory
```elixir
factory resource, variant \ :default
factory resource, variant \\ :default
```
@ -104,14 +108,16 @@ Define factories for a resource
### Arguments
| Name | Type | Default | Docs |
| --- | --- | --- | --- |
| `resource`* | `module` | | An Ash Resource |
| `variant` | `atom` | `:default` | The name of a factory variant |
|------|------|---------|------|
| [`resource`](#smokestack-factory-resource){: #smokestack-factory-resource .spark-required} | `module` | | An Ash Resource |
| [`variant`](#smokestack-factory-variant){: #smokestack-factory-variant } | `atom` | `:default` | The name of a factory variant |
### Options
| Name | Type | Default | Docs |
| --- | --- | --- | --- |
| `api` | `module` | | The Ash API to use when evaluating loads |
|------|------|---------|------|
| [`api`](#smokestack-factory-api){: #smokestack-factory-api } | `module` | | The Ash API to use when evaluating loads |
## smokestack.factory.attribute
@ -127,10 +133,11 @@ attribute name, generator
### Arguments
| Name | Type | Default | Docs |
| --- | --- | --- | --- |
| `name`* | `atom` | | The name of the target attribute |
| `generator`* | `(-> any) \| mfa \| (any -> any) \| mfa \| (any, any -> any) \| mfa` | | A function which can generate an appropriate value for the attribute.œ |
|------|------|---------|------|
| [`name`](#smokestack-factory-attribute-name){: #smokestack-factory-attribute-name .spark-required} | `atom` | | The name of the target attribute |
| [`generator`](#smokestack-factory-attribute-generator){: #smokestack-factory-attribute-generator .spark-required} | `(-> any) \| mfa \| (any -> any) \| mfa \| (any, any -> any) \| mfa` | | A function which can generate an appropriate value for the attribute.œ |
@ -151,3 +158,5 @@ Target: `Smokestack.Dsl.Factory`
<style type="text/css">.spark-required::after { content: "*"; color: red !important; }</style>