package sqids

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

Represents the Sqids configuration. Can be created with make.

module Defaults : sig ... end

Contains the default configuration.

val make : ?alphabet:string -> ?min_length:int -> ?blocklist:string list -> unit -> t

make ?alphabet ?min_length ?blocklist () creates a new Sqids configuration with the provided parameters.

val encode : t -> int list -> string

encode sqids ints encodes a list of numbers ints to a string identifier.

val decode : t -> string -> int list

decode sqids id decodes a string identifier id to a list of numbers.

OCaml

Innovation. Community. Security.