Standard Library
Below is the API for the OCaml standard library. It's directly copied over from the OCaml Manual, formatted to the Reason syntax and styled accordingly. The API docs are work-in-progress; we'll be polishing these gradually!
If you're targeting JavaScript, the API docs for BuckleScript includes all of below, plus JS-specific APIs.
Module type MoreLabels.Hashtbl.HashedType
module type HashedType = Hashtbl.HashedTypetype t
The type of the hashtable keys.
val equal : t -> t -> bool
The equality predicate used to compare keys.
val hash : t -> int
A hashing function on keys. It must be such that if two keys are
equal according to
equal, then they have identical hash values
as computed by hash.
Examples: suitable (equal, hash) pairs for arbitrary key
types include- (
(=),Hashtbl.hash) for comparing objects by structure (provided objects do not contain floats) - (
(fun x y -> compare x y = 0),Hashtbl.hash) for comparing objects by structure and handlingPervasives.nancorrectly - (
(==),Hashtbl.hash) for comparing objects by physical equality (e.g. for mutable or cyclic objects).