@signalwire/docusaurus-plugin-llms-txt
Version:
Generate Markdown versions of Docusaurus HTML pages and an llms.txt index file
91 lines • 2.77 kB
TypeScript
/**
* Domain-specific error types for the plugin
* Follows the development rules for typed error handling
*/
/**
* Abstract base class for all plugin-specific errors
*/
export declare abstract class PluginError extends Error {
readonly _context?: Record<string, unknown> | undefined;
abstract readonly code: string;
constructor(message: string, _context?: Record<string, unknown> | undefined);
get context(): Record<string, unknown> | undefined;
}
/**
* Configuration-related errors
*/
export declare class PluginConfigError extends PluginError {
readonly code: "PLUGIN_CONFIG_ERROR";
}
/**
* Processing-related errors (HTML conversion, file processing)
* @internal
*/
export declare class PluginProcessingError extends PluginError {
readonly code: "PLUGIN_PROCESSING_ERROR";
}
/**
* Cache-related errors
* @internal
*/
export declare class PluginCacheError extends PluginError {
readonly code: "PLUGIN_CACHE_ERROR";
}
/**
* File system operation errors
* @internal
*/
export declare class PluginFileError extends PluginError {
readonly code: "PLUGIN_FILE_ERROR";
}
/**
* Validation errors
*/
export declare class PluginValidationError extends PluginError {
readonly code: "PLUGIN_VALIDATION_ERROR";
}
/**
* Type guard to check if an error is a plugin error
*/
export declare function isPluginError(error: unknown): error is PluginError;
/**
* Create a configuration error with context
* @internal
*/
export declare function createConfigError(message: string, context?: Record<string, unknown>): PluginConfigError;
/**
* Create a processing error with context
* @internal
*/
export declare function createProcessingError(message: string, context?: Record<string, unknown>): PluginProcessingError;
/**
* Create a cache error with context
* @internal
*/
export declare function createCacheError(message: string, context?: Record<string, unknown>): PluginCacheError;
/**
* Create a file error with context
* @internal
*/
export declare function createFileError(message: string, context?: Record<string, unknown>): PluginFileError;
/**
* Create a validation error with context
* @internal
*/
export declare function createValidationError(message: string, context?: Record<string, unknown>): PluginValidationError;
/**
* Type guard to check if an unknown value is an Error
* @internal
*/
export declare function isError(error: unknown): error is Error;
/**
* Safely extracts an error message from an unknown error value
* @internal
*/
export declare function getErrorMessage(error: unknown): string;
/**
* Safely extracts an Error instance from an unknown error value
* @internal
*/
export declare function getErrorCause(error: unknown): Error | undefined;
//# sourceMappingURL=index.d.ts.map