console.md

ZJS API for Console

• Introduction
• Web IDL
• Class: Console
  • console.assert(value, [message])
  • console.error([data])
  • console.warn([data])
  • console.log([data])
  • console.info([data])
  • console.time(label)
  • console.timeEnd(label)
• Sample Apps

Introduction

ZJS provides console APIs which match Node.js' Console module. We describe them here as there could be minor differences.

Note that the console APIs do not support format specifiers (e.g., %d, %f etc.).

Web IDL

This IDL provides an overview of the interface; see below for documentation of specific API functions. We have a short document explaining ZJS WebIDL conventions.

Click to show WebIDL

// require returns a Console object
// var console = require('console');
[ReturnFromRequire]
interface Console {
    void assert(boolean value, optional string message);
    void error(optional string data);
    void warn(optional string data);
    void log(optional string data);
    void info(optional string data);
    void time(string label);
    void timeEnd(string label);
};

Console API

console.assert(value, [message])

• value boolean
• message string Optional message to print.

Assert/throw an error if value is false.

console.error([data])

• data string Optional message to print.

Prints data to stderr with newline. (On Zephyr this will just print to stdout).

console.warn([data])

• data string Optional message to print.

Alias for console.error()

console.log([data])

• data string Optional message to print.

Prints data to stdout with newline.

console.info([data])

• data string Optional message to print.

Alias for console.log().

console.time(label)

• label string This string is used to reference the timer when calling console.timeEnd().

Starts a timer used to compute the duration of an operation.

console.timeEnd(label)

• label string The label identifying the timer started with console.time().

Stops a timer previously started with console.time() and prints the resulting time difference to stdout.

Sample Apps

• Console sample