log#

log(…args)#

Logs plain debug messages. Similar to console.log.

Due to limitations of our JSDoc template, we cannot properly document this as both a function and a namespace, so its function signature is documented here.

Arguments#

*args

*[]

Any combination of values that could be passed to console.log().

Return Value#

undefined

Parameters:
NameTypeAttributesDescription
args*<repeatable>

One or more messages or objects that should be logged.

Source

Members#

(static) levels :Object#

Enumeration of available logging levels, where the keys are the level names and the values are |-separated strings containing logging methods allowed in that logging level. These strings are used to create a regular expression matching the function name being called.

Levels provided by Video.js are:

  • off: Matches no calls. Any value that can be cast to false will have this effect. The most restrictive.
  • all: Matches only Video.js-provided functions (debug, log, log.warn, and log.error).
  • debug: Matches log.debug, log, log.warn, and log.error calls.
  • info (default): Matches log, log.warn, and log.error calls.
  • warn: Matches log.warn and log.error calls.
  • error: Matches only log.error calls.
Type:
  • Object
Source

Methods#

(static) createLogger(subName, subDelimiteropt, subStylesopt) → {Object}#

Create a new subLogger which chains the old name to the new name.

For example, doing mylogger = videojs.log.createLogger('player') and then using that logger will log the following:

CODE
 mylogger('foo');
 // > VIDEOJS: player: foo
Parameters:
NameTypeAttributesDescription
subNamestring

The name to add call the new logger

subDelimiterstring<optional>

Optional delimiter

subStylesstring<optional>

Optional styles

Source
Returns:
Type: 
Object

(static) createNewLogger(newName, newDelimiteropt, newStylesopt) → {Object}#

Create a new logger.

Parameters:
NameTypeAttributesDescription
newNamestring

The name for the new logger

newDelimiterstring<optional>

Optional delimiter

newStylesstring<optional>

Optional styles

Source
Returns:
Type: 
Object

(static) debug(…args)#

Logs debug messages. Similar to console.debug, but may also act as a comparable log if console.debug is not available

Parameters:
NameTypeAttributesDescription
args*<repeatable>

One or more messages or objects that should be logged as debug.

Source

(static) error(…args)#

Logs error messages. Similar to console.error.

Parameters:
NameTypeAttributesDescription
args*<repeatable>

One or more messages or objects that should be logged as an error

Source

(static) history() → {Array}#

Returns an array containing everything that has been logged to the history.

This array is a shallow clone of the internal history record. However, its contents are not cloned; so, mutating objects inside this array will mutate them in history.

Source
Returns:
Type: 
Array

(static) history.clear()#

Clears the internal history tracking, but does not prevent further history tracking.

Source

(static) history.disable()#

Disable history tracking if it is currently enabled.

Source

(static) history.enable()#

Enable history tracking if it is currently disabled.

Source

(static) history.filter(fname) → {Array}#

Allows you to filter the history by the given logger name

Parameters:
NameTypeDescription
fnamestring

The name to filter by

Source
Returns:

The filtered list to return

Type: 
Array

(static) level(lvlopt) → {string}#

Get or set the current logging level.

If a string matching a key from module:log.levels is provided, acts as a setter.

Parameters:
NameTypeAttributesDescription
lvl'all' | 'debug' | 'info' | 'warn' | 'error' | 'off'<optional>

Pass a valid level to set a new logging level.

Source
Returns:

The current logging level.

Type: 
string

(static) warn(…args)#

Logs warning messages. Similar to console.warn.

Parameters:
NameTypeAttributesDescription
args*<repeatable>

One or more messages or objects that should be logged as a warning.

Source