log

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

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.

Methods

static createLogger(name) → {Object}

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

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

 mylogger('foo');
 // > VIDEOJS: player: foo
Parameters:
Name Type Description
name string

The name to add call the new logger

Returns:
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:
Name Type Attributes Description
args * <repeatable>

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

static error(…args)

Logs error messages. Similar to console.error.

Parameters:
Name Type Attributes Description
args * <repeatable>

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

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.

Returns:
Array

static history.clear()

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

static history.disable()

Disable history tracking if it is currently enabled.

static history.enable()

Enable history tracking if it is currently disabled.

static history.filter(fname) → {Array}

Allows you to filter the history by the given logger name

Parameters:
Name Type Description
fname string

The name to filter by

Returns:
Array -

The filtered list to return

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:
Name Type Attributes Description
lvl string <optional>

Pass a valid level to set a new logging level.

Returns:
string -

The current logging level.

static warn(…args)

Logs warning messages. Similar to console.warn.

Parameters:
Name Type Attributes Description
args * <repeatable>

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