sihl 0.1.9

Libraries

This package provides the following libraries (via ocamlobjinfo):

sihl

Documentation:

• Sihl

sihl.authn

Documentation:

• Sihl_authn Use this module to verify whether a user is who the user claims to be.

sihl.authz

Documentation:

• Sihl_authz Authorization deals with the question whether a user is allowed to do something. Use this module to separate the definition of who is allowed to do what from checking it.

sihl.core

Documentation:

• Sihl_core This is the core of Sihl, every other component builds on top of it.

sihl.database

Documentation:

• Sihl_database Use this module to query the database, implement and run migrations, clean repositories, turn HTTP queries into SQL queries or for sane entity identifier handling.

sihl.email

Documentation:

• Sihl_email_core Use this module to send single emails either immediately or later sending a lot of emails at once. Email template support is also provided.

sihl.http

Documentation:

• Sihl_http

sihl.message

Documentation:

• Sihl_message Use this module to display flash messages to the user across the request-response lifecycle. This is typically used to provide feedback to the user after submitting HTML forms.

sihl.middleware

Documentation:

• Sihl_middleware A middleware is a function that takes a Http.Route.handler and returns a Http.Route.handler. It is typically used to add content to the request context that is valid only during a request.

sihl.migration

Documentation:

• Sihl_migration Use the migration service to implement, register and run migrations.

sihl.password-reset

Documentation:

• Sihl_password_reset

sihl.queue

Documentation:

• Sihl_queue_core This module provides a job queue. This is typically used for long-running or resource intensive tasks.

sihl.repository

Documentation:

• Sihl_repository The repository service deals with cleaning repositories. This is useful for integration tests.

sihl.schedule

Documentation:

• Sihl_schedule Schedules are functions that need to run periodically, similarly to cron jobs. Use this for instance to run clean up jobs.

sihl.session

Documentation:

• Sihl_session Use this module to create user sessions and to read and write session data.

sihl.storage

Documentation:

• Sihl_storage_core Use this module to store and retrieve large files. This is typically used for binary files such as images or audio.

sihl.token

Documentation:

• Sihl_token The token service provides an API to generate tokens that carry some data and expire after a certain amount of time. It takes care of secure random byte generation and the persistence and validation of tokens.

sihl.user

Documentation:

• Sihl_user This module provides the abstraction of a user that interacts with the Sihl ap. Use it to register new users, changes password, reset passwords and update user details.

sihl.utils

Documentation:

• Sihl_utils A collection of services and libraries that deal with JWT, Json, Regex, Hashing, Time and Strings.