jasmine-marbles
jasmine-marbles copied to clipboard
Add API Documentation
Gaps:
-
hot
andcold
- Difference between the two, how to assign values, valid string syntax -
getTestScheduler
- Why you might need this when testing streams that require custom schedulers
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).
I've submitted PR https://github.com/synapse-wireless-labs/jasmine-marbles/pull/9 as a starting point for library documentation.
The fact this repo has no formal README
or docs made me even question if I've got the right link or not lol
+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.