Módulo consola

Obxecto de acceso á consola

O módulo de consola é un módulo principal que ofrece funcións similares ao obxecto da consola no navegador. Pode enviar información á consola para facilitar a depuración e a saída de información.

O método máis usado no módulo da consola é log(), que imprime calquera valor de JavaScript na consola, engadindo automaticamente novas liñas. Ademais do método log(), tamén hai métodos info(), warn() e error(), que se usan para emitir información, avisos e erros respectivamente. As súas funcións son basicamente as mesmas que o log() método, excepto o estilo que se mostra na consola.

O módulo da consola tamén fornece o método dir(), que se usa para enviar as propiedades e métodos dun obxecto á consola dunha forma máis lexible, facilitando a depuración de obxectos complexos. Ademais, hai métodos time() e timeEnd() para sincronizar a execución do código na consola e emitir a diferenza horaria.

Ademais dos métodos de uso habitual anteriores, o módulo da consola tamén ofrece outros métodos, comoassert(), notice(), trace(), etc., poden facilitar a depuración e a saída de información en diferentes situacións.

O módulo de consola é un módulo moi práctico que pode mellorar a eficiencia da depuración durante o proceso de desenvolvemento e producir diversas informacións de forma cómoda e rápida.

función estática

add

Engade un sistema de saída de consola. Os dispositivos admitidos son a consola, o syslog e o evento. Pódense engadir ata 10 saídas.

1
static console.add(String type);

Parámetros de chamada:

type: Cadena, dispositivo de saída

Ao configurar a consola, a saída do programa e os erros do sistema pódense enviar a diferentes dispositivos para recoller información do entorno en execución.

type é a configuración e é a cadea do nome do dispositivo:

1
console.add("console");

syslog só é válido na plataforma posix:

1
console.add("syslog");

O evento só é válido na plataforma Windows:

1
console.add("event");

Engade un sistema de saída de consola. Os dispositivos compatibles son consola, syslog, evento e ficheiro. Pódense engadir ata 10 saídas.

1
static console.add(Object cfg);

Parámetros de chamada:

cfg: Obxecto, configuración de saída

Ao configurar a consola, a saída do programa e os erros do sistema pódense enviar a diferentes dispositivos para recoller información do entorno en execución.

cfg pode configurar obxectos para un dispositivo:

1
2
3
4
console.add({
    type: "console",
    levels: [console.INFO, console.ERROR] // optional, default is all levels
});

syslog só é válido na plataforma posix:

1
2
3
4
console.add({
    type: "syslog",
    levels: [console.INFO, console.ERROR]
});

O evento só é válido na plataforma Windows:

1
2
3
4
console.add({
    type: "event",
    levels: [console.INFO, console.ERROR]
});

rexistro de ficheiros:

1
2
3
4
5
6
7
console.add({
    type: "file",
    levels: [console.INFO, console.ERROR],
    path: "path/to/file_%s.log", // specifies the log output file, can use %s to specify the insertion date location, or add at the end if not specified
    split: "30m", // Optional values are "day", "hour", "minute", "####k", "####m", "####g", default is "1m"
    count: 10 // option, selectable from 2 to 128, default is 128
});

Engade sistemas de saída de consola por lotes. Os dispositivos admitidos son consola, syslog, evento e ficheiro. Pódense engadir ata 10 saídas.

1
static console.add(Array cfg);

Parámetros de chamada:

cfg: Array, matriz de configuración de saída

Ao configurar a consola, a saída do programa e os erros do sistema pódense enviar a diferentes dispositivos para recoller información do entorno en execución.

1
2
3
4
console.add(["console", {
    type: "syslog",
    levels: [console.INFO, console.ERROR]
}]);

reset

Inicialice a configuración predeterminada e só saia información á consola.

1
static console.reset();

log

Grava información de rexistro común, que é equivalente a información

1
2
static console.log(String fmt,
    ...args);

Parámetros de chamada:

fmt: String, formato cadea
args: ..., lista de parámetros opcional

Rexistra a información de rexistro de nivel xeral. Normalmente úsase para emitir información de avisos sen erros.

Grava información de rexistro común, que é equivalente a información

1
static console.log(...args);

Parámetros de chamada:

args: ..., lista de parámetros opcional

Rexistra a información de rexistro de nivel xeral. Normalmente úsase para emitir información de avisos sen erros.

debug

Gravar a información do rexistro de depuración

1
2
static console.debug(String fmt,
    ...args);

Parámetros de chamada:

fmt: String, formato cadea
args: ..., lista de parámetros opcional

Gravar a información do rexistro de depuración. Normalmente úsase para emitir información de depuración. sen importancia.

Gravar a información do rexistro de depuración

1
static console.debug(...args);

Parámetros de chamada:

args: ..., lista de parámetros opcional

Gravar a información do rexistro de depuración. Normalmente úsase para emitir información de depuración. sen importancia.

info

Grava información de rexistro común, que é equivalente a rexistro

1
2
static console.info(String fmt,
    ...args);

Parámetros de chamada:

fmt: String, formato cadea
args: ..., lista de parámetros opcional

Rexistra a información de rexistro de nivel xeral. Normalmente úsase para emitir información de avisos sen erros.

Grava información de rexistro común, que é equivalente a rexistro

1
static console.info(...args);

Parámetros de chamada:

args: ..., lista de parámetros opcional

Rexistra a información de rexistro de nivel xeral. Normalmente úsase para emitir información de avisos sen erros.

notice

Gravar a información do rexistro de avisos

1
2
static console.notice(String fmt,
    ...args);

Parámetros de chamada:

fmt: String, formato cadea
args: ..., lista de parámetros opcional

Gravar a información do rexistro de avisos. Normalmente úsase para emitir información de depuración informativa. Xeralmente importante.

Gravar a información do rexistro de avisos

1
static console.notice(...args);

Parámetros de chamada:

args: ..., lista de parámetros opcional

Gravar a información do rexistro de avisos. Normalmente úsase para emitir información de depuración informativa. Xeralmente importante.

warn

Gravar a información do rexistro de avisos

1
2
static console.warn(String fmt,
    ...args);

Parámetros de chamada:

fmt: String, formato cadea
args: ..., lista de parámetros opcional

Gravar a información do rexistro de avisos. Normalmente úsase para emitir información de depuración de avisos. importante.

Gravar a información do rexistro de avisos

1
static console.warn(...args);

Parámetros de chamada:

args: ..., lista de parámetros opcional

Gravar a información do rexistro de avisos. Normalmente úsase para emitir información de depuración de avisos. importante.

error

Gravar a información do rexistro de erros

1
2
static console.error(String fmt,
    ...args);

Parámetros de chamada:

fmt: String, formato cadea
args: ..., lista de parámetros opcional

Rexistra información para rexistros de erros. Normalmente úsase para emitir mensaxes de erro. Moi importante. As mensaxes de erro do sistema tamén se rexistrarán neste nivel.

Gravar a información do rexistro de erros

1
static console.error(...args);

Parámetros de chamada:

args: ..., lista de parámetros opcional

Rexistra información para rexistros de erros. Normalmente úsase para emitir mensaxes de erro. Moi importante. As mensaxes de erro do sistema tamén se rexistrarán neste nivel.

crit

Gravar a información do rexistro de erros da clave

1
2
static console.crit(String fmt,
    ...args);

Parámetros de chamada:

fmt: String, formato cadea
args: ..., lista de parámetros opcional

Información de rexistro de erros críticos. Normalmente úsase para emitir información sobre erros críticos. Moi importante.

Gravar a información do rexistro de erros da clave

1
static console.crit(...args);

Parámetros de chamada:

args: ..., lista de parámetros opcional

Información de rexistro de erros críticos. Normalmente úsase para emitir información sobre erros críticos. Moi importante.

alert

Gravar a información do rexistro de erros de alerta

1
2
static console.alert(String fmt,
    ...args);

Parámetros de chamada:

fmt: String, formato cadea
args: ..., lista de parámetros opcional

Grava mensaxes de rexistro de erros para alertas. Normalmente úsase para emitir mensaxes de erro de alerta. Moi importante. é o nivel máis alto de información.

Gravar a información do rexistro de erros de alerta

1
static console.alert(...args);

Parámetros de chamada:

args: ..., lista de parámetros opcional

Grava mensaxes de rexistro de erros para alertas. Normalmente úsase para emitir mensaxes de erro de alerta. Moi importante. é o nivel máis alto de información.

trace

Saír a pila de chamadas actual

1
2
static console.trace(String fmt,
    ...args);

Parámetros de chamada:

fmt: String, formato cadea
args: ..., lista de parámetros opcional

Saír a pila de chamadas actual a través do rexistro.

Saír a pila de chamadas actual

1
static console.trace(...args);

Parámetros de chamada:

args: ..., lista de parámetros opcional

Saír a pila de chamadas actual a través do rexistro.

dir

Obxectos de saída en formato JSON

1
2
static console.dir(Value obj,
    Object options = {});

Parámetros de chamada:

obj: Valor, especifica o obxecto que se vai procesar
options: Obxecto, especifique as opcións de control de formato

Admítense os seguintes parámetros:

1
2
3
4
5
6
7
8
9{
    "colors": false, // specify if output should be colorized, defaults to false
    "depth": 2, // specify the max depth of the output, defaults to 2
    "table": false, // specify if output should be a table, defaults to false
    "encode_string": true, // specify if string should be encoded, defaults to true
    "maxArrayLength": 100, // specify max number of array elements to show, set to 0 or negative to show no elements, defaults to 100
    "maxStringLength": 10000, // specify max string length to output, set to 0 or negative to show no strings, defaults to 10000
    "fields": [], // specify the fields to be displayed, defaults to all
}

table

Obxectos de saída en formato JSON

1
static console.table(Value obj);

Parámetros de chamada:

obj: Valor, dado o obxecto que se vai mostrar

Obxectos de saída en formato JSON

1
2
static console.table(Value obj,
    Array fields);

Parámetros de chamada:

obj: Valor, dado o obxecto que se vai mostrar
fields: Matriz, dados os campos que se van mostrar

time

iniciar un temporizador

1
static console.time(String label = "time");

Parámetros de chamada:

label: Cadea, título, o predeterminado é unha cadea baleira.

timeElapse

Mostra o valor de tempo actual do temporizador especificado

1
static console.timeElapse(String label = "time");

Parámetros de chamada:

label: Cadea, título, o predeterminado é unha cadea baleira.

timeEnd

Finalice o temporizador especificado e emita o último valor de tempo

1
static console.timeEnd(String label = "time");

Parámetros de chamada:

label: Cadea, título, o predeterminado é unha cadea baleira.

assert

Proba de afirmación, se o valor da proba é falso, informarase dun erro

1
2
static console.assert(Value value,
    String msg = "");

Parámetros de chamada:

value: Valor, o valor a probar
msg: Cadea, mensaxe de erro

print

Saída de texto con formato para a consola, o contido de saída non se rexistrará no sistema de rexistro, o texto non se envolverá automaticamente despois da saída e pódese emitir continuamente.

1
2
static console.print(String fmt,
    ...args);

Parámetros de chamada:

fmt: String, formato cadea
args: ..., lista de parámetros opcional

1
static console.print(...args);

Parámetros de chamada:

args: ..., lista de parámetros opcional

moveTo

Move o cursor da consola á posición especificada

1
2
static console.moveTo(Integer row,
    Integer column);

Parámetros de chamada:

row: Número enteiro, especifica a coordenada da fila do novo cursor
column: Número enteiro, especifica as coordenadas da columna do novo cursor

hideCursor

Ocultar o cursor da consola

1
static console.hideCursor();

showCursor

Mostrar o cursor da consola

1
static console.showCursor();

clear

consola clara

1
static console.clear();

readLine

Ler a entrada do usuario desde a consola

1
static String console.readLine(String msg = "") async;

Parámetros de chamada:

msg: Cadena, mensaxe de aviso

Resultados de devolución:

String, devolve a información introducida polo usuario

getpass

Le o contrasinal introducido polo usuario desde a consola

1
static String console.getpass(String msg = "") async;

Parámetros de chamada:

msg: Cadena, mensaxe de aviso

Resultados de devolución:

String, devolve o contrasinal introducido polo usuario

propiedades estáticas

loglevel

Enteiro, nivel de saída, usado para filtrar a información de saída, o valor predeterminado é NOTSET, toda a saída. Despois de filtrar a información, sairá a cada dispositivo configurado por add.

1
static Integer console.loglevel;

width

Enteiro, consulta o número de caracteres por liña do terminal

1
static readonly Integer console.width;

height

Enteiro, consulta o número de liñas de terminal

1
static readonly Integer console.height;