urbit/developers.urbit.org
1
1
Fork 0
mirror of https://github.com/urbit/developers.urbit.org.git synced 2024-08-16 17:20:35 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #397 from urbit/i/394/correct-gall-fact-api-ref

Browse Source 
gall: clarify empty fact path only works in on-watch
This commit is contained in:
tinnus-napbus 2023-07-01 19:39:07 +12:00 committed by GitHub
commit dae62d0f8c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
content/reference/arvo/gall/gall-api.md
View File

@ -816,13 +816,14 @@ subscription content for all subscribers on a given path.
#### Structure
```hoon
[%fact (list path) =cage]
[%fact paths=(list path) =cage]
```
`(list path)` is a list of the paths to send the update on. If no path is
given, then the update is only given to the program that instigated the
request. Typical use of this mode is in `+on-watch` to give an initial update
to a new subscriber to get them up to date.
`paths` is a list of the subscription paths to send the update on. In
`+on-watch` alone, if no path is given, then the update is given
exclusively to the source of the `%watch` request. This is useful for
giving initial state to new subscribers. In other contexts, one or more
subscription paths should be provided.
`cage` is a cage of the subscription update.