package devkit

  1. Overview
  2. Docs
package devkit
Legend:
Library
Module
Module type
Parameter
Class
Class type

functor version of Param because somebody thought it is good idea

Parameters

module T : sig ... end

Signature

val req : request
exception Bad of string
val get : string -> string option

Get optional parameter.

  • returns

    None if parameter is missing

val str : ?default:string -> string -> string

Get required parameter.

  • raises Bad

    if parameter is missing and no default provided

val get_int : string -> int option

Get optional integer parameter

val int : ?default:int -> string -> int

Get integer parameter.

  • raises Bad

    if parameter is missing and no default provided

val bool : ?default:bool -> string -> bool

Get boolean parameter.

  • returns

    true when parameter value is "true", false otherwise.

    @raise Bad

    if missing and no default provided.

val float : ?default:float -> string -> float
val int64 : ?default:int64 -> string -> int64
val array : string -> string list
  • parameter name

    array name without brackets e.g. array "x" to extract x from /request?x=1&x=2

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct