jasmine-marbles icon indicating copy to clipboard operation
jasmine-marbles copied to clipboard

Add API Documentation

Open MikeRyanDev opened this issue 7 years ago • 4 comments

Gaps:

  • hot and cold - Difference between the two, how to assign values, valid string syntax
  • getTestScheduler - Why you might need this when testing streams that require custom schedulers

MikeRyanDev avatar Jul 18 '17 22:07 MikeRyanDev

I came here too to look for documentation & usage examples. I think the empty readme might put off potential users and at least some basic usage examples would be nice. Could also add links to point where users can find more info about marble testing (e.g. https://github.com/ReactiveX/rxjs/blob/master/doc/writing-marble-tests.md).

cvuorinen avatar Aug 13 '17 09:08 cvuorinen

I've submitted PR https://github.com/synapse-wireless-labs/jasmine-marbles/pull/9 as a starting point for library documentation.

mcattle avatar Nov 28 '17 19:11 mcattle

The fact this repo has no formal README or docs made me even question if I've got the right link or not lol

dolanmiu avatar Jan 10 '18 16:01 dolanmiu

+1, especially since the Angular docs are recommending this package. The two links in the readme are either broken or seem to be irrelevant. It would be nice to get at least a basic writeup of what this package does, and how it's different from using https://rxjs-dev.firebaseapp.com/guide/testing/marble-testing.

jacobweber avatar May 13 '20 23:05 jacobweber