@@ -49,75 +49,10 @@ NEXT NUMBER: 50 // after a 1 second delay
49
49
I AM COMPLETE // same time as previous line
50
50
```
51
51
52
- ### There a few plugins that are available - each return a new Observable instance:
52
+ ### There a few plugins that are available - each return a new Observable instance
53
53
54
- - They are called by doing: ` observableInstance$.<pluginFunction> `
54
+ - [ Documentation on the plugin operators can be seen here ] ( ./src/operators/DOCUMENTATION.md )
55
55
56
- ` .map(<mapCallback>) `
56
+ ### There are also a few Observables that can be created from the Observable object itself
57
57
58
- - will map each value to a new value using the callback
59
-
60
- ` .filter(<filterCallback>) `
61
-
62
- - will filter out values that you do not want to subscribe to
63
-
64
- ` .do(<doCallback>) `
65
-
66
- - will run some callback before passing the current value to the subscription
67
-
68
- ` .take(<amount>[, <callback>]) `
69
-
70
- - will take the amount of values you want (or less if it completes first) and then complete -- this is useful for infinitely running observables
71
- - a callback may be passed to filter out the valeus you want to take
72
-
73
- ` .first([<callback>]) `
74
-
75
- - this is an alias for ` .take(1[, <callback>]) `
76
-
77
- ` .toPromise() `
78
-
79
- - this will do a ` .first() ` on the observable object and return the value from that to the response from a promise
80
-
81
- ` .flatMap(<mapCallback>) `
82
-
83
- - same as ` .map(<mapCallback>) ` but will take the value of the callback and turn it from an observable to a value
84
-
85
- ` .switchMap(<mapCallback>) `
86
-
87
- - the value from the mapCallback is an observable and if another value comes through the previous observable is cancelled
88
- - this is useful for things like typeaheads where you dont want a request for every keypress
89
-
90
- ` .delay(<time>) `
91
-
92
- - will delay output from the observable until a specific time interval has passed
93
-
94
- ` .debounceTime(<time>) `
95
-
96
- - will only output values if there has not been any new values in the past time interval passed
97
-
98
- ### There are also a few Observables that can be created from the Observable object itself:
99
-
100
- - They are called by doing: ` Observable.<observableFunction> `
101
-
102
- ` .fromEvent(<eventName>, <element>[, <mapCallback>) `
103
-
104
- - will create an observable that will listen for an event on a DOM element
105
- - there is also an optional mappCallback that can be used to map the event that comes through the next observer function
106
-
107
- ` .fromPromise(<promise>) `
108
-
109
- - turns a promise into an observable that emits the value of the promise and then completes
110
-
111
- ` .interval(<time>[, <start = 0>]) `
112
-
113
- - emits a number at the specified time interval and increases by one every time
114
- - there is an optional start value that can be passed
115
-
116
- ` .of(<...values>) `
117
-
118
- - takes any number of arguments and emits them in an observable (in order) and then completes
119
-
120
- ` .range(<start>[, <end>]) `
121
-
122
- - emits a range of numbers from start to end and then completes
123
- - if only start is given than the range starts at 0 and ends at the start value
58
+ - [ Documentation on the observables can be seen here] ( ./src/observables/DOCUMENTATION.md )
0 commit comments