# Class PatternLayout
Class return authorsModule | import { PatternLayout } from "@tsed/logger" |
---|---|
Source | /packages/logger/src/types/layouts/components/PatternLayout.ts |
# Overview
class PatternLayout extends BaseLayout {
#private;
constructor(config: BasicLayoutConfiguration);
<span class="token function">transform</span><span class="token punctuation">(</span>loggingEvent<span class="token punctuation">:</span> <a href="/api/logger/types/core/LogEvent.html"><span class="token">LogEvent</span></a><span class="token punctuation">,</span> timezoneOffset?<span class="token punctuation">:</span> <span class="token keyword">number</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">;</span>
}
# Description
PatternLayout Format for specifiers is %[padding].[truncation][field]{[format]} e.g. %5.10p - left pad the log level by 5 characters, up to a max of 10 Fields can be any of:
- %r time in toLocaleTimeString format
- %p log level
- %c log category
- %h hostname
- %m log data
- %j log data as JSON
- %d date in constious formats
- %% %
- %n newline
- %z pid
- %x{[tokenname]} add dynamic tokens to your log. Tokens are specified in the tokens parameter You can use %[ and %] to define a colored block.
Tokens are specified as simple key:value objects. The key represents the token name whereas the value can be a string or function which is called to extract the value to put in the log message. If token is not found, it doesn't replace the field.
A sample token would be: { 'pid' : function() { return process.pid; } }
Takes a pattern string, array of tokens and returns a layouts function.
# Members
#private;
transform(loggingEvent: LogEvent, timezoneOffset?: number): string;
Other topics
- Console Appender
- File Appender
- Date Rolling File Appender
- Connect Appender
- Standard Out Appender
- Standard Error Appender
- Insight Appender
- LogEntries Appender
- LogStash HTTP Appender
- LogStash UDP Appender
- Loggly Appender
- RabbitMQ Appender
- Seq Appender
- Slack Appender
- SMTP Appender
- Basic layout
- Colored layout
- Dummy layout
- Message Pass-Through layout
- Object layout
- Json layout
- Pattern layout