irc-client
IRC client library - core functionality
1024" x-on:close-sidebar="sidebar=window.innerWidth > 1024 && true">
back to documentation root
ON THIS PAGE
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
Library irc-client
type command =
A type representing an IRC command, following RFC 2812
Constructors
val pass : string -> t
val nick : string -> t
val user : username:string -> mode:int -> realname:string -> t
val oper : name:string -> pass:string -> t
val mode : nick:string -> mode:string -> t
val quit : msg:string option -> t
val join : chans:string list -> keys:string list option -> t
val join0 : t
val part : chans:string list -> comment:string option -> t
val topic : chan:string -> topic:string option -> t
val names : chans:string list -> t
val list : chans:string list -> t
val invite : nick:string -> chan:string -> t
val kick : chans:string list -> nick:string -> comment:string option -> t
val privmsg : target:string -> string -> t
val notice : target:string -> string -> t
val ping : message1:string -> message2:string -> t
val pong : message1:string -> message2:string -> t
val other : cmd:string -> params:string list -> t
Printing
val to_string : t -> string
Format the message into a string that can be sent on IRC
val output : out_channel -> t -> unit
Parsing
type 'a or_error = ( 'a, string ) Result.result
val parse_exn : string -> t
parse_exn s
returns the parsed message