Skip to main content

SecretString

@webda/core

Class: SecretString

Defined in: packages/core/src/services/cryptoservice.service.ts:16

Wraps a secret string value, masking it in logs and inspect output

Constructors​

Constructor​

new SecretString(str, encrypter): SecretString

Defined in: packages/core/src/services/cryptoservice.service.ts:21

Create a new SecretString

Parameters​

str​

string

the secret value

encrypter​

string

the encrypter service name

Returns​

SecretString

Properties​

encrypter​

protected encrypter: string

Defined in: packages/core/src/services/cryptoservice.service.ts:23

the encrypter service name

str​

protected str: string

Defined in: packages/core/src/services/cryptoservice.service.ts:22

the secret value

Methods​

[custom]()​

[custom](depth, options, inspect): string

Defined in: packages/core/src/services/cryptoservice.service.ts:62

Custom inspect handler to mask the secret in Node.js util.inspect

Parameters​

depth​

any

the depth level

options​

any

the options

inspect​

any

the inspect function

Returns​

string

the result

getValue()​

getValue(): string

Defined in: packages/core/src/services/cryptoservice.service.ts:45

Get the underlying secret value

Returns​

string

the result string

toString()​

toString(): string

Defined in: packages/core/src/services/cryptoservice.service.ts:52

Return a masked representation to prevent secret leakage

Returns​

string

the result string

from()​

static from(value, path?): string

Defined in: packages/core/src/services/cryptoservice.service.ts:32

Extract the plain string value, warning if the string is not encrypted

Parameters​

value​

string | SecretString

the value to set

path?​

string

the path

Returns​

string

the result string