package calculon

You can search for identifiers within the package.

in-package search v0.2.0

Legend:
Library
Module
Module type
Parameter
Class
Class type

User-defined config

type hidden

Type that cannot be built

type t = {

server : string;
(*
Address of the irc server
*)
port : int;
(*
Port of the server
*)
username : string;
password : string option;
realname : string;
nick : string;
tls : bool;
sasl : bool;
channels : string list;
(*
Channels to join after the connexion to the server
*)
log_level : Logs.level;
(*
Level of logging.
- since 0.6
*)
prefix : string;
(*
prefix for commands
*)
db_file : string;
(*
Database path.
- since NEXT_RELEASE
*)
_hidden : hidden;
(*
This field is present to prevent the user from using a literal record to build configuration. This way, adding new fields doesn't break existing code.
- since NEXT_RELEASE
*)

}

Bot configuration.

val default : t

Default configuration:

val parse : 
  ?extra_args:(string * Arg.spec * string) list ->
  t ->
  string array ->
  t

parse conf args is the same as conf, but some command line arguments can override its fields

parameter extra_args
additional command line arguments for Arg (since NEXT_RELEASE)

val of_argv : ?extra_args:(string * Arg.spec * string) list -> unit -> t

Parsed from Sys.argv Will call exit if Arg.parse fails

parameter extra_args
additional command line arguments for Arg (since NEXT_RELEASE)