Installation
npm install --save @types/is-secret
Summary
This package contains type definitions for is-secret (https://github.com/watson/is-secret#readme).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/is-secret.
index.d.ts
/**
* A distributed maintained collection of patterns that indicate that something probably is secret.
* This is useful if you want to filter sensitive values in a data set.
* This module uses a very simple algorithm that will not catch everything. Use at your own risk.
*/
/**
* Validates the given string against a list of key names known to typically indicate secret data.
* Returns `true` if the string is considered secret. Otherwise `false`.
*/
export function key(str: string): boolean;
/**
* Validates the given string against a list of patterns that indicates secret data.
* Returns `true` if the string is considered secret. Otherwise `false`.
*/
export function value(str: string): boolean;Additional Details
- Last updated: Tue, 07 Nov 2023 03:09:37 GMT
- Dependencies: none
Credits
These definitions were written by Walter Rumsby, and Piotr Błażejewicz.