/README

https://bitbucket.org/darrint/qc.js/ · #! · 40 lines · 30 code · 10 blank · 0 comment · 0 complexity · 4e49eb5b0ab16a6096e6321a857f9ba3 MD5 · raw file

  1. JS Quickcheck Features
  2. ======================
  3. - Listener UI's for Firebug, Firebug Lite (cross browser), and Rhino
  4. - Arbitrary generators are objects with fields arb and shrink (to add
  5. shrinking support later. The field shrink is optional and interpreted as 'null' if not present).
  6. - Nice stable of generators available out of the box.
  7. - arbArray to generate an arbitrary JS array.
  8. - arbSelect to uniformly select one of the given generators
  9. - arbNull which will always return 'null'
  10. - arbNullOr generator returning null or the given generators return
  11. value (probability for null is 0.1)
  12. - implemented 'classify' and 'collect' (see selfcheck.js for example)
  13. - implemented simple shrinking strategies for primitive types
  14. - arbArray has an optional second parameter setting its shrinking strategy
  15. - runrhino.js to tests so one can run selfcheck from command line by
  16. 'rhino runrhino.js'
  17. - implemented expectException property modifier
  18. TODO:
  19. =====
  20. - start some kind of documentation
  21. Build Documentation:
  22. ====================
  23. In order to build the documentation you will need:
  24. - jsdoc toolkit (http://code.google.com/p/jsdoc-toolkit/).
  25. It is recommended to set the JSDOCDIR environment variable
  26. - jsdoc simple template (http://github.com/urso/jsdoc-simple):
  27. just copy 'jsdoc-simple' directory to jsdoc toolkit's template directory
  28. - run './mkdoc' shell command (needs *nix shell).
  29. qc.js was originally written by Darrin Thompson with extensive contributions
  30. from Steffen Siering.