您好,登錄后才能下訂單哦!
這篇文章主要講解了如何使用Node.js API中的util模塊,內(nèi)容清晰明了,對(duì)此有興趣的小伙伴可以學(xué)習(xí)一下,相信大家閱讀完之后會(huì)有幫助。
Node.js API詳解之 util
util 模塊主要用于支持 Node.js 內(nèi)部 API 的需求。提供了大部分實(shí)用工具。
通過 const util = require(‘util'); 的方式引用util模塊
說明:
original:傳遞一個(gè) async 函數(shù),或者是一個(gè)返回Promise的異步函數(shù)。
callbackify會(huì)返回一個(gè)方法,執(zhí)行該方法時(shí)傳遞一個(gè)回調(diào)函數(shù),回調(diào)函數(shù)的第一個(gè)參數(shù)是err,第二個(gè)是異步函數(shù)的返回值。
demo:
const util = require('util'); async function fn() { return await Promise.resolve('hello isjs'); } const callbackFunction = util.callbackify(fn); callbackFunction((err, ret) => { if (err) throw err; console.log(ret); }); //輸出: hello isjs
說明:
util.debuglog() 方法用于創(chuàng)建一個(gè)函數(shù),基于 NODE_DEBUG 環(huán)境變量的存在與否有條件地寫入調(diào)試信息到 stderr。
如果 section 名稱在環(huán)境變量的值中,則返回的函數(shù)類似于 console.error()。 否則,返回的函數(shù)是一個(gè)空操作。
section:一個(gè)字符串,指定要為應(yīng)用的哪些部分創(chuàng)建 debuglog 函數(shù)。
demo:
const util = require('util'); const debuglog = util.debuglog('foo'); debuglog('hello from foo [%d]', 123);
說明:
該方法會(huì)包裝給定的 function 或類,并標(biāo)記為廢棄的。
demo:
const util = require('util'); function isBoolean(obj){ return (obj === true || obj === false); } isBoolean = util.deprecate(isBoolean, 'isBoolean 方法已被廢棄'); isBoolean(true); //輸出:(node:9911) DeprecationWarning: isBoolean 方法已被廢棄
說明:
util.format() 方法返回一個(gè)格式化后的字符串,
format:第一個(gè)參數(shù)是一個(gè)字符串,包含零個(gè)或多個(gè)占位符。
每個(gè)占位符會(huì)被對(duì)應(yīng)參數(shù)轉(zhuǎn)換后的值所替換。 支持的占位符有:
%s:字符串
%d:數(shù)值(整數(shù)或浮點(diǎn)數(shù))
%i:整數(shù)
%f:浮點(diǎn)數(shù)
%j – JSON
%o – Object(包括不可枚舉的屬性方法)
%O – Object(不包括不可枚舉屬性)
%% – 單個(gè)百分號(hào)('%')不消耗參數(shù)。
demo:
const util = require('util'); var formatString = util.format('%s %d %i %f %j', 'hello', 1.123, 123, 2.1, "{'name': 'xiao', 'age': '18'}"); console.log(formatString); //e輸出: hello 1.123 123 2.1 "{'name': 'xiao', 'age': '18'}" //如果占位符沒有對(duì)應(yīng)的參數(shù),則占位符不被替換。 formatString = util.format('%s , %s', 'hello'); console.log(formatString); //輸出: hello , %s //如果傳入的參數(shù)比占位符的數(shù)量多,則多出的參數(shù)會(huì)被強(qiáng)制轉(zhuǎn)換為字符串, //然后拼接到返回的字符串,參數(shù)之間用一個(gè)空格分隔。 formatString = util.format('%s , %s', 'hello', 'isjs', '!'); console.log(formatString); //輸出: hello , isjs ! //如果第一個(gè)參數(shù)不是一個(gè)字符串,則返回一個(gè)所有參數(shù)用空格分隔并連在一起的字符串 formatString = util.format(1, 2, 3); console.log(formatString); //輸出: 1 2 3 //如果只傳入占位符而不傳入?yún)?shù),則原樣返回 formatString = util.format('%% , %s'); console.log(formatString); //輸出: %% , %s
說明:
注意,不建議使用 util.inherits()。 請(qǐng)使用 ES6 的 class 和 extends 關(guān)鍵詞獲得語言層面的繼承支持。
從一個(gè)構(gòu)造函數(shù)中繼承原型方法到另一個(gè)。
constructor 的 prototype 會(huì)被設(shè)置到一個(gè)從 superConstructor 創(chuàng)建的新對(duì)象上。
superConstructor 可通過 constructor.super_ 屬性訪問
demo:
const util = require('util'); const EventEmitter = require('events'); function MyStream() { EventEmitter.call(this); } util.inherits(MyStream, EventEmitter); MyStream.prototype.write = function(data) { this.emit('data', data); }; const stream = new MyStream(); console.log(stream instanceof EventEmitter); // true console.log(MyStream.super_ === EventEmitter); // true stream.on('data', (data) => { console.log(`接收的數(shù)據(jù):"${data}"`); }); stream.write('運(yùn)作良好!'); // 接收的數(shù)據(jù):"運(yùn)作良好!" //建議使用 ES6 的 class 和 extends: const EventEmitter = require('events'); class MyStream extends EventEmitter { write(data) { this.emit('data', data); } } const stream = new MyStream(); stream.on('data', (data) => { console.log(`接收的數(shù)據(jù):"${data}"`); }); stream.write('使用 ES6');
說明:
方法返回 object 的字符串表示,主要用于調(diào)試。
object: 任何 JavaScript 原始值或?qū)ο?br/>options: 可用于改變格式化字符串的某些方面。
demo:
const util = require('util'); const inspectOpt = { showHidden: false,//如果為 true,則 object 的不可枚舉的符號(hào)與屬性也會(huì)被包括在格式化后的結(jié)果中。 depth: 2,//指定格式化 object 時(shí)遞歸的次數(shù)。 默認(rèn)為 2。 若要無限地遞歸則傳入 null。 colors: false,//如果為 true,則輸出樣式使用 ANSI 顏色代碼。 默認(rèn)為 false。 customInspect: true,//如果為 false,則 object 上自定義的 inspect(depth, opts) 函數(shù)不會(huì)被調(diào)用。 默認(rèn)為 true showProxy: false,//如果為 true,則 Proxy 對(duì)象的對(duì)象和函數(shù)會(huì)展示它們的 target 和 handler 對(duì)象。 默認(rèn)為 false maxArrayLength: 100,//指定格式化時(shí)數(shù)組和 TypedArray 元素能包含的最大數(shù)量。 默認(rèn)為 100。 設(shè)為 null 則顯式全部數(shù)組元素。 設(shè)為 0 或負(fù)數(shù)則不顯式數(shù)組元素。 breakLength: 60//一個(gè)對(duì)象的鍵被拆分成多行的長度。 設(shè)為 Infinity 則格式化一個(gè)對(duì)象為單行。 默認(rèn)為 60。 }; console.log(util.inspect(util, inspectOpt));
說明:
可以通過 util.inspect.styles 和 util.inspect.colors 屬性全局地自定義 util.inspect 的顏色輸出(如果已啟用)。
預(yù)定義的顏色代碼有:white、grey、black、blue、cyan、green、magenta、red 和 yellow。
還有 bold、italic、underline 和 inverse 代碼。
顏色樣式使用 ANSI 控制碼,可能不是所有終端都支持。
demo:
const util = require('util'); console.log(util.inspect.styles); // { special: 'cyan', // number: 'yellow', // boolean: 'yellow', // undefined: 'grey', // null: 'bold', // string: 'green', // symbol: 'green', // date: 'magenta', // regexp: 'red' } console.log(util.inspect.colors); // { bold: [ 1, 22 ], // italic: [ 3, 23 ], // underline: [ 4, 24 ], // inverse: [ 7, 27 ], // white: [ 37, 39 ], // grey: [ 90, 39 ], // black: [ 30, 39 ], // blue: [ 34, 39 ], // cyan: [ 36, 39 ], // green: [ 32, 39 ], // magenta: [ 35, 39 ], // red: [ 31, 39 ], // yellow: [ 33, 39 ] }
說明:
util.inspect.custom是一個(gè)符號(hào),可被用于聲明自定義的查看函數(shù):[util.inspect.custom](depth, opts)
自定義 inspect 方法的返回值可以使任何類型的值,它會(huì)被 util.inspect() 格式化。
demo:
const util = require('util'); class Box { [util.inspect.custom](depth, options) { return "myInspect"; } } const box = new Box(); console.log(util.inspect(box)); // 輸出:myInspect
說明:
defaultOptions 值允許對(duì) util.inspect 使用的默認(rèn)選項(xiàng)進(jìn)行自定義。
它需被設(shè)為一個(gè)對(duì)象,包含一個(gè)或多個(gè)有效的 util.inspect() 選項(xiàng)。 也支持直接設(shè)置選項(xiàng)的屬性。
demo:
const util = require('util'); util.inspect.defaultOptions = { showHidden: true, depth:3 }; util.inspect.defaultOptions.breakLength = 30; console.log(util.inspect.defaultOptions); // { showHidden: true, // depth: 3, // colors: false, // customInspect: true, // showProxy: false, // maxArrayLength: 100, // breakLength: 30 }
說明:
讓一個(gè)遵循通常的 Node.js error first回調(diào)風(fēng)格的函數(shù),回調(diào)函數(shù)是最后一個(gè)參數(shù), 返回一個(gè)返回值是一個(gè) promise 版本的函數(shù)。
demo:
const util = require('util'); const fs = require('fs'); const stat = util.promisify(fs.stat); stat('.').then((stats) => { // Do something with `stats` }).catch((error) => { // Handle the error. });
說明:
使用util.promisify.custom符號(hào)可以自定義promisified功能。
demo:
const util = require('util'); function doSomething(foo, callback) { // ... } doSomething[util.promisify.custom] = function(foo) { return getPromiseSomehow(); }; const promisified = util.promisify(doSomething); console.log(promisified === doSomething[util.promisify.custom]); // 輸出: true
說明:
該類用來對(duì)文本進(jìn)行編碼
說明:
對(duì)input字符串進(jìn)行編碼并返回一個(gè)Uint8Array包含編碼字節(jié)的字符串
說明:
TextEncoder實(shí)例支持的編碼??偸窃O(shè)置為'utf-8'。
demo:
const encoder = new TextEncoder(); const uint8array = encoder.encode('this is some data'); console.log(encoder.encoding) //utf-8
說明:
該類用來解析編碼后的文本
說明:
創(chuàng)建一個(gè)TextDecoder實(shí)例。
encoding: 編碼方式,默認(rèn)'utf-8′
options: 選項(xiàng)
fatal: 解碼發(fā)生的錯(cuò)誤將導(dǎo)致 TypeError被拋出。默認(rèn)為 false
ignoreBOM: 解碼結(jié)果中是否會(huì)包含字節(jié)順序標(biāo)記。默認(rèn)為false。僅當(dāng)encoding的值為'utf-8','utf-16be'或'utf-16le'時(shí)有效。
說明:
解碼input并返回一個(gè)字符串。
input: 待解碼數(shù)據(jù)
options.stream: 如果需要額外的數(shù)據(jù)塊,設(shè)置為true。默認(rèn)為false。
說明:
返回textDecoder實(shí)例支持的編碼。
說明:
返回textDecoder實(shí)例的fatal屬性,
說明:
返回解碼結(jié)果是否包含字節(jié)順序標(biāo)記
看完上述內(nèi)容,是不是對(duì)如何使用Node.js API中的util模塊有進(jìn)一步的了解,如果還想學(xué)習(xí)更多內(nèi)容,歡迎關(guān)注億速云行業(yè)資訊頻道。
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場,如果涉及侵權(quán)請(qǐng)聯(lián)系站長郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。