README
¶
essentia 🧰
essentia is a toolkit which contains reusable tools, helpers and such. This allows you to focus on the essence of your project. These tools are properly tested so that you can rely on their proper functioning.
I will add some smaller examples here in the near future. For now the larger examples and tests can be used as reference.
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
For more information please read the CONTRIBUTING document.
License
Directories
¶
| Path | Synopsis |
|---|---|
|
examples
|
|
|
internal
|
|
|
pkg
|
|
|
communication/http
Package http contains several tools for dealing with http such as writing different kinds out content types and error handling.
|
Package http contains several tools for dealing with http such as writing different kinds out content types and error handling. |
|
communication/ws
Package ws contains several tools for dealing with websockets such as easily setting these up error handling.
|
Package ws contains several tools for dealing with websockets such as easily setting these up error handling. |
|
config
Package config provides functions which can be used to extract environment variables and parse them to the right type.
|
Package config provides functions which can be used to extract environment variables and parse them to the right type. |
|
context
Package context provides functions which can be used to set/get values to/from context.Context.
|
Package context provides functions which can be used to set/get values to/from context.Context. |
|
database
Package database provides database agnostic helpers.
|
Package database provides database agnostic helpers. |
|
database/postgres
Package postgres provides several github.com/jackc/pgx related helpers for interacting with postgres.
|
Package postgres provides several github.com/jackc/pgx related helpers for interacting with postgres. |
|
errors
Package errors contains reusable error messages and other helpers for dealing with errors.
|
Package errors contains reusable error messages and other helpers for dealing with errors. |
|
logging
Package logging contains helpers for logging.
|
Package logging contains helpers for logging. |
|
middleware
Package middleware provides configurable middleware and predefined lists, such as Minimal, Default and DefaultWithSentry.
|
Package middleware provides configurable middleware and predefined lists, such as Minimal, Default and DefaultWithSentry. |
|
parse
Package parse contains helper functions for parsing different kinds of URL and Query parameters.
|
Package parse contains helper functions for parsing different kinds of URL and Query parameters. |
|
sentry
Package sentry contains all sorts of tools for using Sentry.
|
Package sentry contains all sorts of tools for using Sentry. |
|
test
Package test provides multiple tools to write tests faster and keep them simple.
|
Package test provides multiple tools to write tests faster and keep them simple. |
|
time
Package time provides helpers for dealing with time.
|
Package time provides helpers for dealing with time. |
|
validate
Package validate provides an easy way to validate the data contained in structs, typically being DTOs containing user input.
|
Package validate provides an easy way to validate the data contained in structs, typically being DTOs containing user input. |
Click to show internal directories.
Click to hide internal directories.