Class Redactor

Removes secrets from log text and fields: every registered secret value, the argument of an FTP PASS command, the password in URL user info, and password-like query parameters.

Index

Constructors

Methods

addSecret redact redactValue removeSecret

Constructors

constructor

new Redactor(): Redactor

Returns Redactor

Methods

addSecret

addSecret(value: string): void
Registers a secret, such as a password just read, so no later text shows it.
Parameters
- value: string
Returns void
- Defined in log/logger.ts:59

redact

redact(text: string): string
text with every registered secret and every recognized password form replaced.
Parameters
- text: string
Returns string
- Defined in log/logger.ts:71

redactValue

redactValue(value: unknown, depth?: number): unknown
A copy of value with strings redacted and fields named like secrets replaced, up to eight levels deep.
Parameters
- value: unknown
- depth: number = 0
Returns unknown
- Defined in log/logger.ts:84

removeSecret

removeSecret(value: string): void
Forgets a secret that is no longer in use.
Parameters
- value: string
Returns void
- Defined in log/logger.ts:66