Graphorin API reference v0.1.0
Graphorin API reference / @graphorin/observability / / WithValidationOptions
Interface: WithValidationOptions
Defined in: packages/observability/src/exporters/with-validation.ts:27
Options for withValidation.
Stable
Extends
Properties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
customValidator? | readonly | (input) => | RedactionOutput | null | Optional pluggable additional check, fired after the pattern scan succeeds. The callback returns null to drop the value or a sanitized RedactionOutput to forward. | RedactionValidatorOptions.customValidator | packages/observability/src/redaction/types.ts:103 |
disabledPatterns? | readonly | readonly string[] | Per-name deny-list. Patterns listed here are skipped entirely. Applied after enabledPatterns. | RedactionValidatorOptions.disabledPatterns | packages/observability/src/redaction/types.ts:92 |
enabledPatterns? | readonly | readonly string[] | Per-name allow-list. When provided, only patterns whose name appears here are evaluated. Empty array disables all pattern matching (tier filtering still applies). | RedactionValidatorOptions.enabledPatterns | packages/observability/src/redaction/types.ts:87 |
failOnUnredactedSensitive? | readonly | boolean | When true, throw a RedactionValidationError on any drop. Useful in tests; production should keep this off so the validator silently drops + counts. | RedactionValidatorOptions.failOnUnredactedSensitive | packages/observability/src/redaction/types.ts:76 |
id? | readonly | string | Identifier reported via validator.id. Defaults to 'default'. | RedactionValidatorOptions.id | packages/observability/src/redaction/types.ts:68 |
minTier? | readonly | Sensitivity | Lowest tier that may pass through the validator. Default: 'public'. | RedactionValidatorOptions.minTier | packages/observability/src/redaction/types.ts:70 |
onViolation? | readonly | RedactionViolationCallback | Optional sink invoked on every violation. Receives only sanitized data; never receives secret values. | RedactionValidatorOptions.onViolation | packages/observability/src/redaction/types.ts:97 |
patterns? | readonly | readonly RedactionPattern[] | Pattern catalogue. Defaults to the 14 built-in default-on patterns. Custom patterns can extend or replace this list. | RedactionValidatorOptions.patterns | packages/observability/src/redaction/types.ts:81 |
validator? | readonly | RedactionValidatorInstance | Optional pre-built validator. When supplied, the rest of the options on this object are ignored and the supplied validator is reused — useful for sharing one validator across multiple exporters. | - | packages/observability/src/exporters/with-validation.ts:33 |