# SuperWorker v0.6.0 - Table of Contents

> SuperWorker is a powerful Elixir library for working with supervisors and background jobs.
It provides a much simpler approach than traditional supervisors.
This library is currently under development and is unstable, so it is not recommended for production use.

## Pages

- [Config Guide](config_guide.md)
- [Config Quickstart](config_quickstart.md)
- [Readme](readme.md)

## Modules

- [SuperWorker](SuperWorker.md): Documentation for `SuperWorker`.
- [SuperWorker.CircuitBreaker](SuperWorker.CircuitBreaker.md): A simple Circuit Breaker implementation for protecting external API calls.
- [SuperWorker.ConfigLoader.Bootstrap](SuperWorker.ConfigLoader.Bootstrap.md): Bootstraps supervisors from parsed configurations.
- [SuperWorker.ConfigLoader.ConfigParser](SuperWorker.ConfigLoader.ConfigParser.md): This module is the main entry point for loading supervisor configurations.
It reads configurations from the application environment, uses the Parser
to validate and expand them, and the Bootstrap to start the supervisors.

- [SuperWorker.ConfigLoader.Parser](SuperWorker.ConfigLoader.Parser.md): Parses and validates supervisor configurations from the application environment.
- [SuperWorker.Log](SuperWorker.Log.md): Conditional debug logging for SuperWorker.
- [SuperWorker.Supervisor](SuperWorker.Supervisor.md): Documentation for `SuperWorker.Supervisor`.
This module is new model supervisor.
Better support for modern applications.
That is an all-in-one supervisor for Elixir application.
Easy to identify the worker for directly communicating with it.
- [SuperWorker.Supervisor.ApiHelper](SuperWorker.Supervisor.ApiHelper.md): Utility functions for SuperWorker.Supervisor.
- [SuperWorker.Supervisor.Chain](SuperWorker.Supervisor.Chain.md): Documentation for `SuperWorker.Supervisor.Chain`.

- [SuperWorker.Supervisor.Chain.Config](SuperWorker.Supervisor.Chain.Config.md): Handles the configuration and validation for a Chain.
- [SuperWorker.Supervisor.Chain.Messaging](SuperWorker.Supervisor.Chain.Messaging.md): Handles message passing and data flow within a worker chain.
- [SuperWorker.Supervisor.Constants.Strategies](SuperWorker.Supervisor.Constants.Strategies.md): This module defines the valid restart strategies for different types of workers.

- [SuperWorker.Supervisor.Constants.Timeouts](SuperWorker.Supervisor.Constants.Timeouts.md): This module contains all timeout-related constants used in the SuperWorker system.

- [SuperWorker.Supervisor.Constants.Types](SuperWorker.Supervisor.Constants.Types.md): This module defines various types and constant lists used throughout the SuperWorker system.

- [SuperWorker.Supervisor.Constants.Validation](SuperWorker.Supervisor.Constants.Validation.md): Provides validation functions for various constants and parameters in the SuperWorker system.

- [SuperWorker.Supervisor.Group](SuperWorker.Supervisor.Group.md): Documentation for `SuperWorker.Supervisor.Group`.

- [SuperWorker.Supervisor.Looper](SuperWorker.Supervisor.Looper.md): Main message loop for partition processes.
- [SuperWorker.Supervisor.MapQueue](SuperWorker.Supervisor.MapQueue.md): A simple queue implementation using a map for O(1) lookups.
- [SuperWorker.Supervisor.Partition](SuperWorker.Supervisor.Partition.md): Partition processes of a `SuperWorker.Supervisor`.
- [SuperWorker.Supervisor.Utils](SuperWorker.Supervisor.Utils.md): Utility functions for SuperWorker.Supervisor.
- [SuperWorker.Supervisor.Validator](SuperWorker.Supervisor.Validator.md): Utility functions for SuperWorker.Supervisor.
- [SuperWorker.Supervisor.Worker](SuperWorker.Supervisor.Worker.md): Documentation for `SuperWorker.Supervisor.Worker`.

- [SuperWorker.TermStorage](SuperWorker.TermStorage.md): A thin wrapper around `:persistent_term` for storing terms that are rarely
updated and read from many processes on the node.

- Exceptions
  - [SuperWorker.Error](SuperWorker.Error.md): Exception module for SuperWorker errors.
  - [SuperWorker.Supervisor.ErrorHandler](SuperWorker.Supervisor.ErrorHandler.md): Provides consistent error handling for the SuperWorker system.