Class: Redactor
Defined in: src/shield/redaction/redactor.ts:150 Redactor class for detecting and handling secrets in output streams.Constructors
Constructor
Parameters
options
RedactorOptions = {}
Returns
Redactor
Methods
addAllowlist()
Parameters
entries
AllowlistEntry[]
Returns
void
addBlockedStrings()
Parameters
strings
string[]
Returns
void
addExcludeKeywords()
Parameters
keywords
string[]
Returns
void
addPattern()
Parameters
name
string
pattern
string
flags
string = 'gi'
severity
"low" | "medium" | "high" | "critical"
Returns
boolean
addSensitiveKeywords()
Parameters
keywords
string[]
Returns
void
clearPatterns()
Returns
void
flush()
Returns
Buffer<ArrayBufferLike> | null
getExcludeKeywords()
Returns
string[]
getExposureCount()
Returns
number
getMinConfidence()
Returns
number
getMode()
Returns
getPatternCount()
Returns
number
getPatternErrors()
Returns
readonlyPatternCompilationError[]
getSensitiveKeywords()
Returns
string[]
getTrackedSecretCount()
Returns
number
hasPatternErrors()
Returns
boolean
isContextualEnabled()
Returns
boolean
isEntropyEnabled()
Returns
boolean
scan()
Parameters
text
string
Returns
SecretMatch[]
setMinConfidence()
Parameters
threshold
number
Returns
void
setMode()
Parameters
mode
Returns
void
trackSecret()
Parameters
name
string
value
string
Returns
void
trackSecrets()
Parameters
secrets
Record<string, string>
Returns
void
transform()
Parameters
data
string | Buffer<ArrayBufferLike>
Returns
Buffer<ArrayBufferLike> | null