Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mint-tsdocs.saulo.engineer/llms.txt

Use this file to discover all available pages before exploring further.

​
ErrorCode

​
Summary

Provides structured error information for better error handling and debugging. These codes are used to categorize errors and allow for programmatic handling.

​
Members

MemberDescription
API_EXTRACTOR_ERRORAn error occurred during the run.
API_LOAD_ERRORA failure occurred when loading an API model file ().
API_PARSE_ERRORAn error occurred while parsing the content of an API model file.
COMMAND_FAILEDA command-line tool or external process failed to execute.
COMMAND_INJECTIONA potential command injection attempt was detected.
CONFIG_NOT_FOUNDThe main configuration file (e.g., ) was not found.
DANGEROUS_INPUTInput is considered dangerous (e.g., contains unsafe scripts).
DIRECTORY_NOT_FOUNDIndicates that a directory could not be found.
DOCS_JSON_PARSE_ERRORFailed to parse the file for navigation.
DOCS_JSON_WRITE_ERRORFailed to write the file.
FILE_NOT_FOUNDIndicates that a file could not be found at the specified path.
FILE_READ_ERRORIndicates a failure to read from a file (e.g., permissions).
FILE_WRITE_ERRORIndicates a failure to write to a file (e.g., permissions, disk full).
INVALID_API_JSONThe API model JSON is structurally invalid or missing required fields.
INVALID_CONFIGURATIONThe configuration is invalid or contains conflicting settings.
INVALID_FILENAMEIndicates that a filename is invalid for the operating system.
INVALID_MARKDOWNThe markdown content is invalid or malformed.
INVALID_PARAMETER_VALUEA parameter in the configuration has an invalid value.
MISSING_REQUIRED_PARAMETERA required parameter or setting is missing from the configuration.
NAVIGATION_ERRORAn error occurred while generating or processing documentation navigation.
PATH_TRAVERSALRepresents a path traversal attempt, a security-related file system error.
RENDER_ERRORA general error during the final rendering stage.
SECURITY_VIOLATIONA general security violation that doesn’t fit other categories.
TEMPLATE_COMPILE_ERRORAn error occurred while compiling a template.
TEMPLATE_ERRORA generic error related to templating.
TEMPLATE_NOT_FOUNDA required template file (e.g., ) was not found.
TEMPLATE_RENDER_ERRORAn error occurred while rendering a template with data.
TYPE_ANALYSIS_ERRORAn error occurred during TypeScript type analysis.
UNKNOWN_ERRORAn unknown or unexpected error occurred. This is the default error code.
USER_CANCELLEDThe user cancelled the operation (e.g., via a CLI prompt).
VALIDATION_ERRORA validation rule failed. Used for general-purpose validation.