| 1 | import { LogEntry } from '../logger.js';
|
| 2 | import { Transform } from '../transform.js';
|
| 3 | /** Configuration options for the Caterpillar Filter Transform */
|
| 4 | export interface FilterOptions {
|
| 5 | /** Use to override the default value of {@link Filter.filterLevel} */
|
| 6 | filterLevel?: number;
|
| 7 | }
|
| 8 | /**
|
| 9 | * Caterpillar Filter Transform.
|
| 10 | * Filters the log entries, keeping only those equal to or below the specified `filterLevel`.
|
| 11 | * @example
|
| 12 | * ``` javascript
|
| 13 | * import { Logger, Filter } from 'caterpillar'
|
| 14 | * const logger = new Logger()
|
| 15 | * const filter = new Filter({ filterLevel: 6 })
|
| 16 | * logger.pipe(filter).pipe(process.stdout)
|
| 17 | * logger.log('info', 'this will be outputted')
|
| 18 | * logger.log('debug', 'this will be ignored')
|
| 19 | * filter.filterLevel = 5
|
| 20 | * logger.log('info', 'now even this will be ignored')
|
| 21 | * logger.log('note', 'but not this')
|
| 22 | * ```
|
| 23 | */
|
| 24 | export declare class Filter extends Transform {
|
| 25 | /**
|
| 26 | * Only display entries that have a log level below or equal to this number.
|
| 27 | * Defaults to `6`, which by default is the info log level.
|
| 28 | */
|
| 29 | filterLevel: number;
|
| 30 | /** Create our instance and apply our configuraiton options. */
|
| 31 | constructor(opts?: FilterOptions);
|
| 32 | /** Retain only log entries that are equal to or less than the specified filter level. */
|
| 33 | format(entry: LogEntry): LogEntry | null;
|
| 34 | }
|
| 35 | export default Filter;
|
| 36 | //# sourceMappingURL=filter.d.ts.map |
| \ | No newline at end of file |