package sihl

You can search for identifiers within the package.

in-package search v0.2.0

The Sihl web framework

Install

dune-project

Dependency

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

Authors

Maintainers

J

josef@oxidizing.io

Sources

2.0.1.tar.gz

md5=52b28d3faac0a2243735285aa3f962aa

sha512=e7ff89bdba9f1afa3b115a056ae3d403f602685187a968485ea64a7cd1a18791f66b7480b682bf66acd3564dd89139162779d58a43c2389d785c98e246094a18

doc/sihl/Sihl/App/index.html

Module `Sihl.App`Source

A module to create Sihl apps.

Sourcetype t

An app is a thin convenience layer on top of the service container. It provides hooks that are executed at different stages in the app lifecycle.

Sourceval empty : t

empty returns an app without any services.

Sourceval with_services : Sihl__.Core_service.t list -> t -> t

with_services services app adds services to an app.

Sourceval before_start : (unit -> unit Lwt.t) -> t -> t

before_start f app registers a callback f with app. The callback is executed before any service is started. This means you must not use any services here!

Sourceval after_stop : (unit -> unit Lwt.t) -> t -> t

after_stop f app registers a callback f with app. The callback is executed before after services are stopped. This means you must not use any services here!

Source

val run : 
  ?commands:Sihl__.Core_command.t list ->
  ?log_reporter:Logs.reporter ->
  ?args:string list ->
  t ->
  unit

run ?commands ?log_reporter app is the main entry point to a Sihl app and starts the command line interface with commands merged with the commands provided by services.

An optional log_reporter can be provided to change the logging behavior. The default log reporter logs to stdout.

Source

val run' : 
  ?commands:Sihl__.Core_command.t list ->
  ?log_reporter:Logs.reporter ->
  ?args:string list ->
  t ->
  unit Lwt.t

run' ?commands ?log_reporter app is analogous to run. It is a helper to be used in tests that need Lwt.t.