aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/control/concurrency/frp.lux
blob: 7334340f51c987d75027e8aaaec0155c8216aa21 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
(.require
 [library
  [lux (.except)
   ["$" documentation]
   [data
    [text (.only \n)
     ["%" \\format (.only format)]]]]]
 [\\library
  ["[0]" /]])

(def .public documentation
  (.List $.Documentation)
  (list ($.module /._
                  "")

        ($.definition /.already_closed)
        ($.definition /.functor)
        ($.definition /.apply)
        ($.definition /.monad)
        ($.definition /.subscribe!)
        ($.definition /.mixes)
        ($.definition /.poll)
        ($.definition /.periodic)
        ($.definition /.iterations)
        ($.definition /.distinct)
        ($.definition /.list)

        ($.definition (/.Channel it)
          "An asynchronous channel to distribute values.")

        ($.definition (/.Sink it)
          "The tail-end of a channel, which can be written-to to fee the channel.")

        ($.definition /.channel
          "Creates a brand-new channel and hands it over, along with the sink to write to it."
          ($.example (channel _)))

        ($.definition (/.Subscriber it)
          "A function that can receive every value fed into a channel.")

        ($.definition /.only
          (format "Produces a new channel based on the old one, only with values"
                  \n "that pass the test.")
          ($.example (only pass? channel)))

        ($.definition /.of_async
          "A one-element channel containing the output from an async."
          ($.example (of_async async)))

        ($.definition /.mix
          "Asynchronous mix over channels."
          ($.example (mix f init channel)))

        ($.definition /.sequential
          "Transforms the given list into a channel with the same elements."
          ($.example (sequential milli_seconds values)))
        ))