class staticbo.rules. RuleNotice
Source: rules/
Represents the public information of a failed rule.
new RuleNotice(message[, severity])
Creates a new rule notice instance.
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
|
message |
string |
|
Human-readable description of the reason of the failure. |
|
severity |
Yes |
The severity of the rule failure, defaults to error. |
- Throws
-
Argument error: The message must be a non-empty string.
-
Argument error: The severity must be a RuleSeverity item.
Properties
read-onlymessage
string
Human-readable description of the reason of rule failure.
read-onlyseverity
bo.rules.RuleSeverity
The severity of the rule failure.