package brr

The type for console objects. See G.console for the global console object.

get () is the console object on which the functions below act. Initially this is G.console.

set o sets the console object to o.

clear () clears the console.

The type for log messages.

The type for functions turning values of type 'a into log messages.

msg v is [v].

The type for log functions.

Log messages rebind OCaml's list syntax. This allows to write heterogeneous logging statements concisely.

let () = Console.(log [1; 2.; true; Jv.true'; str "🐫"; G.navigator])

The console logs JavaScript values. For OCaml values this means that their js_of_ocaml representation is logged; see the FFI manual for details. Most OCaml values behind Brr types are however direct JavaScript values and logging them as is will be valuable. For other values you can use the str function which invokes the JavaScript toString method on the value. It works on OCaml strings and is mostly equivalent and shorter than calling Jstr.v before logging them.

In the JavaScript console API, if the first argument is a JavaScript string it can have formatting specifications. Just remember this should be a JavaScript string, so wrap OCaml literals by str or Jstr.v:

let () = Console.(log [str "This is:\n%o\n the navigator"; G.navigator])

str v is the result of invoking the JavaScript toString method on the representation of v. If v is Jv.null and Jv.undefined a string representing them is directly returned.

log_if_error ~l ~error_msg ~use r is v if r is Ok v and use if r is Error e. In this case e is logged with l (defaults to error) and error_msg (defaults to str e).

log_if_error' is log_if_error wrapped by Result.ok.

log m logs m with no specific level.

trace m logs m with no specific level but with a stack trace, like error and warn do.

error m logs m with level error.

warn m logs m with level warn.

warn m logs m with level info.

debug m logs m with level debug.

assert' c m asserts c and logs m with a stack trace iff c is false.

dir o logs a listing of the properties of the object o – this explains the difference with Console.(log [o]).

table v outputs v as tabular data. If cols is specified only the specified properties are printed.

group ~closed msg logs msg and pushes a new inline group in the console. This indents messages until group_end is called. If closed is true (defaults to false) the group's content is hidden behind a disclosure button.

group_end () pops the last inline group.

count label logs label with the number of times count label was called.

count_reset label resets the counter for count label.

time label starts a timer named label.

time_log label msg reports the timer value of label with msg appended to the report.

time_end label ends the timer named label.

profile label starts a new profile labelled label.

profile_end label ends ends the new profile labelled label.

time_stamp label adds a marker labeled by label in the waterfall view.