enola/build/system/errors.d.ts

API and CLI for obliterating files and directories

/**
 * An enumeration containing system errors that may occur when invoking a
 * function implemented by the Enola library.
 */
export declare enum Errors {
    /**
     * Access to the resource failed as the resource could not be found.
     */
    ResourceNotFound = 0,
    /**
     * The resource could not be modified as it is in use by another process.
     */
    ResourceLocked = 1
}
/**
 * Returns a standard error message that explains the specified `Errors`.
 *
 * If the error cannot be recognised, this function will return an unhelpful
 * message.
 *
 * @param   {Errors | number}  err
 *          The error type.
 * @return  {string}
 *          A message describing the error.
 */
export declare function getDefaultErrorMessage(err?: Errors): (string);