Interface MaskOptions

Type that represents an options object to determine how log masking should be performed.

Hierarchy

  • MaskOptions

Properties

currentDepth? keywords? maskMode? maxDepth?

Properties

Optional currentDepth

currentDepth?: number

Value to track the current depth of an object while it is being traversed. Set automatically by the maskObject function.

Optional keywords

keywords?: null | string[]

An array of keywords which are used to determine if logged value should be masked or not. If null or empty - masking is not done in default implementation.

Optional maskMode

maskMode?: MaskMode

Control masking behavior based on set value.

Optional maxDepth

maxDepth?: null | number

The maximum depth of the object to be masked. If not specified or set to zero, the whole object will be traversed and masked. If specified, only the first maxDepth levels of the object will be masked and values of properties that go over the max will be replaced by a placeholder string. If set to 1 - only the root properties will be logged.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc