Skip to content

Latest commit

 

History

History
151 lines (95 loc) · 3.22 KB

recorded.md

File metadata and controls

151 lines (95 loc) · 3.22 KB

Rx.Recorded class

Record of a value including the virtual time it was produced on.

Location

  • rx.testing.js

Recorded Constructor

Recorded Instance Methods

Recorded Instance Properties

Recorded Constructor

Rx.Recorded(time, value, [comparer])

#

Creates a new object recording the production of the specified value at the given virtual time.

Arguments

  1. time (Number): Virtual time the value was produced on.
  2. value (Any): Value that was produced
  3. [comparer] (Function): Optional comparer function.

Example

var recorded = new Rx.Recorded(200, 'value');

console.log(recorded.time);
// => 200

console.log(recorded.value);
// => value

Location

  • rx.js

Recorded Instance Methods

Rx.Recorded.prototype.equals(other)

#

Checks whether the given recorded object is equal to the current instance.

Arguments

  1. other (Recorded): Recorded object to check for equality.

Returns

(Boolean): Returns true if the Recorded equals the other, else false.

Example

var r1 = new Recorded(201, 'foo');
var r2 = new Recorded(201, 'bar');
var r3 = new Recorded(201, 'foo');

console.log(r1.equals(r2));
// => false

console.log(r1.equals(r3));
// => true

Location

  • rx.testing.js

Rx.Recorded.prototype.toString()

#

Returns a string representation of the current Recorded value.

Returns

(String): String representation of the current Recorded value.

Example

var r1 = new Recorded(201, 'foo');

console.log(r1.toString());
// => foo@201

Location

  • rx.testing.js

Recorded Instance Properties

time

#

Gets the virtual time the value was produced on.

Returns

(Number): The virtual time the value was produced on.

Example

var r1 = new Recorded(201, 'foo');

console.log(r1.time);
// => 201

Location

  • rx.testing.js

value

#

Gets the recorded value.

Returns

(Number): The recorded value.

Example

var r1 = new Recorded(201, 'foo');

console.log(r1.value);
// => foo

Location

  • rx.testing.js