# Class LoggerAppenders

Class
Module
import { LoggerAppenders } from "@tsed/logger"
Source/packages/logger/src/types/logger/class/LoggerAppenders.ts

# Overview

class LoggerAppenders {
get <span class="token function">size</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">number</span><span class="token punctuation">;</span>

<span class="token function">has</span><span class="token punctuation">(</span>name<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">boolean</span><span class="token punctuation">;</span>

<span class="token function">get</span><span class="token punctuation">(</span>name<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <a href="/api/logger/types/logger/class/LoggerAppender.html"><span class="token">LoggerAppender</span></a><span class="token punctuation">;</span>

<span class="token function">set</span><span class="token punctuation">(</span>name<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">,</span> config<span class="token punctuation">:</span> Omit&lt;<a href="/api/logger/types/appenders/interfaces/AppenderConfiguration.html"><span class="token">AppenderConfiguration</span></a><span class="token punctuation">,</span> "options"&gt; & <span class="token punctuation">{</span>
    type<span class="token punctuation">:</span> <span class="token keyword">string</span> | <span class="token keyword">any</span><span class="token punctuation">;</span>
    options?<span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">:</span> LoggerAppenders<span class="token punctuation">;</span>

<span class="token function">delete</span><span class="token punctuation">(</span>name<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">boolean</span><span class="token punctuation">;</span>

<span class="token function">clear</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">void</span><span class="token punctuation">;</span>

<span class="token function">forEach</span><span class="token punctuation">(</span>callback<span class="token punctuation">:</span> <span class="token punctuation">(</span>value<span class="token punctuation">:</span> <a href="/api/logger/types/logger/class/LoggerAppender.html"><span class="token">LoggerAppender</span></a><span class="token punctuation">,</span> key<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">,</span> map<span class="token punctuation">:</span> Map&lt;<span class="token keyword">string</span><span class="token punctuation">,</span> <a href="/api/logger/types/logger/class/LoggerAppender.html"><span class="token">LoggerAppender</span></a>&gt;<span class="token punctuation">)</span> =&gt; <span class="token keyword">void</span><span class="token punctuation">,</span> thisArg?<span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">void</span><span class="token punctuation">;</span>

<span class="token function">toArray</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span>

<span class="token function">byLogLevel</span><span class="token punctuation">(</span>loggingLevel<span class="token punctuation">:</span> <a href="/api/logger/types/core/LogLevel.html"><span class="token">LogLevel</span></a><span class="token punctuation">)</span><span class="token punctuation">:</span> <a href="/api/logger/types/appenders/class/BaseAppender.html"><span class="token">BaseAppender</span></a><span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span>

}

# Members

get size(): number;

has(name: string): boolean;
Param Type Description
name string Required. The key of the element to test for presence in the Map object.`

The `has() method returns a boolean indicating whether an element with the specified configuration name exists or not.


get(name: string): LoggerAppender;
Param Type Description
name string Required. The configuration of the element to return from the Map object.

The `get() method returns a specified element from a loggerAppenders.


set(name: string, config: Omit<AppenderConfiguration, "options"> & {
     type: string | any;
     options?: any;
 }): LoggerAppenders;

The set() method adds or updates an element with a specified key and value to a loggerAppenders object.


delete(name: string): boolean;
Param Type Description
name string Required. The key of the element to remove from the loggerAppenders object.

Remove all configuration that match with the name.


clear(): void;

The `clear() method removes all elements from a loggerAppenders object.


forEach(callback: (value: LoggerAppender, key: string, map: Map<string, LoggerAppender>) => void, thisArg?: any): void;
Param Type Description
callback (value: <a href="/api/logger/types/logger/class/LoggerAppender.html"><span class="token">LoggerAppender</span></a> Function to execute for each element. thisArg

The forEach() method executes a provided function once per each key/value pair in the loggerAppenders object, in insertion order.


toArray(): any[];

byLogLevel(loggingLevel: LogLevel): BaseAppender[];

Return all appenders that match with the given loggingLevel.

Other topics