@report-toolkit/common
Version:
See docs at [https://ibm.github.io/report-toolkit](https://ibm.github.io/report-toolkit)
21 lines (20 loc) • 675 B
TypeScript
export function redact(obj: object, opts?: RedactOptions): object;
export type RedactOptions = {
/**
* - Also redact these
* keypaths (e.g., `header.cwd`) or matching values. A matching keypath will
* redact all children; if the value of `match` is `header`, _everything_ in the
* report's `header` prop will be redacted.
*/
match?: string | string[] | RegExp | RegExp[];
/**
* - Whitelist these keypaths from redaction
*/
whitelist?: RegExp[];
/**
* - If `true`, redact an already-redacted object
* (one which has `[kRedacted]: true` root prop)
*/
force?: boolean;
};
export const SECRETS: RegExp[];