Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@types/redact-secrets

Package Overview
Dependencies
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@types/redact-secrets

TypeScript definitions for redact-secrets

  • 1.0.3
  • ts4.5
  • ts4.6
  • ts4.7
  • ts4.8
  • ts4.9
  • ts5.0
  • ts5.1
  • ts5.2
  • ts5.3
  • ts5.4
  • ts5.5
  • ts5.6
  • ts5.7
  • ts5.8
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

Installation

npm install --save @types/redact-secrets

Summary

This package contains type definitions for redact-secrets (https://github.com/watson/redact-secrets#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/redact-secrets.

index.d.ts

interface Redactor {
    /**
     * @param obj The object to redact.
     * @returns A clone of the given `obj` with its secret values redacted.
     */
    map<TObj extends Record<string, any>>(obj: TObj): TObj;
    /**
     * Redacts the secret values of the `obj` in-place.
     *
     * @param obj The object to redact.
     */
    forEach(obj: Record<string, unknown>): void;
}

/**
 * Create a redactor instance.
 *
 * @param redacted The string used as a replacement variable for values that are redacted.
 *
 * @example
 * const makeRedact = require('redact-secrets')
 *
 * const redact = makeRedact('[REDACTED]')
 *
 * const obj = {
 *   username: 'watson',
 *   password: 'hhGu38gf',
 *   extra: {
 *     id: 1,
 *     token: 'some-secret-stuff'
 *     card: '1234 1234 1234 1234'
 *   }
 * }
 *
 * console.log(redact.map(obj))
 * // {
 * //   username: 'watson',
 * //   password: '[REDACTED]',
 * //   extra: {
 * //     id: 1,
 * //     token: '[REDACTED]'
 * //     card: '[REDACTED]'
 * //   }
 * // }
 */
declare function Redact(redacted: string): Redactor;

export = Redact;

Additional Details

  • Last updated: Tue, 07 Nov 2023 09:09:39 GMT
  • Dependencies: none

Credits

These definitions were written by wrumsby.

FAQs

Package last updated on 07 Nov 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc