update docs, add descriptions for api methods

This commit is contained in:
Leo Horie 2016-12-02 17:51:07 -05:00
parent d56c30cc4a
commit cdb9017a72
25 changed files with 613 additions and 40 deletions

View file

@ -1,5 +1,6 @@
# stream()
- [Description](#description)
- [Signature](#signature)
- [Static members](#static-members)
- [stream.combine](#streamcombine)
@ -25,6 +26,16 @@
---
### Description
A Stream is a reactive data structure, similar to cells in spreadsheet applications.
For example, in a spreadsheet, if `A1 = B1 + C1`, then changing the value of `B1` or `C1` automatically changes the value of `A1`.
Similarly, you can make a stream depend on other streams so that changing the value of one automatically updates the other. This is useful when you have very expensive computations and want to only run them when necessary, as opposed to, say, on every redraw.
---
### Signature
Creates a stream