mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-03-27 08:44:34 +00:00
Merge branch 'master' into rename-repo-url
This commit is contained in:
vvakame
174
log4javascript/log4javascript.d.ts
vendored
174
log4javascript/log4javascript.d.ts
vendored
@@ -3,13 +3,13 @@
|
||||
// Definitions by: Markus Wagner <https://github.com/Ritzlgrmft/>
|
||||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||||
|
||||
declare module log4javascript {
|
||||
declare namespace log4javascript {
|
||||
|
||||
// #region log4javascript static properties/methods
|
||||
|
||||
/**
|
||||
* Returns a logger with the specified name, creating it if a logger with that name does not already exist.
|
||||
* If no name is specified, a logger is returned with name [anonymous], and subsequent calls to getLogger()
|
||||
* Returns a logger with the specified name, creating it if a logger with that name does not already exist.
|
||||
* If no name is specified, a logger is returned with name [anonymous], and subsequent calls to getLogger()
|
||||
* (with no logger name specified) will return this same logger object.
|
||||
* Note that the names [anonymous], [default], [null] and root are reserved for the anonymous logger, default logger,
|
||||
* null logger and root logger respectively.
|
||||
@@ -17,7 +17,7 @@ declare module log4javascript {
|
||||
export function getLogger(loggerName?: string): Logger;
|
||||
|
||||
/**
|
||||
* Convenience method that returns the default logger. The default logger has a single appender: a PopUpAppender with the default
|
||||
* Convenience method that returns the default logger. The default logger has a single appender: a PopUpAppender with the default
|
||||
* layout, width and height, and with focusPopUp set to false and lazyInit, useOldPopUp and complainAboutPopUpBlocking all set to true.
|
||||
*/
|
||||
export function getDefaultLogger(): Logger;
|
||||
@@ -48,7 +48,7 @@ declare module log4javascript {
|
||||
export function isEnabled(): boolean;
|
||||
|
||||
/**
|
||||
* Adds a function to be called when an event of the type specified occurs in log4javascript.
|
||||
* Adds a function to be called when an event of the type specified occurs in log4javascript.
|
||||
* Supported event types are load (occurs once the page has loaded) and error.
|
||||
*/
|
||||
export function addEventListener(eventType: string, listener: { (sender: any, eventType: string, eventArgs: any): void; }): void;
|
||||
@@ -59,7 +59,7 @@ declare module log4javascript {
|
||||
export function removeEventListener(eventType: string, listener: { (sender: any, eventType: string, eventArgs: any): void; }): void;
|
||||
|
||||
/**
|
||||
* Raises an event of type eventType on the log4javascript object. Each of the listeners for this type of event
|
||||
* Raises an event of type eventType on the log4javascript object. Each of the listeners for this type of event
|
||||
* (registered via addEventListener) is called and passed eventArgs as the third parameter.
|
||||
*/
|
||||
export function dispatchEvent(eventType: string, eventArgs: any): void;
|
||||
@@ -70,14 +70,14 @@ declare module log4javascript {
|
||||
export function setEventTypes(eventTypes: string[]): void;
|
||||
|
||||
/**
|
||||
* Enables or disables displaying of error stack traces, depending on show. By default, stack traces are not displayed.
|
||||
* Enables or disables displaying of error stack traces, depending on show. By default, stack traces are not displayed.
|
||||
* (Only works in Firefox)
|
||||
*/
|
||||
export function setShowStackTraces(show: boolean): void;
|
||||
|
||||
/**
|
||||
* This evaluates the given expression in the log4javascript scope, thus allowing scripts to access internal
|
||||
* log4javascript variables and functions. This was written for the purposes of automated testing but could be used by
|
||||
* This evaluates the given expression in the log4javascript scope, thus allowing scripts to access internal
|
||||
* log4javascript variables and functions. This was written for the purposes of automated testing but could be used by
|
||||
* custom extensions to log4javascript.
|
||||
*/
|
||||
export function evalInScope(expr: string): any;
|
||||
@@ -87,7 +87,7 @@ declare module log4javascript {
|
||||
// #region Levels
|
||||
|
||||
/**
|
||||
* Levels are available as static properties of the log4javascript.Level object.
|
||||
* Levels are available as static properties of the log4javascript.Level object.
|
||||
*/
|
||||
export enum Level { ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF }
|
||||
|
||||
@@ -96,17 +96,17 @@ declare module log4javascript {
|
||||
// #region Loggers
|
||||
|
||||
/**
|
||||
* It is possible to have multiple loggers in log4javascript. For example, you may wish to have a logger for debugging purposes
|
||||
* It is possible to have multiple loggers in log4javascript. For example, you may wish to have a logger for debugging purposes
|
||||
* that logs messages to a pop-up window and a separate logger that reports any client-side application errors to the server via Ajax.
|
||||
* From version 1.4, log4javascript has hierarchical loggers, implemented in the same way as log4j. In summary, you specify a
|
||||
* logger's parent logger by means of a dot between the parent logger name and the child logger name. Therefore the logger
|
||||
* From version 1.4, log4javascript has hierarchical loggers, implemented in the same way as log4j. In summary, you specify a
|
||||
* logger's parent logger by means of a dot between the parent logger name and the child logger name. Therefore the logger
|
||||
* tim.app.security inherits from tim.app, which in turn inherits from tim which, finally, inherits from the root logger.
|
||||
* What inheritance means for a logger is that in the absence of a threshold level set specifically on the logger it inherits
|
||||
* its level from its parent; also, a logger inherits all its parent's appenders (this is known as appender additivity in log4j.
|
||||
* This behaviour can be enabled or disabled via setAdditivity(). See below). In the above example, if the root logger has a
|
||||
* What inheritance means for a logger is that in the absence of a threshold level set specifically on the logger it inherits
|
||||
* its level from its parent; also, a logger inherits all its parent's appenders (this is known as appender additivity in log4j.
|
||||
* This behaviour can be enabled or disabled via setAdditivity(). See below). In the above example, if the root logger has a
|
||||
* level of DEBUG and one appender, each of the loggers tim.app.security, tim.app and tim would inherit the root level's appender.
|
||||
* If, say, tim.app's threshold level was set to WARN, tim's effective level would remain at DEBUG (inherited from the root logger)
|
||||
* while tim.app.security's effective level would be WARN, inherited from tim.app. The important thing to note is that appenders
|
||||
* If, say, tim.app's threshold level was set to WARN, tim's effective level would remain at DEBUG (inherited from the root logger)
|
||||
* while tim.app.security's effective level would be WARN, inherited from tim.app. The important thing to note is that appenders
|
||||
* accumulate down the logger hierarchy while levels are simply inherited from the nearest ancestor with a threshold level set.
|
||||
* For a detailed explanation of the logger hierarchy, see the log4j manual.
|
||||
*/
|
||||
@@ -137,14 +137,14 @@ declare module log4javascript {
|
||||
getLevel(): Level;
|
||||
|
||||
/**
|
||||
* Returns the level at which the logger is operating. This is either the level explicitly set on the logger or, if no level
|
||||
* Returns the level at which the logger is operating. This is either the level explicitly set on the logger or, if no level
|
||||
* has been set, the effective level of the logger's parent.
|
||||
*/
|
||||
getEffectiveLevel(): Level;
|
||||
|
||||
/**
|
||||
* Sets whether appender additivity is enabled (the default) or disabled. If set to false, this particular logger will not
|
||||
* inherit any appenders form its ancestors. Any descendant of this logger, however, will inherit from its ancestors as
|
||||
* Sets whether appender additivity is enabled (the default) or disabled. If set to false, this particular logger will not
|
||||
* inherit any appenders form its ancestors. Any descendant of this logger, however, will inherit from its ancestors as
|
||||
* normal, unless its own additivity is explicitly set to false.
|
||||
* Default value is true.
|
||||
*/
|
||||
@@ -226,8 +226,8 @@ declare module log4javascript {
|
||||
isFatalEnabled(): boolean;
|
||||
|
||||
/**
|
||||
* Starts a new group of log messages. In appenders that support grouping (currently PopUpAppender and InPageAppender),
|
||||
* a group appears as an expandable section in the console, labelled with the name specified. Specifying initiallyExpanded
|
||||
* Starts a new group of log messages. In appenders that support grouping (currently PopUpAppender and InPageAppender),
|
||||
* a group appears as an expandable section in the console, labelled with the name specified. Specifying initiallyExpanded
|
||||
* determines whether the group starts off expanded (the default is true). Groups may be nested.
|
||||
*/
|
||||
group(name: string, initiallyExpanded?: boolean): void;
|
||||
@@ -238,8 +238,8 @@ declare module log4javascript {
|
||||
groupEnd(): void;
|
||||
|
||||
/**
|
||||
* Starts a timer with name name. When the timer is ended with a call to timeEnd using the same name, the amount of time
|
||||
* that has elapsed in milliseconds since the timer was started is logged at level level. If not level is supplied, the level
|
||||
* Starts a timer with name name. When the timer is ended with a call to timeEnd using the same name, the amount of time
|
||||
* that has elapsed in milliseconds since the timer was started is logged at level level. If not level is supplied, the level
|
||||
* defaults to INFO.
|
||||
*/
|
||||
time(name: string, level?: Level): void;
|
||||
@@ -334,13 +334,13 @@ declare module log4javascript {
|
||||
|
||||
/**
|
||||
* A flexible appender that asynchronously sends log messages to a server via HTTP.
|
||||
* The default configuration is to send each log message as a separate HTTP post request to the server using an
|
||||
* HttpPostDataLayout, without waiting for a response before sending any subsequent requests.
|
||||
* The default configuration is to send each log message as a separate HTTP post request to the server using an
|
||||
* HttpPostDataLayout, without waiting for a response before sending any subsequent requests.
|
||||
*/
|
||||
export class AjaxAppender extends Appender {
|
||||
/**
|
||||
* Constructor
|
||||
* @param url The URL to which log messages should be sent. Note that this is subject to the usual Ajax restrictions:
|
||||
* @param url The URL to which log messages should be sent. Note that this is subject to the usual Ajax restrictions:
|
||||
* the URL should be in the same domain as that of the page making the request.
|
||||
* @param withCredentials Specifies whether cookies should be sent with each request.
|
||||
*/
|
||||
@@ -380,14 +380,14 @@ declare module log4javascript {
|
||||
isTimed(): boolean;
|
||||
|
||||
/**
|
||||
* Sets whether to wait for a response from a previous HTTP request from this appender before sending the next log
|
||||
* Sets whether to wait for a response from a previous HTTP request from this appender before sending the next log
|
||||
* message / batch of messages.
|
||||
* Default value is false.
|
||||
*/
|
||||
setWaitForResponse(waitForResponse: boolean): void;
|
||||
|
||||
/**
|
||||
* Returns whether the appender waits for a response from a previous HTTP request from this appender before sending the next
|
||||
* Returns whether the appender waits for a response from a previous HTTP request from this appender before sending the next
|
||||
* log message / batch of messages.
|
||||
*/
|
||||
isWaitForResponse(): boolean;
|
||||
@@ -413,16 +413,16 @@ declare module log4javascript {
|
||||
getTimerInterval(): number;
|
||||
|
||||
/**
|
||||
* Sets the function that is called whenever a successful request is made, called at the point at which the response is
|
||||
* Sets the function that is called whenever a successful request is made, called at the point at which the response is
|
||||
* received. This feature can be used to confirm whether a request has been successful and act accordingly.
|
||||
* A single parameter, xmlHttp, is passed to the callback function. This is the XMLHttpRequest object that performed the
|
||||
* A single parameter, xmlHttp, is passed to the callback function. This is the XMLHttpRequest object that performed the
|
||||
* request.
|
||||
*/
|
||||
setRequestSuccessCallback(requestSuccessCallback: { (xmlHttp: XMLHttpRequest): void; }): void;
|
||||
|
||||
/**
|
||||
* Sets the function that is called whenever any kind of failure occurs in the appender, including browser deficiencies or
|
||||
* configuration errors (e.g. supplying a non-existent URL to the appender). This feature can be used to handle
|
||||
* Sets the function that is called whenever any kind of failure occurs in the appender, including browser deficiencies or
|
||||
* configuration errors (e.g. supplying a non-existent URL to the appender). This feature can be used to handle
|
||||
* AjaxAppender-specific errors.
|
||||
* A single parameter, message, is passed to the callback function. This is the error-specific message that caused the failure.
|
||||
*/
|
||||
@@ -444,7 +444,7 @@ declare module log4javascript {
|
||||
addHeader(name: string, value: string): void;
|
||||
|
||||
/**
|
||||
* Returns an array of the additional headers that are sent with each HTTP request. Each array item is an object with
|
||||
* Returns an array of the additional headers that are sent with each HTTP request. Each array item is an object with
|
||||
* properties name and value.
|
||||
*/
|
||||
getHeaders(): Array<{ name: string; value: string; }>;
|
||||
@@ -456,24 +456,24 @@ declare module log4javascript {
|
||||
}
|
||||
|
||||
/**
|
||||
* Logs messages to a pop-up console window (note: you will need to disable pop-up blockers to use it). The pop-up displays a
|
||||
* Logs messages to a pop-up console window (note: you will need to disable pop-up blockers to use it). The pop-up displays a
|
||||
* list of all log messages.
|
||||
*/
|
||||
export class PopUpAppender extends Appender {
|
||||
/**
|
||||
* Constructor
|
||||
* @param lazyInit Set this to true to open the pop-up only when the first log message reaches the appender. Otherwise, the
|
||||
* @param lazyInit Set this to true to open the pop-up only when the first log message reaches the appender. Otherwise, the
|
||||
* pop-up window opens as soon as the appender is created. If not specified, defaults to false.
|
||||
* @param initiallyMinimized Whether the console window should start off hidden / minimized. If not specified, defaults to false.
|
||||
* @param useDocumentWrite Specifies how the console window is created. By default, the console window is created dynamically
|
||||
* using document's write method. This has the advantage of keeping all the code in one single JavaScript file. However,
|
||||
* if your page sets document.domain then the browser prevents script access to a window unless it too has the same value
|
||||
* set for document.domain. To get round this issue, you can set useDocumentWrite to false and log4javascript will instead
|
||||
* use the external HTML file console.html (or console_uncompressed.html if you're using an uncompressed version of
|
||||
* @param useDocumentWrite Specifies how the console window is created. By default, the console window is created dynamically
|
||||
* using document's write method. This has the advantage of keeping all the code in one single JavaScript file. However,
|
||||
* if your page sets document.domain then the browser prevents script access to a window unless it too has the same value
|
||||
* set for document.domain. To get round this issue, you can set useDocumentWrite to false and log4javascript will instead
|
||||
* use the external HTML file console.html (or console_uncompressed.html if you're using an uncompressed version of
|
||||
* log4javascript.js), which must be placed in the same directory as your log4javascript.js file.
|
||||
* Note that if useDocumentWrite is set to true, the old pop-up window will always be closed and a new one created whenever
|
||||
* Note that if useDocumentWrite is set to true, the old pop-up window will always be closed and a new one created whenever
|
||||
* the page is refreshed, even if setUseOldPopUp(true) has been called.
|
||||
* In general it's simpler to use the document.write method, so unless your page needs to set document.domain,
|
||||
* In general it's simpler to use the document.write method, so unless your page needs to set document.domain,
|
||||
* useDocumentWrite should be set to true.
|
||||
* If not specified, defaults to true.
|
||||
* @param width The outer width in pixels of the pop-up window. If not specified, defaults to 600.
|
||||
@@ -502,8 +502,8 @@ declare module log4javascript {
|
||||
setFocusPopUp(focusPopUp: boolean): void;
|
||||
|
||||
/**
|
||||
* Returns whether the same pop-up window is used if the main page is reloaded. If set to true, when the page is reloaded a
|
||||
* line is drawn in the pop-up and subsequent log messages are added to the same pop-up. Otherwise, a new pop-up window is
|
||||
* Returns whether the same pop-up window is used if the main page is reloaded. If set to true, when the page is reloaded a
|
||||
* line is drawn in the pop-up and subsequent log messages are added to the same pop-up. Otherwise, a new pop-up window is
|
||||
* created that replaces the original pop-up. If not specified, defaults to true.
|
||||
*/
|
||||
isUseOldPopUp(): boolean;
|
||||
@@ -514,7 +514,7 @@ declare module log4javascript {
|
||||
setUseOldPopUp(useOldPopUp: boolean): void;
|
||||
|
||||
/**
|
||||
* Returns whether an alert is shown to the user when the pop-up window cannot be created as a result of a pop-up blocker.
|
||||
* Returns whether an alert is shown to the user when the pop-up window cannot be created as a result of a pop-up blocker.
|
||||
* Default value is true.
|
||||
*/
|
||||
isComplainAboutPopUpBlocking(): boolean;
|
||||
@@ -525,7 +525,7 @@ declare module log4javascript {
|
||||
setComplainAboutPopUpBlocking(complainAboutPopUpBlocking: boolean): void;
|
||||
|
||||
/**
|
||||
* Returns whether new log messages are displayed at the top of the pop-up window. Default value is false (i.e. log messages
|
||||
* Returns whether new log messages are displayed at the top of the pop-up window. Default value is false (i.e. log messages
|
||||
* are appended to the bottom of the window).
|
||||
*/
|
||||
isNewestMessageAtTop(): boolean;
|
||||
@@ -576,7 +576,7 @@ declare module log4javascript {
|
||||
setHeight(height: number): void;
|
||||
|
||||
/**
|
||||
* Returns the largest number of log messages that are displayed and stored by the the console. Once reached, a new log
|
||||
* Returns the largest number of log messages that are displayed and stored by the the console. Once reached, a new log
|
||||
* message wil cause the oldest message to be discarded. Default value is null, which means no limit is applied.
|
||||
*/
|
||||
getMaxMessages(): number;
|
||||
@@ -597,8 +597,8 @@ declare module log4javascript {
|
||||
setShowCommandLine(showCommandLine: boolean): void;
|
||||
|
||||
/**
|
||||
* Returns the number of levels to expand when an object value is logged to the console. Each property of an object above
|
||||
* this threshold will be expanded if it is itself an object or array, otherwise its string representation will be displayed.
|
||||
* Returns the number of levels to expand when an object value is logged to the console. Each property of an object above
|
||||
* this threshold will be expanded if it is itself an object or array, otherwise its string representation will be displayed.
|
||||
* Default value is 1 (i.e. the properties of the object logged will be displayed in their string representation but not expanded).
|
||||
*/
|
||||
getCommandLineObjectExpansionDepth(): number;
|
||||
@@ -619,7 +619,7 @@ declare module log4javascript {
|
||||
setCommandWindow(commandWindow: Window): void;
|
||||
|
||||
/**
|
||||
* Returns the layout used to format the output for commands typed into the command line. The default value is a
|
||||
* Returns the layout used to format the output for commands typed into the command line. The default value is a
|
||||
* PatternLayout with pattern string %m
|
||||
*/
|
||||
getCommandLayout(): Layout;
|
||||
@@ -670,7 +670,7 @@ declare module log4javascript {
|
||||
evalCommandAndAppend(expr: string): void;
|
||||
|
||||
/**
|
||||
* Adds a function with the name specified to the list of functions available on the command line. This feature may be used
|
||||
* Adds a function with the name specified to the list of functions available on the command line. This feature may be used
|
||||
* to add custom functions to the command line.
|
||||
*/
|
||||
addCommandLineFunction(functionName: string,
|
||||
@@ -678,23 +678,23 @@ declare module log4javascript {
|
||||
}
|
||||
|
||||
/**
|
||||
* Logs messages to a console window in the page. The console is identical to that used by the PopUpAppender, except for the
|
||||
* Logs messages to a console window in the page. The console is identical to that used by the PopUpAppender, except for the
|
||||
* absence of a 'Close' button.
|
||||
*/
|
||||
export class InPageAppender extends Appender {
|
||||
/**
|
||||
* Constructor
|
||||
* @param container The container element for the console window. This should be an HTML element.
|
||||
* @param lazyInit Set this to true to create the console only when the first log message reaches the appender. Otherwise,
|
||||
* @param lazyInit Set this to true to create the console only when the first log message reaches the appender. Otherwise,
|
||||
* the console is initialized as soon as the appender is created. If not specified, defaults to true.
|
||||
* @param initiallyMinimized Whether the console window should start off hidden / minimized. If not specified, defaults to false
|
||||
* @param useDocumentWrite Specifies how the console window is created. By default, the console window is created dynamically
|
||||
* using document's write method. This has the advantage of keeping all the code in one single JavaScript file. However,
|
||||
* if your page sets document.domain then the browser prevents script access to a window unless it too has the same value
|
||||
* set for document.domain. To get round this issue, you can set useDocumentWrite to false and log4javascript will instead
|
||||
* use the external HTML file console.html (or console_uncompressed.html if you're using an uncompressed version of
|
||||
* @param useDocumentWrite Specifies how the console window is created. By default, the console window is created dynamically
|
||||
* using document's write method. This has the advantage of keeping all the code in one single JavaScript file. However,
|
||||
* if your page sets document.domain then the browser prevents script access to a window unless it too has the same value
|
||||
* set for document.domain. To get round this issue, you can set useDocumentWrite to false and log4javascript will instead
|
||||
* use the external HTML file console.html (or console_uncompressed.html if you're using an uncompressed version of
|
||||
* log4javascript.js), which must be placed in the same directory as your log4javascript.js file.
|
||||
* In general it's simpler to use the document.write method, so unless your page needs to set document.domain,
|
||||
* In general it's simpler to use the document.write method, so unless your page needs to set document.domain,
|
||||
* useDocumentWrite should be set to true.
|
||||
* If not specified, defaults to true.
|
||||
* @param width The width of the console window. Any valid CSS length may be used. If not specified, defaults to 100%.
|
||||
@@ -724,7 +724,7 @@ declare module log4javascript {
|
||||
setInitiallyMinimized(initiallyMinimized: boolean): void;
|
||||
|
||||
/**
|
||||
* Returns whether new log messages are displayed at the top of the pop-up window. Default value is false (i.e. log messages
|
||||
* Returns whether new log messages are displayed at the top of the pop-up window. Default value is false (i.e. log messages
|
||||
* are appended to the bottom of the window).
|
||||
*/
|
||||
isNewestMessageAtTop(): boolean;
|
||||
@@ -785,7 +785,7 @@ declare module log4javascript {
|
||||
setShowCommandLine(showCommandLine: boolean): void;
|
||||
|
||||
/**
|
||||
* Returns the number of levels to expand when an object value is logged to the console. Each property of an object above
|
||||
* Returns the number of levels to expand when an object value is logged to the console. Each property of an object above
|
||||
* this threshold will be expanded if it is itself an object or array, otherwise its string representation will be displayed.
|
||||
* Default value is 1 (i.e. the properties of the object logged will be displayed in their string representation but not expanded).
|
||||
*/
|
||||
@@ -807,7 +807,7 @@ declare module log4javascript {
|
||||
setCommandWindow(commandWindow: Window): void;
|
||||
|
||||
/**
|
||||
* Returns the layout used to format the output for commands typed into the command line. The default value is a
|
||||
* Returns the layout used to format the output for commands typed into the command line. The default value is a
|
||||
* PatternLayout with pattern string %m
|
||||
*/
|
||||
getCommandLayout(): Layout;
|
||||
@@ -858,7 +858,7 @@ declare module log4javascript {
|
||||
evalCommandAndAppend(expr: string): void;
|
||||
|
||||
/**
|
||||
* Adds a function with the name specified to the list of functions available on the command line. This feature may be used
|
||||
* Adds a function with the name specified to the list of functions available on the command line. This feature may be used
|
||||
* to add custom functions to the command line.
|
||||
*/
|
||||
addCommandLineFunction(functionName: string,
|
||||
@@ -866,7 +866,7 @@ declare module log4javascript {
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes log messages to the browser's built-in console, if present. This only works currently in Safari, Opera and Firefox
|
||||
* Writes log messages to the browser's built-in console, if present. This only works currently in Safari, Opera and Firefox
|
||||
* with the excellent Firebug extension installed.
|
||||
*/
|
||||
export class BrowserConsoleAppender extends Appender {
|
||||
@@ -900,7 +900,7 @@ declare module log4javascript {
|
||||
getContentType(): string;
|
||||
|
||||
/**
|
||||
* Returns whether the layout's output is suitable for batching. JsonLayout and XmlLayout are the only built-in layouts that
|
||||
* Returns whether the layout's output is suitable for batching. JsonLayout and XmlLayout are the only built-in layouts that
|
||||
* return true for this method.
|
||||
*/
|
||||
allowBatching(): boolean;
|
||||
@@ -911,7 +911,7 @@ declare module log4javascript {
|
||||
getDataValues(loggingEvent: LoggingEvent): Array<any>;
|
||||
|
||||
/**
|
||||
* This method is used to change the default keys used to create formatted name-value pairs for the properties of a log
|
||||
* This method is used to change the default keys used to create formatted name-value pairs for the properties of a log
|
||||
* message, for layouts that do this. These layouts are JsonLayout and HttpPostDataLayout.
|
||||
* @param loggerKey Parameter to use for the log message's logger name. Default is logger.
|
||||
* @param timeStampKey Parameter to use for the log message's timestamp. Default is timestamp.
|
||||
@@ -923,8 +923,8 @@ declare module log4javascript {
|
||||
setKeys(loggerKey: string, timeStampKey: string, levelKey: string, messageKey: string, exceptionKey: string, urlKey: string): void;
|
||||
|
||||
/**
|
||||
* Some layouts (JsonLayout, HttpPostDataLayout, PatternLayout and XmlLayout) allow you to set custom fields (e.g. a session
|
||||
* id to send to the server) to the formatted output. Use this method to set a custom field. If there is already a custom
|
||||
* Some layouts (JsonLayout, HttpPostDataLayout, PatternLayout and XmlLayout) allow you to set custom fields (e.g. a session
|
||||
* id to send to the server) to the formatted output. Use this method to set a custom field. If there is already a custom
|
||||
* field with the specified name, its value will be updated with value.
|
||||
* @param name Name of the custom property you wish to be included in the formmtted output.
|
||||
* @param value Value of the custom property you wish to be included in the formatted output.
|
||||
@@ -950,7 +950,7 @@ declare module log4javascript {
|
||||
}
|
||||
|
||||
/**
|
||||
* Provides basic formatting. SimpleLayout consists of the level of the log statement, followed by " - " and then the log message
|
||||
* Provides basic formatting. SimpleLayout consists of the level of the log statement, followed by " - " and then the log message
|
||||
* itself. For example, "DEBUG - Hello world".
|
||||
*/
|
||||
export class SimpleLayout extends Layout {
|
||||
@@ -961,13 +961,13 @@ declare module log4javascript {
|
||||
}
|
||||
|
||||
/**
|
||||
* Provides a flexible way of formatting a log message by means of a conversion pattern string. The behaviour of this layout is a
|
||||
* full implementation of PatternLayout in log4j, with the exception of the set of conversion characters - log4javascript's is
|
||||
* necessarily a subset of that of log4j with a few additions of its own, since many of the conversion characters in log4j only
|
||||
* Provides a flexible way of formatting a log message by means of a conversion pattern string. The behaviour of this layout is a
|
||||
* full implementation of PatternLayout in log4j, with the exception of the set of conversion characters - log4javascript's is
|
||||
* necessarily a subset of that of log4j with a few additions of its own, since many of the conversion characters in log4j only
|
||||
* make sense in the context of Java.
|
||||
* The conversion pattern consists of literal text interspersed with special strings starting with a % symbol called conversion
|
||||
* specifiers. A conversion specifier consists of the % symbol, a conversion character (possible characters are listed below) and
|
||||
* format modifiers. For full documentation of the conversion pattern, see log4j's documentation.
|
||||
* The conversion pattern consists of literal text interspersed with special strings starting with a % symbol called conversion
|
||||
* specifiers. A conversion specifier consists of the % symbol, a conversion character (possible characters are listed below) and
|
||||
* format modifiers. For full documentation of the conversion pattern, see log4j's documentation.
|
||||
*/
|
||||
export class PatternLayout extends Layout {
|
||||
/**
|
||||
@@ -1003,28 +1003,28 @@ declare module log4javascript {
|
||||
}
|
||||
|
||||
/**
|
||||
* Based on log4j's XmlLayout, this layout formats a log message as a fragment of XML.
|
||||
* Based on log4j's XmlLayout, this layout formats a log message as a fragment of XML.
|
||||
*/
|
||||
export class XmlLayout extends Layout {
|
||||
/**
|
||||
* Constructor
|
||||
* @param combineMessages Whether or not to format multiple log messages as a combined single <log4javascript:message>
|
||||
* element composed of each individual message separated by line breaks or to include a <log4javascript:message> element for
|
||||
* @param combineMessages Whether or not to format multiple log messages as a combined single <log4javascript:message>
|
||||
* element composed of each individual message separated by line breaks or to include a <log4javascript:message> element for
|
||||
* each message inside one <log4javascript:messages> element. If not specified, defaults to true.
|
||||
*/
|
||||
constructor(combineMessages?: boolean);
|
||||
}
|
||||
|
||||
/**
|
||||
* Formats a logging event into JavaScript Object Notation (JSON). JSON is a subset of JavaScript's object literal syntax,
|
||||
* meaning that log messages formatted with this layout can be interpreted directly by JavaScript and converted into objects.
|
||||
* Formats a logging event into JavaScript Object Notation (JSON). JSON is a subset of JavaScript's object literal syntax,
|
||||
* meaning that log messages formatted with this layout can be interpreted directly by JavaScript and converted into objects.
|
||||
* See json.org for more details about JSON.
|
||||
*/
|
||||
export class JsonLayout extends Layout {
|
||||
/**
|
||||
* Constructor
|
||||
* @param readable Whether or not to format each log message with line breaks and tabs. If not specified, defaults to false.
|
||||
* @param combineMessages Whether or not to format multiple log messages as a combined single message property composed of
|
||||
* @param combineMessages Whether or not to format multiple log messages as a combined single message property composed of
|
||||
* each individual message separated by line breaks or to format multiple messages as an array. If not specified, defaults to true.
|
||||
*/
|
||||
constructor(readable?: boolean, combineMessages?: boolean);
|
||||
@@ -1036,7 +1036,7 @@ declare module log4javascript {
|
||||
}
|
||||
|
||||
/**
|
||||
* Formats the log message as a simple URL-encoded string from which a simple server-side script may extract parameters such as
|
||||
* Formats the log message as a simple URL-encoded string from which a simple server-side script may extract parameters such as
|
||||
* the log message, severity and timestamp. This is the default layout for AjaxAppender.
|
||||
*/
|
||||
export class HttpPostDataLayout extends Layout {
|
||||
@@ -1054,17 +1054,17 @@ declare module log4javascript {
|
||||
* log4javascript has a single rudimentary logger-like object of its own to handle messages generated by log4javascript itself.
|
||||
* This logger is called logLog and is accessed via log4javascript.logLog.
|
||||
*/
|
||||
export namespace logLog {
|
||||
export namespace logLog {
|
||||
|
||||
/**
|
||||
* Sets whether logLog is in quiet mode or not. In quiet mode, no messages sent to logLog have any visible effect. By default,
|
||||
* Sets whether logLog is in quiet mode or not. In quiet mode, no messages sent to logLog have any visible effect. By default,
|
||||
* quiet mode is switched off.
|
||||
* @param quietMode Whether to turn quiet mode on or off.
|
||||
*/
|
||||
export function setQuietMode(quietMode: boolean): void;
|
||||
|
||||
/**
|
||||
* Sets how many errors logLog will display alerts for. By default, only the first error encountered generates an alert to the
|
||||
* Sets how many errors logLog will display alerts for. By default, only the first error encountered generates an alert to the
|
||||
* user. If you turn all errors on by supplying true to this method then all errors will generate alerts.
|
||||
* @param showAllErrors Whether to show all errors or just the first.
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user