package sihl

You can search for identifiers within the package.

in-package search v0.2.0

The modular functional web framework

Install

Dune Dependency

github.com Readme Changelog Edit opam file Versions (35)

Authors

Maintainers

J

josef@oxidizing.io

Sources

sihl-queue-0.1.7.tbz

sha256=a432c28b88610b8ef914aa93d1be5bf3ad4b357ebaa8e95848e981ea30611cd4

sha512=e85a2c2935973826ef29191d6a784dca53660c8df55a98174d7326a8a73865cf7f35bfae034b179d85f30bb809985da3c6d170608da2e9ac9763b8fd1f8a1a4e

doc/sihl.middleware/Sihl_middleware/Csrf/Make/argument-1-TokenService/index.html

Parameter `Make.TokenService`

include Sihl_core.Container.Service.Sig

val lifecycle : Sihl_core.Container.Lifecycle.t

val create : 
  Sihl_core.Ctx.t ->
  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 : Sihl_core.Ctx.t -> string -> Sihl_token__.Model.t Lwt.t

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

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

Returns an active and non-expired token.

val configure : Sihl_core.Configuration.data -> Sihl_core.Container.Service.t

val find_by_id : Sihl_core.Ctx.t -> 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 : 
  Sihl_core.Ctx.t ->
  string ->
  Sihl_token__.Model.t option Lwt.t

Returns an active and non-expired token by id.

val invalidate : Sihl_core.Ctx.t -> 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"