"~effect/ErrorReporter/severity"Defines the string property key used to override the severity level of an object error.
When to use
Use to type the property key that overrides the reporting severity for object errors.
Details
When set to a valid LogLevel.Severity, the reporter callback receives this
value as severity. Missing or invalid values fall back to "Info".
export type type severity =
"~effect/ErrorReporter/severity"
Defines the string property key used to override the severity level of an object error.
When to use
Use to type the property key that overrides the reporting severity for object
errors.
Details
When set to a valid LogLevel.Severity, the reporter callback receives this
value as severity. Missing or invalid values fall back to "Info".
Defines the runtime property key used to override the severity level of an object error.
When to use
Use to annotate object errors with the severity reporter callbacks should
receive.
Details
Set error[ErrorReporter.severity] to a valid LogLevel.Severity value.
Missing or invalid values fall back to "Info".
Example (Setting error severity annotations)
import { Data, ErrorReporter } from "effect"
class DeprecationWarning extends Data.TaggedError("DeprecationWarning")<{}> {
readonly [ErrorReporter.severity] = "Warn" as const
}
severity = "~effect/ErrorReporter/severity"
/**
* Defines the runtime property key used to override the severity level of an object error.
*
* **When to use**
*
* Use to annotate object errors with the severity reporter callbacks should
* receive.
*
* **Details**
*
* Set `error[ErrorReporter.severity]` to a valid `LogLevel.Severity` value.
* Missing or invalid values fall back to `"Info"`.
*
* **Example** (Setting error severity annotations)
*
* ```ts
* import { Data, ErrorReporter } from "effect"
*
* class DeprecationWarning extends Data.TaggedError("DeprecationWarning")<{}> {
* readonly [ErrorReporter.severity] = "Warn" as const
* }
* ```
*
* @see {@link getSeverity} for reading the severity stored under this key
* @see {@link Reportable} for the annotation contract recognized on object
* errors
*
* @category annotations
* @since 4.0.0
*/
export const const severity: severityDefines the string property key used to override the severity level of an object error.
When to use
Use to type the property key that overrides the reporting severity for object
errors.
Details
When set to a valid LogLevel.Severity, the reporter callback receives this
value as severity. Missing or invalid values fall back to "Info".
Defines the runtime property key used to override the severity level of an object error.
When to use
Use to annotate object errors with the severity reporter callbacks should
receive.
Details
Set error[ErrorReporter.severity] to a valid LogLevel.Severity value.
Missing or invalid values fall back to "Info".
Example (Setting error severity annotations)
import { Data, ErrorReporter } from "effect"
class DeprecationWarning extends Data.TaggedError("DeprecationWarning")<{}> {
readonly [ErrorReporter.severity] = "Warn" as const
}
severity: type severity =
"~effect/ErrorReporter/severity"
Defines the string property key used to override the severity level of an object error.
When to use
Use to type the property key that overrides the reporting severity for object
errors.
Details
When set to a valid LogLevel.Severity, the reporter callback receives this
value as severity. Missing or invalid values fall back to "Info".
Defines the runtime property key used to override the severity level of an object error.
When to use
Use to annotate object errors with the severity reporter callbacks should
receive.
Details
Set error[ErrorReporter.severity] to a valid LogLevel.Severity value.
Missing or invalid values fall back to "Info".
Example (Setting error severity annotations)
import { Data, ErrorReporter } from "effect"
class DeprecationWarning extends Data.TaggedError("DeprecationWarning")<{}> {
readonly [ErrorReporter.severity] = "Warn" as const
}
severity = "~effect/ErrorReporter/severity"