sihl

API

Library sihl

• Sihl

Library sihl.authn

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

Library sihl.authz

• 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.

Library sihl.core

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

Library sihl.database

• 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.

Library sihl.email

• 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.

Library sihl.http

• Sihl_http

Library sihl.message

• 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.

Library sihl.middleware

• 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.

Library sihl.migration

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

Library sihl.password-reset

• Sihl_password_reset

Library sihl.queue

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

Library sihl.repository

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

Library sihl.schedule

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

Library sihl.session

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

Library sihl.storage

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

Library sihl.token

• 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.

Library sihl.user

• 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.

Library sihl.utils

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