Permalink
Fetching contributors…
Cannot retrieve contributors at this time
134 lines (105 sloc) 3.48 KB

Deprecated API Methods documentation

All documentation on deprecated methods are moved from main docs to this file.

See also 2.x's version of this document containing docs on methods that were removed in 3.0.

obs.awaiting(otherObs) #145

Returns a property that represents the awaiting status of two observables, i.e. answers the question «Has obs observable emitted a value since the last value from otherObs observable has been emitted?».

var foo = Kefir.sequentially(100, [1, 2, 3]);
var bar = Kefir.sequentially(100, [1, 2, 3]).delay(40);
var result = foo.awaiting(bar);
result.log();
> [sequentially.awaiting] <value:current> false
> [sequentially.awaiting] <value> true
> [sequentially.awaiting] <value> false
> [sequentially.awaiting] <value> true
> [sequentially.awaiting] <value> false
> [sequentially.awaiting] <value> true
> [sequentially.awaiting] <value> false
> [sequentially.awaiting] <end>
foo:     ----1----2----3X
bar:     ------1----2----3X

result:  f---t-f--t-f--t-fX

obs.valuesToErrors([handler]) #149

Converts values to errors. By default it converts all values to errors, but you can specify a custom handler function to change that. The handler function is called with one argument — a value, and must return an object with two properties {convert: Boolean, error: AnyType}, if convert is set to true, the specified error will be emitted, otherwise the original value will be emitted, and the error property will be ignored.

var source = Kefir.sequentially(100, [0, -1, 2, -3]);
var result = source.valuesToErrors(x => {
  return {
    convert: x < 0,
    error: x * 2
  };
});
result.log();
> [sequentially.valuesToErrors] <value> 0
> [sequentially.valuesToErrors] <error> -2
> [sequentially.valuesToErrors] <value> 2
> [sequentially.valuesToErrors] <error> -6
> [sequentially.valuesToErrors] <end>
source:  ---•---•---•---•X
            0  -1   2  -3
result:  ---•---e---•---eX
            0  -2   2  -6

obs.errorsToValues([handler]) #149

Same as valuesToErrors but vice versa.

var source = Kefir.sequentially(100, [0, -1, 2, -3]).valuesToErrors();
var result = source.errorsToValues(x => {
  return {
    convert: x >= 0,
    value: x * 2
  };
});
result.log();
> [sequentially.valuesToErrors.errorsToValues] <value> 0
> [sequentially.valuesToErrors.errorsToValues] <error> -1
> [sequentially.valuesToErrors.errorsToValues] <value> 4
> [sequentially.valuesToErrors.errorsToValues] <error> -3
> [sequentially.valuesToErrors.errorsToValues] <end>
source:  ---e---e---e---eX
            0  -1   2  -3
result:  ---•---e---•---eX
            0  -1   4  -3

obs.endOnError() #150

Makes an observable to end on first error.

var source = Kefir.sequentially(100, [0, -1, 2, -3])
  .valuesToErrors(x => {
    return {convert: x < 0, error: x};
  });
var result = source.endOnError()
result.log();
> [sequentially.valuesToErrors.endOnError] <value> 0
> [sequentially.valuesToErrors.endOnError] <error> -1
> [sequentially.valuesToErrors.endOnError] <end>
source:  ---•---e---•---eX
            0  -1   2  -3
result:  ---•---eX
            0  -1