Skip to main content

Function: isSecretKey()

True when a key name looks like it might hold a secret. Checked against a fixed pattern, not a per-registry allowlist.

isSecretKey(key: string): boolean

Defined in: scrub.ts:15

True when a key name looks like it might hold a secret. Checked against a fixed pattern, not a per-registry allowlist.

Parameters

key

string

Returns

boolean

Example

isSecretKey('apiToken') // true: substring match, so it over-redacts rather than under-redacts
isSecretKey('widgetId') // false