vndb/mithril-vndb
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

separators

Browse source
This commit is contained in:
Leo Horie 2016-10-26 12:58:08 -04:00
parent 1c676d0a2c
commit 6dfb78ee52
1 changed files with 24 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

24
docs/prop.md
View file

@ -60,6 +60,8 @@ Argument | Type | Required | Description
[How to read signatures](signatures.md)
---
###### combiner
Specifies how the value of a computed stream is generated. See [combining streams](#combining-streams)
@ -74,6 +76,8 @@ Argument | Type | Required | Description
[How to read signatures](signatures.md)
---
##### prop.reject
Creates a stream in a error state. See [stream states](#stream-states)
@ -87,6 +91,8 @@ Argument | Type | Required | Description
[How to read signatures](signatures.md)
---
##### prop.merge
Creates a stream whose value is the array of values from an array of streams
@ -100,10 +106,14 @@ Argument | Type | Required | Description
[How to read signatures](signatures.md)
---
##### prop.HALT
A special value that can be returned to stream callbacks to halt execution of downstreams
---
##### prop["fantasy-land/of"]
This method is functionally identical to `m.prop`. It exists to conform to [Fantasy Land's Applicative specification](https://github.com/fantasyland/fantasy-land). For more information, see the [What is Fantasy Land](#what-is-fantasy-land) section.
@ -115,6 +125,8 @@ Argument | Type | Required | Description
`value` | `any` | No | If this argument is present, the value of the prop is set to it
**returns** | `Stream` | | Returns a stream
---
#### Instance members
##### stream.run
@ -132,18 +144,24 @@ Argument | Type | Required | Description
[How to read signatures](signatures.md)
---
##### stream.end
A co-dependent stream that unregisters dependent streams when set to true. See [ended state](#ended-state).
`endStream = m.prop().end`
---
##### stream.error
A co-dependent stream that is set if the stream is in an errored state. See [handling errors](#handling-errors).
`errorStream = m.prop().error`
---
##### stream.catch
Returns an active stream whose value is equal to the return value of `catch`'s callback.
@ -157,6 +175,8 @@ Argument | Type | Required | Description
[How to read signatures](signatures.md)
---
##### stream["fantasy-land/of"]
This method is functionally identical to `m.prop`. It exists to conform to [Fantasy Land's Applicative specification](https://github.com/fantasyland/fantasy-land). For more information, see the [What is Fantasy Land](#what-is-fantasy-land) section.
@ -168,6 +188,8 @@ Argument | Type | Required | Description
`value` | `any` | No | If this argument is present, the value of the prop is set to it
**returns** | `Stream` | | Returns a stream
---
##### stream["fantasy-land/map"]
Creates a dependent stream whose value is set to the result of the callback function. See [chaining streams](#chaining-streams)
@ -185,6 +207,8 @@ Argument | Type | Required | Description
[How to read signatures](signatures.md)
---
##### stream["fantasy-land/ap"]
[FIXME: `ap` does not conform to Fantasy Land 2.0 spec - do not use]