package irmin-indexeddb

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Legend:
Library
Module
Module type
Parameter
Class
Class type

Ref provides base functions on user-defined references.

Signature for Ref implementations

Signature for reference IDs (i.e. branch names).

include Irmin.Hum.S with type t = branch_id

include Tc.S0 with type t = branch_id

type t = branch_id

val equal : t Tc.equal

val compare : t Tc.compare

val hash : t Tc.hash

val to_json : t Tc.to_json

The REST inteface.

val of_json : t Tc.of_json

val size_of : t Tc.size_of

The serialization format.

val write : t Tc.writer

val read : t Tc.reader

val to_hum : t -> string

Display a value using its human readable representation.

val of_hum : string -> t

Convert a human readable representation of a value into its abstract value.

val master : t

The name of the master branch.

val is_valid : t -> bool

Check if the branch ID is valid.