Skip to content

Commit

Permalink
chore: update generated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
zachdaniel committed Feb 10, 2025
1 parent 8d0701c commit bd40530
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions documentation/dsls/DSL-Ash.Notifier.PubSub.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,8 @@ end
| [`module`](#pub_sub-module){: #pub_sub-module .spark-required} | `atom` | | The module to call `broadcast/3` on e.g module.broadcast(topic, event, message). |
| [`prefix`](#pub_sub-prefix){: #pub_sub-prefix } | `String.t` | | A prefix for all pubsub messages, e.g `users`. A message with `created` would be published as `users:created` |
| [`delimiter`](#pub_sub-delimiter){: #pub_sub-delimiter } | `String.t` | | A delimiter for building topics. Default is a colon (:) |
| [`filter`](#pub_sub-filter){: #pub_sub-filter } | `(any -> any)` | | A filter for notifications. Receives a notification, and ignores it if the function returns a falsy value. Both this and filters on specific publications must return a truthy value for a notification to be emitted. |
| [`transform`](#pub_sub-transform){: #pub_sub-transform } | `(any -> any)` | | A transformer for notifications. Specific transformers on each publication *override* this option |
| [`broadcast_type`](#pub_sub-broadcast_type){: #pub_sub-broadcast_type } | `:notification \| :phoenix_broadcast \| :broadcast` | `:notification` | What shape the event payloads will be in. See |
| [`name`](#pub_sub-name){: #pub_sub-name } | `atom` | | A named pub sub to pass as the first argument to broadcast. |

Expand Down Expand Up @@ -192,6 +194,8 @@ publish :assign, "assigned"
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`previous_values?`](#pub_sub-publish-previous_values?){: #pub_sub-publish-previous_values? } | `boolean` | `false` | Whether or not to publish messages with both the new values and the old values for referencing changed attributes |
| [`filter`](#pub_sub-publish-filter){: #pub_sub-publish-filter } | `(any -> any)` | | A filter for notifications. Receives a notification, and ignores it if the function returns a falsy value. |
| [`transform`](#pub_sub-publish-transform){: #pub_sub-publish-transform } | `(any -> any)` | | A transformer for notifications. Receives a notification, and returns a new value to be broadcasted. |
| [`event`](#pub_sub-publish-event){: #pub_sub-publish-event } | `String.t` | | The name of the event to publish. Defaults to the action name |
| [`dispatcher`](#pub_sub-publish-dispatcher){: #pub_sub-publish-dispatcher } | `atom` | | The module to use as a dispatcher. If none is set, the pubsub module provided is used. |

Expand Down Expand Up @@ -234,6 +238,8 @@ publish_all :create, "created"
| [`except`](#pub_sub-publish_all-except){: #pub_sub-publish_all-except } | `list(atom)` | `[]` | Exclude these actions from notifications |
| [`action`](#pub_sub-publish_all-action){: #pub_sub-publish_all-action } | `atom` | | The name of the action that should be published |
| [`previous_values?`](#pub_sub-publish_all-previous_values?){: #pub_sub-publish_all-previous_values? } | `boolean` | `false` | Whether or not to publish messages with both the new values and the old values for referencing changed attributes |
| [`filter`](#pub_sub-publish_all-filter){: #pub_sub-publish_all-filter } | `(any -> any)` | | A filter for notifications. Receives a notification, and ignores it if the function returns a falsy value. |
| [`transform`](#pub_sub-publish_all-transform){: #pub_sub-publish_all-transform } | `(any -> any)` | | A transformer for notifications. Receives a notification, and returns a new value to be broadcasted. |
| [`event`](#pub_sub-publish_all-event){: #pub_sub-publish_all-event } | `String.t` | | The name of the event to publish. Defaults to the action name |
| [`dispatcher`](#pub_sub-publish_all-dispatcher){: #pub_sub-publish_all-dispatcher } | `atom` | | The module to use as a dispatcher. If none is set, the pubsub module provided is used. |

Expand Down

0 comments on commit bd40530

Please sign in to comment.