package sihl

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

Parameters

Signature

include Sihl_core.Container.Service.Sig
val create : kind:string -> ?data:string -> ?expires_in:Sihl_utils.Time.duration -> ?length:int -> unit -> Sihl_token__.Model.t Lwt.t

Create a token and store a token.

Provide expires_in to define a duration in which the token is valid, default is one day. Provide data to store optional data as string. Provide length to define the length of the token in bytes.

val find : string -> Sihl_token__.Model.t Lwt.t

Returns an active and non-expired token. Raises Failure if no token is found.

val find_opt : string -> Sihl_token__.Model.t option Lwt.t

Returns an active and non-expired token.

val find_by_id : string -> Sihl_token__.Model.t Lwt.t

Returns an active and non-expired token by id. Raises Failure if no token is found.

val find_by_id_opt : string -> Sihl_token__.Model.t option Lwt.t

Returns an active and non-expired token by id.

val invalidate : Sihl_token__.Model.t -> unit Lwt.t

Invalidate a token by marking it as such in the database and therefore marking it "to be deleted"

val register : unit -> Sihl_core.Container.Service.t
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