Show:

Differential is a Stream that emits differentials of consecutive input values.

It emits start, update and end events.

Constructor

Streams.Differential

(
  • [options]
)

Parameters:

  • [options] Object optional

    Options

    • [scale] Number optional

      Scale to apply to differential

Example:

 var differential = new Differential();
         // this gives differentials of mouse input
         differential.subscribe(mouseInput.pluck('value'));

Item Index

Methods

Methods

filter

(
  • filterFn
)
SimpleStream

Inherited from Streams.SimpleStream:

Filter converts the current stream into a new stream that only emits if the filter condition is satisfied. The filter function should return a Boolean value.

Parameters:

  • filterFn Function
    Function to filter event payload

Returns:

SimpleStream: stream Filtered stream

map

(
  • mapperFn
)
SimpleStream

Inherited from Streams.SimpleStream:

Map converts the current stream into a new stream with a modified (mapped) data payload.

Parameters:

  • mapperFn Function
    Function to map event payload

Returns:

SimpleStream: stream Mapped stream

pluck

(
  • key
)
SimpleStream

Inherited from Streams.SimpleStream:

Pluck is an opinionated mapper. It projects a Stream onto one of its return values. Useful if a Stream returns an array or object.

Parameters:

Returns:

SimpleStream: stream Plucked stream

split

(
  • splitterFn
)

Inherited from Streams.SimpleStream:

Split maps one of several streams based on custom logic. The splitter function should return an EventEmitter type.

Parameters: