Utilització del mòdul

Mòdul d’eines comú

Objecte

LruCache

Objecte de memòria cau LRU (utilitzat menys recentment), vegeu LruCache Objecte.

1LruCache util.LruCache;

Funció estàtica

format

Variables de format segons el format especificat

1
2
static String util.format(String fmt,
    ...args);

Paràmetres de trucada:

fmt: Cadena, format de cadena
args: ..., llista de paràmetres opcionals

Resultat de retorn:

String, Retorna la cadena formatada

Variables de format

1
static String util.format(...args);

Paràmetres de trucada:

args: ..., llista de paràmetres opcionals

Resultat de retorn:

String, Retorna la cadena formatada

inherits

Hereta la funció prototip d'un constructor a un altre. El prototip del constructor s’establirà en un nou objecte creat a partir del superConstructor.

1
2
static util.inherits(Value constructor,
    Value superConstructor);

Paràmetres de trucada:

constructor: Valor, el constructor inicial
superConstructor: Valor, la superclasse que s’hereta

inspect

La funció retorna la representació de cadena d’obj, que s’utilitza principalment per a la depuració. Es poden utilitzar opcions addicionals per canviar certs aspectes de la cadena de format.

1
2
static String util.inspect(Value obj,
    Object options = {});

Paràmetres de trucada:

obj: Valor, especifiqueu l'objecte a processar
options: Objecte, especifiqueu les opcions de control de format

Resultat de retorn:

String, Retorna la cadena formatada

S'admeten els paràmetres següents:

1
2
3
4
5
6{
    "colors": false, // 指定是否输出 ansi 作色字符串，缺省为 false
    "table": false, // 指定输出 table 格式，缺省为 false
    "encode_string": true, // 指定表格中的字符串是否编码，缺省为 true
    "fields": [], // 当 table 为 true 时指定显示字段
}

deprecate

Encapsuleu la funció donada, aquesta funció només és compatible i no emet cap avís

1
2
3
static Function util.deprecate(Function fn,
    String msg,
    String code = "");

Paràmetres de trucada:

fn: Funció, donada la funció a encapsular
msg: Cadena, amb un missatge d'advertència
code: Cadena, amb el número d'advertència

Resultat de retorn:

Function, Si resulta l'encapsulació

isEmpty

Comproveu si la variable donada no conté cap valor (no hi ha atributs enumerables)

1
static Boolean util.isEmpty(Value v);

Paràmetres de trucada:

v: Valor, donada la variable que es vol provar

Resultat de retorn:

Boolean, Retorna True si està buit

isArray

Comproveu si la variable donada és una matriu

1
static Boolean util.isArray(Value v);

Paràmetres de trucada:

v: Valor, donada la variable que es vol provar

Resultat de retorn:

Boolean, Retorna True si és una matriu

isBoolean

Comproveu si la variable donada és booleana

1
static Boolean util.isBoolean(Value v);

Paràmetres de trucada:

v: Valor, donada la variable que es vol provar

Resultat de retorn:

Boolean, Retorna True si és booleà

isNull

Comproveu si la variable indicada és nul·la

1
static Boolean util.isNull(Value v);

Paràmetres de trucada:

v: Valor, donada la variable que es vol provar

Resultat de retorn:

Boolean, Retorna True si és nul

isNullOrUndefined

Comproveu si la variable indicada és nul·la o sense definir

1
static Boolean util.isNullOrUndefined(Value v);

Paràmetres de trucada:

v: Valor, donada la variable que es vol provar

Resultat de retorn:

Boolean, Retorna True si és nul o no definit

isNumber

Comproveu si la variable donada és un número

1
static Boolean util.isNumber(Value v);

Paràmetres de trucada:

v: Valor, donada la variable que es vol provar

Resultat de retorn:

Boolean, Retorna True si és un número

isBigInt

Comproveu si la variable donada és BigInt

1
static Boolean util.isBigInt(Value v);

Paràmetres de trucada:

v: Valor, donada la variable que es vol provar

Resultat de retorn:

Boolean, Retorna True si és un número

isString

Comproveu si la variable donada és una cadena

1
static Boolean util.isString(Value v);

Paràmetres de trucada:

v: Valor, donada la variable que es vol provar

Resultat de retorn:

Boolean, Retorna True si és una cadena

isUndefined

Comproveu si la variable donada és Sense definir

1
static Boolean util.isUndefined(Value v);

Paràmetres de trucada:

v: Valor, donada la variable que es vol provar

Resultat de retorn:

Boolean, Retorna True si no està definit

isRegExp

Comproveu si la variable donada és un objecte normal

1
static Boolean util.isRegExp(Value v);

Paràmetres de trucada:

v: Valor, donada la variable que es vol provar

Resultat de retorn:

Boolean, Retorna True si és un objecte normal

isObject

Comproveu si la variable donada és un objecte

1
static Boolean util.isObject(Value v);

Paràmetres de trucada:

v: Valor, donada la variable que es vol provar

Resultat de retorn:

Boolean, Retorna True si és un objecte

isDate

Comproveu si la variable donada és un objecte de data

1
static Boolean util.isDate(Value v);

Paràmetres de trucada:

v: Valor, donada la variable que es vol provar

Resultat de retorn:

Boolean, Retorna True si és un objecte de data

isNativeError

Comproveu si la variable donada és un objecte incorrecte

1
static Boolean util.isNativeError(Value v);

Paràmetres de trucada:

v: Valor, donada la variable que es vol provar

Resultat de retorn:

Boolean, Retorna True si és un objecte d'error

isPrimitive

Comproveu si la variable donada és de tipus primitiu

1
static Boolean util.isPrimitive(Value v);

Paràmetres de trucada:

v: Valor, donada la variable que es vol provar

Resultat de retorn:

Boolean, Retorna True si és un tipus primitiu

isSymbol

Comproveu si la variable donada és del tipus Símbol

1
static Boolean util.isSymbol(Value v);

Paràmetres de trucada:

v: Valor, donada la variable que es vol provar

Resultat de retorn:

Boolean, Si és un tipus de símbol, torna True

isDataView

Comproveu si la variable donada és del tipus DataView

1
static Boolean util.isDataView(Value v);

Paràmetres de trucada:

v: Valor, donada la variable que es vol provar

Resultat de retorn:

Boolean, Retorna True si és del tipus DataView

isExternal

Comproveu si la variable donada és de tipus Extern

1
static Boolean util.isExternal(Value v);

Paràmetres de trucada:

v: Valor, donada la variable que es vol provar

Resultat de retorn:

Boolean, Si és un tipus extern, torna True

isMap

Comproveu si la variable indicada és del tipus Mapa

1
static Boolean util.isMap(Value v);

Paràmetres de trucada:

v: Valor, donada la variable que es vol provar

Resultat de retorn:

Boolean, Retorna True si és un tipus de mapa

isMapIterator

Comproveu si la variable indicada és del tipus MapIterator

1
static Boolean util.isMapIterator(Value v);

Paràmetres de trucada:

v: Valor, donada la variable que es vol provar

Resultat de retorn:

Boolean, Retorna True si és del tipus MapIterator

isPromise

Comproveu si la variable indicada és de tipus Promesa

1
static Boolean util.isPromise(Value v);

Paràmetres de trucada:

v: Valor, donada la variable que es vol provar

Resultat de retorn:

Boolean, Retorna True si és un tipus Promise

isAsyncFunction

Comproveu si la variable donada és del tipus AsyncFunction

1
static Boolean util.isAsyncFunction(Value v);

Paràmetres de trucada:

v: Valor, donada la variable que es vol provar

Resultat de retorn:

Boolean, Retorna True si és del tipus AsyncFunction

isSet

Comproveu si la variable donada és del tipus Set

1
static Boolean util.isSet(Value v);

Paràmetres de trucada:

v: Valor, donada la variable que es vol provar

Resultat de retorn:

Boolean, Si és un tipus de conjunt, torna True

isSetIterator

Comproveu si la variable donada és del tipus SetIterator

1
static Boolean util.isSetIterator(Value v);

Paràmetres de trucada:

v: Valor, donada la variable que es vol provar

Resultat de retorn:

Boolean, Retorna True si és del tipus SetIterator

isTypedArray

Comproveu si la variable donada és de tipus TypedArray

1
static Boolean util.isTypedArray(Value v);

Paràmetres de trucada:

v: Valor, donada la variable que es vol provar

Resultat de retorn:

Boolean, Si és un tipus TypedArray, torna True

isUint8Array

Comproveu si la variable donada és del tipus Uint8Array

1
static Boolean util.isUint8Array(Value v);

Paràmetres de trucada:

v: Valor, donada la variable que es vol provar

Resultat de retorn:

Boolean, Retorna True si és del tipus Uint8Array

isFunction

Comproveu si la variable donada és un objecte de funció

1
static Boolean util.isFunction(Value v);

Paràmetres de trucada:

v: Valor, donada la variable que es vol provar

Resultat de retorn:

Boolean, Retorna True si és un objecte de funció

isBuffer

Comproveu si la variable donada és una funció Buffer Objecte

1
static Boolean util.isBuffer(Value v);

Paràmetres de trucada:

v: Valor, donada la variable que es vol provar

Resultat de retorn:

Boolean, Si és una funció Buffer L’objecte torna True

isDeepEqual

La profunditat del valor de prova és igual al valor esperat

1
2
static Boolean util.isDeepEqual(Value actual,
    Value expected);

Paràmetres de trucada:

actual: Valor, el valor a provar
expected: Valor, valor esperat

Resultat de retorn:

Boolean, Retorna True si les profunditats són iguals

has

Consulteu si l'objecte especificat conté la clau donada

1
2
static Boolean util.has(Value v,
    String key);

Paràmetres de trucada:

v: Valor, donat l'objecte a consultar
key: Cadena, especifiqueu la clau que voleu consultar

Resultat de retorn:

Boolean, Retorna una matriu de totes les claus de l'objecte

keys

Consulteu totes les matrius de claus de l'objecte especificat

1
static Array util.keys(Value v);

Paràmetres de trucada:

v: Valor, donat l'objecte a consultar

Resultat de retorn:

Array, Retorna una matriu de totes les claus de l'objecte

values

Consulteu la matriu de tots els valors de l'objecte especificat

1
static Array util.values(Value v);

Paràmetres de trucada:

v: Valor, donat l'objecte a consultar

Resultat de retorn:

Array, Retorna una matriu de tots els valors de l'objecte

clone

Cloneu la variable donada, si és un objecte o una matriu, copieu el contingut al nou objecte

1
static Value util.clone(Value v);

Paràmetres de trucada:

v: Valor, donada la variable a clonar

Resultat de retorn:

Value, Retorna el resultat clonat

deepFreeze

No es podrà modificar la congelació d’un objecte, l’objecte congelat i els objectes continguts

1
static util.deepFreeze(Value v);

Paràmetres de trucada:

v: Valor, especifiqueu l'objecte a congelar

extend

Amplieu el valor clau d’un o més objectes a l’objecte especificat

1
2
static Value util.extend(Value v,
    ...objs);

Paràmetres de trucada:

v: Valor, especifiqueu l'objecte que voleu ampliar
objs: ..., especifiqueu un o més objectes per ampliar

Resultat de retorn:

Value, Retorna el resultat ampliat

_extend

Amplieu el valor clau d’un o més objectes a l’objecte especificat, que és un àlies d’extensió

1
2
static Value util._extend(Value v,
    ...objs);

Paràmetres de trucada:

v: Valor, especifiqueu l'objecte que voleu ampliar
objs: ..., especifiqueu un o més objectes per ampliar

Resultat de retorn:

Value, Retorna el resultat ampliat

pick

Torna aobjectCopieu, només filtreu el valor de l'atribut de la clau especificada

1
2
static Object util.pick(Value v,
    ...objs);

Paràmetres de trucada:

v: Valor, especifiqueu l'objecte que voleu filtrar
objs: ..., especifiqueu una o més tecles per a la selecció

Resultat de retorn:

Object, Retorna el resultat filtrat

omit

Torna aobjectCopieu, només heu d'excloure el valor de l'atribut de la clau especificada

1
2
static Object util.omit(Value v,
    ...keys);

Paràmetres de trucada:

v: Valor, especifiqueu l'objecte que voleu filtrar
keys: ..., especifiqueu una o més claus per excloure

Resultat de retorn:

Object, Retorna els resultats exclosos

first

Obteniu el primer element de la matriu

1
static Value util.first(Value v);

Paràmetres de trucada:

v: Valor, donada la matriu que es vol obtenir

Resultat de retorn:

Value, Retorna l'element recuperat

Obteniu els primers elements múltiples de la matriu

1
2
static Value util.first(Value v,
    Integer n);

Paràmetres de trucada:

v: Valor, donada la matriu que es vol obtenir
n: Enter, especifiqueu el nombre d’elements que s’han d’obtenir

Resultat de retorn:

Value, Retorna la matriu d'elements obtinguda

last

Obteniu el primer element de la matriu

1
static Value util.last(Value v);

Paràmetres de trucada:

v: Valor, donada la matriu que es vol obtenir

Resultat de retorn:

Value, Retorna l'element recuperat

Obteniu diversos elements al final de la matriu

1
2
static Value util.last(Value v,
    Integer n);

Paràmetres de trucada:

v: Valor, donada la matriu que es vol obtenir
n: Enter, especifiqueu el nombre d’elements que s’han d’obtenir

Resultat de retorn:

Value, Retorna la matriu d'elements obtinguda

unique

Obteniu una còpia dels elements de la matriu després de la duplicació

1
2
static Array util.unique(Value v,
    Boolean sorted = false);

Paràmetres de trucada:

v: Valor, donat el quadre que es deduplicarà
sorted: Booleà, especifiqueu si la matriu està ordenada o no, si s’especifica que la matriu s’ordenarà, s’utilitzarà un algorisme ràpid

Resultat de retorn:

Array, Torneu la matriu després de la desduplicació

union

Combineu els valors d'una o més matrius en una matriu amb valors únics

1
static Array util.union(...arrs);

Paràmetres de trucada:

arrs: ..., especifiqueu una o més matrius per combinar

Resultat de retorn:

Array, Retorna el resultat combinat

intersection

Retorna la intersecció d'una matriu que conté arr i que exclou un o més elements de matriu

1
static Array util.intersection(...arrs);

Paràmetres de trucada:

arrs: ..., especifiqueu una o més matrius per calcular la intersecció

Resultat de retorn:

Array, Retorna el resultat de calcular la intersecció

flatten

Convertiu una matriu amb diversos nivells de nidificació (la nidificació pot ser qualsevol nombre de nivells) en una matriu amb un sol nivell. Si passeu el paràmetre poc profund, la matriu només reduirà la nidificació unidimensional.

1
2
static Array util.flatten(Value arr,
    Boolean shallow = false);

Paràmetres de trucada:

arr: Valor, especifiqueu la matriu que voleu convertir
shallow: Booleà, especifiqueu si voleu reduir només l’anidament unidimensional, el valor per defecte és fals

Resultat de retorn:

Array, Torneu el resultat de la conversió

without

Retorna una matriu que conté un o més elements exclosos de la matriu arr

1
2
static Array util.without(Value arr,
    ...els);

Paràmetres de trucada:

arr: Valor, especifiqueu la matriu a excloure
els: ..., especifiqueu un o més elements per excloure

Resultat de retorn:

Array, Retorna els resultats exclosos

difference

Retorna una matriu que conté la matriu arr i exclou l'element sense matriu

1
2
static Array util.difference(Array list,
    ...arrs);

Paràmetres de trucada:

list: Matriu, especifiqueu la matriu que voleu excloure
arrs: ..., especifiqueu una o més matrius per excloure

Resultat de retorn:

Array, Retorna els resultats exclosos

each

Travesseu tots els elements de la llista i publiqueu-los en ordre amb el recorregut. Si es passa el paràmetre context, l'iterador està lligat a l'objecte context. Cada trucada a l'iterador passarà tres paràmetres: (element, índex, llista)

1
2
3
static Value util.each(Value list,
    Function iterator,
    Value context = undefined);

Paràmetres de trucada:

list: Valor, especifiqueu la llista o l'objecte que voleu recórrer
iterator: Funció, especifiqueu la funció de devolució de trucada utilitzada per a la travessia
context: Valor, especifiqueu l'objecte de context lligat en trucar a l'iterador

Resultat de retorn:

Value, Torneu la llista

map

Mitjançant la funció de transformació (iterador), cada valor de la llista s’assigna a una nova matriu. Si es passa el paràmetre context, l'iterador està lligat a l'objecte context. Cada trucada a l'iterador passarà tres paràmetres: (element, índex, llista)

1
2
3
static Array util.map(Value list,
    Function iterator,
    Value context = undefined);

Paràmetres de trucada:

list: Valor, especifiqueu la llista o l'objecte que voleu transformar
iterator: Funció, especifiqueu la funció de devolució de trucada utilitzada per a la transformació
context: Valor, especifiqueu l'objecte de context lligat en trucar a l'iterador

Resultat de retorn:

Array, Retorna el resultat de la transformació

reduce

Reduïu els elements de la llista a un valor únic. Si es passa el paràmetre context, l'iterador està lligat a l'objecte context. Cada trucada a l'iterador passarà tres paràmetres: (nota, element, índex, llista)

1
2
3
4
static Value util.reduce(Value list,
    Function iterator,
    Value memo,
    Value context = undefined);

Paràmetres de trucada:

list: Valor, especifiqueu la llista o l'objecte que s'ha de resoldre
iterator: Funció, especifiqueu la funció de devolució de trucada utilitzada per a la resolució
memo: Valor, especifiqueu el valor inicial de la resolució
context: Valor, especifiqueu l'objecte de context lligat en trucar a l'iterador

Resultat de retorn:

Value, Retorna el resultat de la resolució

parseArgs

Analitzeu la cadena de línia d'ordres i torneu la llista de paràmetres

1
static NArray util.parseArgs(String command);

Paràmetres de trucada:

command: Cadena, especifiqueu la cadena de línia d'ordres a analitzar

Resultat de retorn:

NArray, Retorna la llista de paràmetres analitzats

compile

Compileu l'script com a codi binari

1
2
3
static Buffer util.compile(String srcname,
    String script,
    Integer mode = 0);

Paràmetres de trucada:

srcname: Cadena, especifiqueu el nom de l'script que voleu afegir
script: Cadena, especifiqueu el codi de seqüència d'ordres que voleu compilar
mode: Enter, mode de compilació, 0: mòdul, 1: script, 2: treballador, el valor per defecte és 0

Resultat de retorn:

Buffer, Retorna el codi binari compilat

util.compileL'escriptura es pot compilar en un bloc de dades en execució intern v8 (codi d'execució que no és màquina). Després de guardar el codi compilat com a * .jsc, es pot carregar i executar directament per executar-lo i requerir-lo.

Després de la compilació, el codi de destinació no podrà obtenir el codi font al revés i el programa que depèn de Function.toString no s’executarà normalment.

sync

Ajusteu la funció de devolució de trucada o asincronització com una trucada síncrona

1
2
static Function util.sync(Function func,
    Boolean async_func = false);

Paràmetres de trucada:

func: Funció, donada la funció que cal embolicar
async_func: Booleà, especifiqueu el processament de funcions com a funció asíncron, si és falsa, es jutjarà automàticament

Resultat de retorn:

Function, Retorna la funció que s'executa de forma síncrona

util.sync Tracteu la funció de devolució de trucada o la funció asincronitzada com una funció de sincronització per facilitar la trucada.

L'exemple de devolució de trucada és el següent:

1
2
3
4
5
6
7
8
9
10
11
// callback
var util = require('util');

function cb_test(a, b, cb) {
    setTimeout(() => {
        cb(null, a + b);
    }, 100);
}

var fn_sync = util.sync(cb_test);
console.log(fn_sync(100, 200));

L'exemple asíncron és el següent:

1
2
3
4
5
6
7
8
9
// async/await
var util = require('util');

async function async_test(a, b) {
    return a + b;
}

var fn_sync = util.sync(async_test);
console.log(fn_sync(100, 200));

Per a les funcions que retornen promeses que no estan marcades com a asíncrones, podeu especificar manualment el mode de sincronització:

1
2
3
4
5
6
7
8
9
10
11
// async/await
var util = require('util');

function async_test(a, b) {
    return new Promise(function(resolve, reject) {
        resolve(a + b);
    });
}

var fn_sync = util.sync(async_test, true);
console.log(fn_sync(100, 200));

promisify

Configureu la funció de devolució de trucada com a trucada asincronitzada

1
static Function util.promisify(Function func);

Paràmetres de trucada:

func: Funció, donada la funció que cal embolicar

Resultat de retorn:

Function, Retorna la funció asíncron

util.promisify Tracteu la funció de devolució de trucada com una funció asincronitzada per facilitar la trucada.

L'exemple de devolució de trucada és el següent:

1
2
3
4
5
6
7
8
9
10
11
// callback
var util = require('util');

function cb_test(a, b, cb) {
    setTimeout(() => {
        cb(null, a + b);
    }, 100);
}

var fn_sync = util.promisify(cb_test);
console.log(async fn_sync(100, 200));

callbackify

Ajusteu la funció asincronitzada com a trucada de devolució de trucada

1
static Function util.callbackify(Function func);

Paràmetres de trucada:

func: Funció, donada la funció que cal embolicar

Resultat de retorn:

Function, Retorna la funció de devolució de trucada

util.callbackify Tracteu la funció asincronitzada com una funció de devolució de trucada per facilitar la trucada.

L'exemple asíncron és el següent:

1
2
3
4
5
6
7
8
9
10
11
12
// async
var util = require('util');

async function async_test(a, b) {
    return a + b;
}

var fn_callback = util.callbackify(async_test);

fn_callback(100, 200, (err, result) => {
    console.log(result);
});

buildInfo

Consulteu la informació actual sobre la versió del motor i dels components

1
static Object util.buildInfo();

Resultat de retorn:

Object, Retorna l'objecte de la versió del component

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24{
    "fibjs": "0.25.0",
    "clang": "9.1",
    "date": "Jun 12 2018 07:22:40",
    "vender": {
        "ev": "4.24",
        "expat": "2.2.5",
        "gd": "2.2.4",
        "jpeg": "8.3",
        "leveldb": "1.17",
        "mongo": "0.7",
        "pcre": "8.21",
        "png": "1.5.4",
        "mbedtls": "2.6.1",
        "snappy": "1.1.2",
        "sqlite": "3.23.0",
        "tiff": "3.9.5",
        "uuid": "1.6.2",
        "v8": "6.7.288.20",
        "v8-snapshot": true,
        "zlib": "1.2.7",
        "zmq": "3.1"
    }
}

Guia de desenvolupament

Mòdul bàsic

Objectes incorporats

Mòdul de comunitat

Utilització del mòdul

Objecte

LruCache

Funció estàtica

format

inherits

inspect

deprecate

isEmpty

isArray

isBoolean

isNull

isNullOrUndefined

isNumber

isBigInt

isString

isUndefined

isRegExp

isObject

isDate

isNativeError

isPrimitive

isSymbol

isDataView

isExternal

isMap

isMapIterator

isPromise

isAsyncFunction

isSet

isSetIterator

isTypedArray

isUint8Array

isFunction

isBuffer

isDeepEqual

has

keys

values

clone

deepFreeze

extend

_extend

pick

omit

first

last

unique

union

intersection

flatten

without

difference

each

map

reduce

parseArgs

compile

sync

promisify

callbackify

buildInfo