@hackylabs/deep-redact/dist/types/index.d.ts

A fast, safe and configurable zero-dependency library for redacting strings or deeply redacting arrays and objects.

import type { DeepRedactConfig, RedactorUtilsConfig, BlacklistKeyConfig, Types, Transformer, ComplexStringTest, BaseDeepRedactConfig, OrganisedTransformers, TransformerConfig } from './types';
import { organisedStandardTransformers, standardTransformers } from './utils/standardTransformers';
declare class DeepRedact {
    /**
     * The redactorUtils instance to handle the redaction.
     * @private
     */
    private redactorUtils;
    /**
     * The configuration for the redaction.
     * @private
     */
    private readonly config;
    /**
     * Create a new DeepRedact instance with the provided configuration.
     * The configuration will be merged with the default configuration.
     * `blacklistedKeys` will be normalised to an array inherited from the default configuration as the default values.
     * @param {DeepRedactConfig} config. The configuration for the redaction.
     */
    constructor(config: DeepRedactConfig);
    /**
     * Redact the provided value. The value will be stripped of any circular references and other unsupported data types, before being redacted according to the configuration and finally serialised if required.
     * @param {unknown} value The value to redact.
     * @returns {unknown} The redacted value.
     * @throws {Error} If the value cannot be serialised to JSON and serialise is true.
     */
    redact: (value: unknown) => unknown;
}
export { DeepRedact, DeepRedact as default, type BaseDeepRedactConfig, type RedactorUtilsConfig, type BlacklistKeyConfig, type ComplexStringTest, type Transformer, type Types, type OrganisedTransformers, type TransformerConfig, standardTransformers, organisedStandardTransformers, };