powerbi-client package
クラス
| AdvancedFilter | |
| BasicFilter | |
| BasicFilterWithKeys | |
| Filter | |
| HierarchyFilter | |
| HierarchyIdentityFilter | |
| IdentityFilter | |
| IncludeExcludeFilter | |
| NotSupportedFilter | |
| PageSelector | |
| RelativeDateFilter | |
| RelativeTimeFilter | |
| Selector | |
| SlicerTargetSelector | |
| TopNFilter | |
| TupleFilter | |
| VisualSelector | |
| VisualTypeSelector | |
| AdvancedFilterBuilder |
Power BI Advanced フィルター ビルダー コンポーネント |
| BasicFilterBuilder |
Power BI Basic フィルター ビルダー コンポーネント |
| BookmarksManager |
レポートのブックマークを管理します。 |
| Create |
Power BI レポート作成者コンポーネント |
| Dashboard |
Power BI ダッシュボード埋め込みコンポーネント |
| FilterBuilder |
BasicFilter、AdvancedFilter、RelativeDate、RelativeTime、TopN の汎用フィルター ビルダー |
| MIMEParams |
|
| MIMEType |
MIMEType クラス ブラウザー規則に従って、 MIME 文字列は、複数の意味のあるコンポーネントを含む構造化文字列です。 解析すると、これらの各コンポーネントのプロパティを含む |
| Page |
Power BI レポート ページ |
| Qna |
Power BI Q&A 埋め込みコンポーネント |
| QuickCreate |
Power BI クイック作成コンポーネント |
| RelativeDateFilterBuilder |
Power BI 相対日付フィルター ビルダー コンポーネント |
| RelativeTimeFilterBuilder |
Power BI 相対時間フィルター ビルダー コンポーネント |
| Report |
Power BI レポート埋め込みコンポーネント |
| Service |
Power BI サービス埋め込みコンポーネント。これは、他のすべての Power BI コンポーネントをアプリケーションに埋め込むエントリ ポイントです |
| Tile |
Power BI タイル埋め込みコンポーネント |
| TopNFilterBuilder |
Power BI Top N フィルター ビルダー コンポーネント |
| Visual |
Power BI ビジュアル埋め込みコンポーネント |
| VisualDescriptor |
ページ内の Power BI ビジュアル |
インターフェイス
型エイリアス
列挙型
関数
| is |
値が組み込みの
|
| is |
値が |
| is |
値が組み込みの |
| is |
値が型指定された配列オブジェクトや |
| is |
値が |
| is |
値が |
| is |
値が BigInt オブジェクトの場合 (例: |
| is |
値が |
| is |
値がブール値オブジェクトの場合に |
| is |
値がボックス化されたプリミティブ オブジェクト ( 例えば次が挙げられます。 |
| is |
|
| is |
値が組み込みの
|
| is |
値が組み込みの |
| is |
値がネイティブ ネイティブ
|
| is |
値が組み込みの |
| is |
値が組み込みの |
| is |
値が組み込みの |
| is |
値がジェネレーター関数の場合は、 |
| is |
値が組み込みのジェネレーター関数から返されるジェネレーター オブジェクトの場合は、 |
| is |
値が組み込みの |
| is |
値が組み込みの |
| is |
値が組み込みの |
| is |
|
| is |
値が組み込みの |
| is |
値が組み込みの |
| is |
|
| is |
ネイティブ エラーの種類のサブクラスもネイティブ エラーです。 ネイティブ エラー クラス 逆に、 |
| is |
値が数値オブジェクトの場合 (例: |
| is |
値が組み込みの |
| is |
値が |
| is |
値が正規表現オブジェクトの場合は、 |
| is |
値が組み込みの |
| is |
値が組み込みの |
| is |
値が組み込みの |
| is |
値が文字列オブジェクトの場合 (例: |
| is |
値がシンボル オブジェクトの場合は、 |
| is |
値が組み込みの
|
| is |
値が組み込みの |
| is |
値が組み込みの |
| is |
値が組み込みの |
| is |
値が組み込みの |
| is |
値が組み込みの |
| is |
値が組み込みの |
| inspect(any, boolean, number | null, boolean) |
循環参照は、参照インデックスを使用してアンカーを指します。 次の例では、 次の例では、
|
| promisify<TCustom>(Custom |
一般的なエラー優先コールバック スタイル (つまり、最後の引数として または、同じ方法で
|
| aborted(Abort |
指定された |
| add |
指定された URL にパラメーターを追加します |
| assign(any[]) | 列挙可能なすべてのプロパティの値を 1 つ以上のソース オブジェクトからターゲット オブジェクトにコピーし、ターゲット オブジェクトを返します。 |
| auto |
埋め込み URL に autoAuth=true が含まれているかどうかを確認します。 |
| callbackify(() => Promise<void>) |
次の内容が出力されます。 コールバックは非同期的に実行され、スタック トレースが制限されます。
コールバックがスローされると、プロセスは
|
| callbackify<TResult>(() => Promise<TResult>) | |
| callbackify<T1>((arg1: T1) => Promise<void>) | |
| callbackify<T1, TResult>((arg1: T1) => Promise<TResult>) | |
| callbackify<T1, T2>((arg1: T1, arg2: T2) => Promise<void>) | |
| callbackify<T1, T2, TResult>((arg1: T1, arg2: T2) => Promise<TResult>) | |
| callbackify<T1, T2, T3>((arg1: T1, arg2: T2, arg3: T3) => Promise<void>) | |
| callbackify<T1, T2, T3, TResult>((arg1: T1, arg2: T2, arg3: T3) => Promise<TResult>) | |
| callbackify<T1, T2, T3, T4>((arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise<void>) | |
| callbackify<T1, T2, T3, T4, TResult>((arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise<TResult>) | |
| callbackify<T1, T2, T3, T4, T5>((arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise<void>) | |
| callbackify<T1, T2, T3, T4, T5, TResult>((arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise<TResult>) | |
| callbackify<T1, T2, T3, T4, T5, T6>((arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6) => Promise<void>) | |
| callbackify<T1, T2, T3, T4, T5, T6, TResult>((arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6) => Promise<TResult>) | |
| convert |
これは、プロセスを操作して、プロセスを終了したシグナルに基づいて終了コードを決定する場合に特に便利です。 |
| create |
ランダムな 5 ~ 6 文字の文字列を生成します。 |
| debuglog(string, (fn: Debug |
このプログラムを環境内の ここで、
環境内で
省略可能な |
| deprecate<T>(T, string, string, Deprecate |
呼び出されると、
|
| diff(string | (readonly string[]), string | (readonly string[])) |
値が等しい場合は、空の配列が返されます。 |
| find<T>((x: T) => boolean, T[]) | 指定した述語と一致する配列内の最初の値を検索します。 |
| find |
指定した述語と一致する配列内の最初の値のインデックスを検索します。 |
| format(any, any[]) |
指定子に対応する引数がない場合は、置き換えされません。 書式指定文字列の一部ではない値は、型が 指定子の数よりも多くの引数が 最初の引数に有効な書式指定子が含まれていない場合、
|
| format |
この関数は、 |
| generateUUID() | 20 文字の uuid を生成します。 |
| get |
呼び出し元関数のスタックを含む呼び出しサイト オブジェクトの配列を返します。
オプション |
| get |
|
| get |
乱数を返します。 |
| get |
Node.js API から使用可能なすべてのシステム エラー コードのマップを返します。
エラー コードとエラー名の間のマッピングはプラットフォームに依存します。
一般的なエラーの名前については、 |
| get |
Node.js API から取得された数値エラー コードの文字列メッセージを返します。 エラー コードと文字列メッセージの間のマッピングは、プラットフォームに依存します。 |
| get |
Node.js API から取得された数値エラー コードの文字列名を返します。
エラー コードとエラー名の間のマッピングはプラットフォームに依存します。
一般的なエラーの名前については、 |
| get |
2 つの日付間の時間間隔をミリ秒単位で返します。 |
| inherits(unknown, unknown) |
ある コンストラクター から別のコンストラクターにプロトタイプ メソッドを継承します。
これにより、主に
|
| inspect(any, Inspect |
|
| is |
指定した |
| is |
埋め込み型が作成用であるかどうかを確認します |
| is |
詳細な厳密な等価性の詳細については、 |
| is |
埋め込み URL が RDL レポート用であるかどうかを確認します。 |
| is |
レポートが保存されているかどうかを確認します。 |
| parse |
|
| parse |
安定性: 1.1 - アクティブな開発 |
| promisify<TResult>((callback: (err: any, result: TResult) => void) => void) | |
| promisify((callback: (err?: any) => void) => void) | |
| promisify<T1, TResult>((arg1: T1, callback: (err: any, result: TResult) => void) => void) | |
| promisify<T1>((arg1: T1, callback: (err?: any) => void) => void) | |
| promisify<T1, T2, TResult>((arg1: T1, arg2: T2, callback: (err: any, result: TResult) => void) => void) | |
| promisify<T1, T2>((arg1: T1, arg2: T2, callback: (err?: any) => void) => void) | |
| promisify<T1, T2, T3, TResult>((arg1: T1, arg2: T2, arg3: T3, callback: (err: any, result: TResult) => void) => void) | |
| promisify<T1, T2, T3>((arg1: T1, arg2: T2, arg3: T3, callback: (err?: any) => void) => void) | |
| promisify<T1, T2, T3, T4, TResult>((arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: (err: any, result: TResult) => void) => void) | |
| promisify<T1, T2, T3, T4>((arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: (err?: any) => void) => void) | |
| promisify<T1, T2, T3, T4, T5, TResult>((arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err: any, result: TResult) => void) => void) | |
| promisify<T1, T2, T3, T4, T5>((arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err?: any) => void) => void) | |
| promisify(Function) | |
| raise |
指定した HTML 要素のイベント データを含むカスタム イベントを発生させます。 |
| remove<T>((x: T) => boolean, T[]) | |
| set |
|
| strip |
ANSI エスケープ コードが削除された |
| style |
この関数は、ターミナルで印刷するために渡された
書式の配列を渡す場合、適用される書式の順序は左から右に移動するため、次のスタイルによって前のスタイルが上書きされる可能性があります。 特殊な書式値 定義済みの色名に加えて、 形式の完全な一覧は、 |
| to |
サロゲート コード ポイント (または同等に、ペアになっていないサロゲート コード 単位) を Unicode の "置換文字" U+FFFD に置き換えた後の |
| transferable |
|
| transferable |
指定された |
変数
| APINot |
|
| Embed |
|
| Text |
|
| Text |
|
| Document | |
| HTMLIFrame |
|
| Window | |
| config | |
| invalid |
|
| hpm |
|
| router |
|
| wpmp |
関数の詳細
isAnyArrayBuffer(unknown)
値が組み込みの true または ArrayBuffer インスタンスの場合に SharedArrayBuffer を返します。
util.types.isArrayBuffer()とutil.types.isSharedArrayBuffer()も参照してください。
util.types.isAnyArrayBuffer(new ArrayBuffer()); // Returns true
util.types.isAnyArrayBuffer(new SharedArrayBuffer()); // Returns true
function isAnyArrayBuffer(object: unknown): object is ArrayBufferLikeパラメーター
- object
-
unknown
返品
object is ArrayBufferLike
isArgumentsObject(unknown)
値が true オブジェクトの場合は、arguments を返します。
function foo() {
util.types.isArgumentsObject(arguments); // Returns true
}
function isArgumentsObject(object: unknown): object is IArgumentsパラメーター
- object
-
unknown
返品
object is IArguments
isArrayBuffer(unknown)
値が組み込みの true インスタンスの場合は、ArrayBuffer を返します。
これには util.types.isAnyArrayBuffer() を参照してください。
util.types.isArrayBuffer(new ArrayBuffer()); // Returns true
util.types.isArrayBuffer(new SharedArrayBuffer()); // Returns false
function isArrayBuffer(object: unknown): object is ArrayBufferパラメーター
- object
-
unknown
返品
object is ArrayBuffer
isArrayBufferView(unknown)
値が型指定された配列オブジェクトや trueなど、ArrayBuffer ビューのいずれかのインスタンスである場合に DataView を返します。
ArrayBuffer.isView()に相当します。
util.types.isArrayBufferView(new Int8Array()); // true
util.types.isArrayBufferView(Buffer.from('hello world')); // true
util.types.isArrayBufferView(new DataView(new ArrayBuffer(16))); // true
util.types.isArrayBufferView(new ArrayBuffer()); // false
function isArrayBufferView(object: unknown): object is ArrayBufferViewパラメーター
- object
-
unknown
返品
object is ArrayBufferView
isAsyncFunction(unknown)
値が trueの場合は、 を返します。
これは、JavaScript エンジンに表示されている内容のみを報告します。特に、トランスパイレーション ツールを使用した場合、戻り値が元のソース コードと一致しない可能性があります。
util.types.isAsyncFunction(function foo() {}); // Returns false
util.types.isAsyncFunction(async function foo() {}); // Returns true
function isAsyncFunction(object: unknown): booleanパラメーター
- object
-
unknown
返品
boolean
isBigInt64Array(unknown)
値が true インスタンスの場合は、BigInt64Array を返します。
util.types.isBigInt64Array(new BigInt64Array()); // Returns true
util.types.isBigInt64Array(new BigUint64Array()); // Returns false
function isBigInt64Array(value: unknown): value is BigInt64Arrayパラメーター
- value
-
unknown
返品
value is BigInt64Array
isBigIntObject(unknown)
値が BigInt オブジェクトの場合 (例: trueによって作成された) Object(BigInt(123)) を返します。
util.types.isBigIntObject(Object(BigInt(123))); // Returns true
util.types.isBigIntObject(BigInt(123)); // Returns false
util.types.isBigIntObject(123); // Returns false
function isBigIntObject(object: unknown): object is BigIntパラメーター
- object
-
unknown
返品
object is BigInt
isBigUint64Array(unknown)
値が true インスタンスの場合は、BigUint64Array を返します。
util.types.isBigUint64Array(new BigInt64Array()); // Returns false
util.types.isBigUint64Array(new BigUint64Array()); // Returns true
function isBigUint64Array(value: unknown): value is BigUint64Arrayパラメーター
- value
-
unknown
返品
value is BigUint64Array
isBooleanObject(unknown)
値がブール値オブジェクトの場合に true を返します (例: new Boolean()によって作成されます)。
util.types.isBooleanObject(false); // Returns false
util.types.isBooleanObject(true); // Returns false
util.types.isBooleanObject(new Boolean(false)); // Returns true
util.types.isBooleanObject(new Boolean(true)); // Returns true
util.types.isBooleanObject(Boolean(false)); // Returns false
util.types.isBooleanObject(Boolean(true)); // Returns false
function isBooleanObject(object: unknown): object is Booleanパラメーター
- object
-
unknown
返品
object is Boolean
isBoxedPrimitive(unknown)
値がボックス化されたプリミティブ オブジェクト (true、new Boolean()、new String()によって作成されたオブジェクトなど) である場合に Object(Symbol()) を返します。
例えば次が挙げられます。
util.types.isBoxedPrimitive(false); // Returns false
util.types.isBoxedPrimitive(new Boolean(false)); // Returns true
util.types.isBoxedPrimitive(Symbol('foo')); // Returns false
util.types.isBoxedPrimitive(Object(Symbol('foo'))); // Returns true
util.types.isBoxedPrimitive(Object(BigInt(5))); // Returns true
function isBoxedPrimitive(object: unknown): object is String | Number | Boolean | Symbol | BigIntパラメーター
- object
-
unknown
返品
object is String | Number | Boolean | Symbol | BigInt
isCryptoKey(unknown)
true が valueの場合は CryptoKey を返し、それ以外の場合は false 返します。
function isCryptoKey(object: unknown): object is CryptoKeyパラメーター
- object
-
unknown
返品
object is CryptoKey
isDataView(unknown)
値が組み込みの true インスタンスの場合は、DataView を返します。
const ab = new ArrayBuffer(20);
util.types.isDataView(new DataView(ab)); // Returns true
util.types.isDataView(new Float64Array()); // Returns false
ArrayBuffer.isView() も参照してください。
function isDataView(object: unknown): object is DataViewパラメーター
- object
-
unknown
返品
object is DataView
isDate(unknown)
値が組み込みの true インスタンスの場合は、Date を返します。
util.types.isDate(new Date()); // Returns true
function isDate(object: unknown): object is Dateパラメーター
- object
-
unknown
返品
object is Date
isExternal(unknown)
値がネイティブ true 値の場合は、External を返します。
ネイティブ External 値は、ネイティブ コードからアクセスするための生の C++ ポインター (void*) を含み、他のプロパティを持たない特殊な種類のオブジェクトです。 このようなオブジェクトは、Node.js 内部またはネイティブ アドオンによって作成されます。 JavaScript では、 プロトタイプを持つnullオブジェクトです。
#include <js_native_api.h>
#include <stdlib.h>
napi_value result;
static napi_value MyNapi(napi_env env, napi_callback_info info) {
int* raw = (int*) malloc(1024);
napi_status status = napi_create_external(env, (void*) raw, NULL, NULL, &result);
if (status != napi_ok) {
napi_throw_error(env, NULL, "napi_create_external failed");
return NULL;
}
return result;
}
...
DECLARE_NAPI_PROPERTY("myNapi", MyNapi)
...
import native from 'napi_addon.node';
import { types } from 'node:util';
const data = native.myNapi();
types.isExternal(data); // returns true
types.isExternal(0); // returns false
types.isExternal(new String('foo')); // returns false
napi_create_externalの詳細については、napi_create_external()を参照してください。
function isExternal(object: unknown): booleanパラメーター
- object
-
unknown
返品
boolean
isFloat16Array(unknown)
値が組み込みの true インスタンスの場合は、Float16Array を返します。
util.types.isFloat16Array(new ArrayBuffer()); // Returns false
util.types.isFloat16Array(new Float16Array()); // Returns true
util.types.isFloat16Array(new Float32Array()); // Returns false
function isFloat16Array(object: unknown): object is Float16Arrayパラメーター
- object
-
unknown
返品
object is Float16Array
isFloat32Array(unknown)
値が組み込みの true インスタンスの場合は、Float32Array を返します。
util.types.isFloat32Array(new ArrayBuffer()); // Returns false
util.types.isFloat32Array(new Float32Array()); // Returns true
util.types.isFloat32Array(new Float64Array()); // Returns false
function isFloat32Array(object: unknown): object is Float32Arrayパラメーター
- object
-
unknown
返品
object is Float32Array
isFloat64Array(unknown)
値が組み込みの true インスタンスの場合は、Float64Array を返します。
util.types.isFloat64Array(new ArrayBuffer()); // Returns false
util.types.isFloat64Array(new Uint8Array()); // Returns false
util.types.isFloat64Array(new Float64Array()); // Returns true
function isFloat64Array(object: unknown): object is Float64Arrayパラメーター
- object
-
unknown
返品
object is Float64Array
isGeneratorFunction(unknown)
値がジェネレーター関数の場合は、true を返します。
これは、JavaScript エンジンに表示されている内容のみを報告します。特に、トランスパイレーション ツールを使用した場合、戻り値が元のソース コードと一致しない可能性があります。
util.types.isGeneratorFunction(function foo() {}); // Returns false
util.types.isGeneratorFunction(function* foo() {}); // Returns true
function isGeneratorFunction(object: unknown): object is GeneratorFunctionパラメーター
- object
-
unknown
返品
object is GeneratorFunction
isGeneratorObject(unknown)
値が組み込みのジェネレーター関数から返されるジェネレーター オブジェクトの場合は、true を返します。
これは、JavaScript エンジンに表示されている内容のみを報告します。特に、トランスパイレーション ツールを使用した場合、戻り値が元のソース コードと一致しない可能性があります。
function* foo() {}
const generator = foo();
util.types.isGeneratorObject(generator); // Returns true
function isGeneratorObject(object: unknown): object is Generatorパラメーター
- object
-
unknown
返品
object is Generator
isInt16Array(unknown)
値が組み込みの true インスタンスの場合は、Int16Array を返します。
util.types.isInt16Array(new ArrayBuffer()); // Returns false
util.types.isInt16Array(new Int16Array()); // Returns true
util.types.isInt16Array(new Float64Array()); // Returns false
function isInt16Array(object: unknown): object is Int16Arrayパラメーター
- object
-
unknown
返品
object is Int16Array
isInt32Array(unknown)
値が組み込みの true インスタンスの場合は、Int32Array を返します。
util.types.isInt32Array(new ArrayBuffer()); // Returns false
util.types.isInt32Array(new Int32Array()); // Returns true
util.types.isInt32Array(new Float64Array()); // Returns false
function isInt32Array(object: unknown): object is Int32Arrayパラメーター
- object
-
unknown
返品
object is Int32Array
isInt8Array(unknown)
値が組み込みの true インスタンスの場合は、Int8Array を返します。
util.types.isInt8Array(new ArrayBuffer()); // Returns false
util.types.isInt8Array(new Int8Array()); // Returns true
util.types.isInt8Array(new Float64Array()); // Returns false
function isInt8Array(object: unknown): object is Int8Arrayパラメーター
- object
-
unknown
返品
object is Int8Array
isKeyObject(unknown)
true が valueの場合は KeyObject を返し、それ以外の場合は false 返します。
function isKeyObject(object: unknown): object is KeyObjectパラメーター
- object
-
unknown
返品
object is KeyObject
isMap<T>({} | T)
値が組み込みの true インスタンスの場合は、Map を返します。
util.types.isMap(new Map()); // Returns true
function isMap<T>(object: {} | T): object is (T extends ReadonlyMap<any, any> ? (unknown extends T ? never : ReadonlyMap<any, any>) : Map<unknown, unknown>)パラメーター
- object
-
{} | T
返品
object is (T extends ReadonlyMap<any, any> ? (unknown extends T ? never : ReadonlyMap<any, any>) : Map<unknown, unknown>)
isMapIterator(unknown)
値が組み込みの true インスタンスに対して返される反復子の場合は、Map を返します。
const map = new Map();
util.types.isMapIterator(map.keys()); // Returns true
util.types.isMapIterator(map.values()); // Returns true
util.types.isMapIterator(map.entries()); // Returns true
util.types.isMapIterator(map[Symbol.iterator]()); // Returns true
function isMapIterator(object: unknown): booleanパラメーター
- object
-
unknown
返品
boolean
isModuleNamespaceObject(unknown)
isNativeError(unknown)
警告
この API は非推奨になりました。
The util.types.isNativeError API is deprecated. Please use Error.isError instead.
true
Error 返します。
console.log(util.types.isNativeError(new Error())); // true
console.log(util.types.isNativeError(new TypeError())); // true
console.log(util.types.isNativeError(new RangeError())); // true
ネイティブ エラーの種類のサブクラスもネイティブ エラーです。
class MyError extends Error {}
console.log(util.types.isNativeError(new MyError())); // true
ネイティブ エラー クラス instanceof されている値は、その値 isNativeError()true を返すのと同じではありません。
isNativeError() は、異なる true からのエラーの を返しますが、instanceof Error はこれらのエラーの false を返します。
import { createContext, runInContext } from 'node:vm';
import { types } from 'node:util';
const context = createContext({});
const myError = runInContext('new Error()', context);
console.log(types.isNativeError(myError)); // true
console.log(myError instanceof Error); // false
逆に、isNativeError() は、ネイティブ エラーのコンストラクターによって返されなかったすべてのオブジェクトの false を返します。 これには、ネイティブ エラー instanceof 値が含まれます。
const myError = { __proto__: Error.prototype };
console.log(util.types.isNativeError(myError)); // false
console.log(myError instanceof Error); // true
function isNativeError(object: unknown): object is Errorパラメーター
- object
-
unknown
返品
object is Error
isNumberObject(unknown)
値が数値オブジェクトの場合 (例: trueによって作成された) new Number() を返します。
util.types.isNumberObject(0); // Returns false
util.types.isNumberObject(new Number(0)); // Returns true
function isNumberObject(object: unknown): object is Numberパラメーター
- object
-
unknown
返品
object is Number
isPromise(unknown)
値が組み込みの trueの場合は、Promise を返します。
util.types.isPromise(Promise.resolve(42)); // Returns true
function isPromise(object: unknown): object is Promise<unknown>パラメーター
- object
-
unknown
返品
object is Promise<unknown>
isProxy(unknown)
値が true インスタンスの場合は、Proxy を返します。
const target = {};
const proxy = new Proxy(target, {});
util.types.isProxy(target); // Returns false
util.types.isProxy(proxy); // Returns true
function isProxy(object: unknown): booleanパラメーター
- object
-
unknown
返品
boolean
isRegExp(unknown)
値が正規表現オブジェクトの場合は、true を返します。
util.types.isRegExp(/abc/); // Returns true
util.types.isRegExp(new RegExp('abc')); // Returns true
function isRegExp(object: unknown): object is RegExpパラメーター
- object
-
unknown
返品
object is RegExp
isSet<T>({} | T)
値が組み込みの true インスタンスの場合は、Set を返します。
util.types.isSet(new Set()); // Returns true
function isSet<T>(object: {} | T): object is (T extends ReadonlySet<any> ? (unknown extends T ? never : ReadonlySet<any>) : Set<unknown>)パラメーター
- object
-
{} | T
返品
object is (T extends ReadonlySet<any> ? (unknown extends T ? never : ReadonlySet<any>) : Set<unknown>)
isSetIterator(unknown)
値が組み込みの true インスタンスに対して返される反復子の場合は、Set を返します。
const set = new Set();
util.types.isSetIterator(set.keys()); // Returns true
util.types.isSetIterator(set.values()); // Returns true
util.types.isSetIterator(set.entries()); // Returns true
util.types.isSetIterator(set[Symbol.iterator]()); // Returns true
function isSetIterator(object: unknown): booleanパラメーター
- object
-
unknown
返品
boolean
isSharedArrayBuffer(unknown)
値が組み込みの true インスタンスの場合は、SharedArrayBuffer を返します。
これには util.types.isAnyArrayBuffer() を参照してください。
util.types.isSharedArrayBuffer(new ArrayBuffer()); // Returns false
util.types.isSharedArrayBuffer(new SharedArrayBuffer()); // Returns true
function isSharedArrayBuffer(object: unknown): object is SharedArrayBufferパラメーター
- object
-
unknown
返品
object is SharedArrayBuffer
isStringObject(unknown)
値が文字列オブジェクトの場合 (例: trueによって作成された場合) new String() を返します。
util.types.isStringObject('foo'); // Returns false
util.types.isStringObject(new String('foo')); // Returns true
function isStringObject(object: unknown): object is Stringパラメーター
- object
-
unknown
返品
object is String
isSymbolObject(unknown)
値がシンボル オブジェクトの場合は、true プリミティブで Object() を呼び出して作成された Symbol を返します。
const symbol = Symbol('foo');
util.types.isSymbolObject(symbol); // Returns false
util.types.isSymbolObject(Object(symbol)); // Returns true
function isSymbolObject(object: unknown): object is Symbolパラメーター
- object
-
unknown
返品
object is Symbol
isTypedArray(unknown)
値が組み込みの true インスタンスの場合は、TypedArray を返します。
util.types.isTypedArray(new ArrayBuffer()); // Returns false
util.types.isTypedArray(new Uint8Array()); // Returns true
util.types.isTypedArray(new Float64Array()); // Returns true
ArrayBuffer.isView() も参照してください。
function isTypedArray(object: unknown): object is TypedArrayパラメーター
- object
-
unknown
返品
object is TypedArray
isUint16Array(unknown)
値が組み込みの true インスタンスの場合は、Uint16Array を返します。
util.types.isUint16Array(new ArrayBuffer()); // Returns false
util.types.isUint16Array(new Uint16Array()); // Returns true
util.types.isUint16Array(new Float64Array()); // Returns false
function isUint16Array(object: unknown): object is Uint16Arrayパラメーター
- object
-
unknown
返品
object is Uint16Array
isUint32Array(unknown)
値が組み込みの true インスタンスの場合は、Uint32Array を返します。
util.types.isUint32Array(new ArrayBuffer()); // Returns false
util.types.isUint32Array(new Uint32Array()); // Returns true
util.types.isUint32Array(new Float64Array()); // Returns false
function isUint32Array(object: unknown): object is Uint32Arrayパラメーター
- object
-
unknown
返品
object is Uint32Array
isUint8Array(unknown)
値が組み込みの true インスタンスの場合は、Uint8Array を返します。
util.types.isUint8Array(new ArrayBuffer()); // Returns false
util.types.isUint8Array(new Uint8Array()); // Returns true
util.types.isUint8Array(new Float64Array()); // Returns false
function isUint8Array(object: unknown): object is Uint8Arrayパラメーター
- object
-
unknown
返品
object is Uint8Array
isUint8ClampedArray(unknown)
値が組み込みの true インスタンスの場合は、Uint8ClampedArray を返します。
util.types.isUint8ClampedArray(new ArrayBuffer()); // Returns false
util.types.isUint8ClampedArray(new Uint8ClampedArray()); // Returns true
util.types.isUint8ClampedArray(new Float64Array()); // Returns false
function isUint8ClampedArray(object: unknown): object is Uint8ClampedArrayパラメーター
- object
-
unknown
返品
object is Uint8ClampedArray
isWeakMap(unknown)
値が組み込みの true インスタンスの場合は、WeakMap を返します。
util.types.isWeakMap(new WeakMap()); // Returns true
function isWeakMap(object: unknown): object is WeakMap<object, unknown>パラメーター
- object
-
unknown
返品
object is WeakMap<object, unknown>
isWeakSet(unknown)
値が組み込みの true インスタンスの場合は、WeakSet を返します。
util.types.isWeakSet(new WeakSet()); // Returns true
function isWeakSet(object: unknown): object is WeakSet<object>パラメーター
- object
-
unknown
返品
object is WeakSet<object>
inspect(any, boolean, number | null, boolean)
util.inspect() メソッドは、デバッグを目的とした object の文字列形式を返します。
util.inspect の出力はいつでも変更される可能性があり、プログラムに依存しないでください。 結果を変更する追加の options を渡すことができます。
util.inspect() は、コンストラクターの名前や Symbol.toStringTag プロパティを使用して、検査された値の識別可能なタグを作成します。
class Foo {
get [Symbol.toStringTag]() {
return 'bar';
}
}
class Bar {}
const baz = Object.create(null, { [Symbol.toStringTag]: { value: 'foo' } });
util.inspect(new Foo()); // 'Foo [bar] {}'
util.inspect(new Bar()); // 'Bar {}'
util.inspect(baz); // '[foo] {}'
循環参照は、参照インデックスを使用してアンカーを指します。
import { inspect } from 'node:util';
const obj = {};
obj.a = [obj];
obj.b = {};
obj.b.inner = obj.b;
obj.b.obj = obj;
console.log(inspect(obj));
// <ref *1> {
// a: [ [Circular *1] ],
// b: <ref *2> { inner: [Circular *2], obj: [Circular *1] }
// }
次の例では、util オブジェクトのすべてのプロパティを調べます。
import util from 'node:util';
console.log(util.inspect(util, { showHidden: true, depth: null }));
次の例では、compact オプションの効果を強調表示します。
import { inspect } from 'node:util';
const o = {
a: [1, 2, [[
'Lorem ipsum dolor sit amet,\nconsectetur adipiscing elit, sed do ' +
'eiusmod \ntempor incididunt ut labore et dolore magna aliqua.',
'test',
'foo']], 4],
b: new Map([['za', 1], ['zb', 'test']]),
};
console.log(inspect(o, { compact: true, depth: 5, breakLength: 80 }));
// { a:
// [ 1,
// 2,
// [ [ 'Lorem ipsum dolor sit amet,\nconsectetur [...]', // A long line
// 'test',
// 'foo' ] ],
// 4 ],
// b: Map(2) { 'za' => 1, 'zb' => 'test' } }
// Setting `compact` to false or an integer creates more reader friendly output.
console.log(inspect(o, { compact: false, depth: 5, breakLength: 80 }));
// {
// a: [
// 1,
// 2,
// [
// [
// 'Lorem ipsum dolor sit amet,\n' +
// 'consectetur adipiscing elit, sed do eiusmod \n' +
// 'tempor incididunt ut labore et dolore magna aliqua.',
// 'test',
// 'foo'
// ]
// ],
// 4
// ],
// b: Map(2) {
// 'za' => 1,
// 'zb' => 'test'
// }
// }
// Setting `breakLength` to e.g. 150 will print the "Lorem ipsum" text in a
// single line.
showHidden オプションを使用すると、WeakMap エントリと WeakSet エントリを検査できます。
maxArrayLengthより多くのエントリがある場合、どのエントリが表示されているかは保証されません。 つまり、同じ WeakSet エントリを 2 回取得すると、出力が異なる可能性があります。 さらに、厳密な参照が残っていないエントリは、いつでもガベージ コレクションされる可能性があります。
import { inspect } from 'node:util';
const obj = { a: 1 };
const obj2 = { b: 2 };
const weakSet = new WeakSet([obj, obj2]);
console.log(inspect(weakSet, { showHidden: true }));
// WeakSet { { a: 1 }, { b: 2 } }
sorted オプションを使用すると、オブジェクトのプロパティの挿入順序が util.inspect()の結果に影響を与えなくなります。
import { inspect } from 'node:util';
import assert from 'node:assert';
const o1 = {
b: [2, 3, 1],
a: '`a` comes before `b`',
c: new Set([2, 3, 1]),
};
console.log(inspect(o1, { sorted: true }));
// { a: '`a` comes before `b`', b: [ 2, 3, 1 ], c: Set(3) { 1, 2, 3 } }
console.log(inspect(o1, { sorted: (a, b) => b.localeCompare(a) }));
// { c: Set(3) { 3, 2, 1 }, b: [ 2, 3, 1 ], a: '`a` comes before `b`' }
const o2 = {
c: new Set([2, 1, 3]),
a: '`a` comes before `b`',
b: [2, 3, 1],
};
assert.strict.equal(
inspect(o1, { sorted: true }),
inspect(o2, { sorted: true }),
);
numericSeparator オプションでは、3 桁ごとにアンダースコアがすべての数値に追加されます。
import { inspect } from 'node:util';
const thousand = 1000;
const million = 1000000;
const bigNumber = 123456789n;
const bigDecimal = 1234.12345;
console.log(inspect(thousand, { numericSeparator: true }));
// 1_000
console.log(inspect(million, { numericSeparator: true }));
// 1_000_000
console.log(inspect(bigNumber, { numericSeparator: true }));
// 123_456_789n
console.log(inspect(bigDecimal, { numericSeparator: true }));
// 1_234.123_45
util.inspect() は、デバッグを目的とした同期メソッドです。 最大出力長は約 128 MiB です。 出力が長くなる入力は切り捨てられます。
function inspect(object: any, showHidden?: boolean, depth?: number | null, color?: boolean): stringパラメーター
- object
-
any
任意の JavaScript プリミティブまたは Object。
- showHidden
-
boolean
- depth
-
number | null
- color
-
boolean
返品
string
objectの表現。
promisify<TCustom>(CustomPromisify<TCustom>)
一般的なエラー優先コールバック スタイル (つまり、最後の引数として (err, value) => ... コールバックを受け取る) に続く関数を受け取り、promise を返すバージョンを返します。
import { promisify } from 'node:util';
import { stat } from 'node:fs';
const promisifiedStat = promisify(stat);
promisifiedStat('.').then((stats) => {
// Do something with `stats`
}).catch((error) => {
// Handle the error.
});
または、同じ方法で async functions を使用します。
import { promisify } from 'node:util';
import { stat } from 'node:fs';
const promisifiedStat = promisify(stat);
async function callStat() {
const stats = await promisifiedStat('.');
console.log(`This directory is owned by ${stats.uid}`);
}
callStat();
original[util.promisify.custom]プロパティが存在する場合、promisifyはその値を返します。カスタムのプロミス関数を参照してください。
promisify() は、original は、すべてのケースでコールバックを最終的な引数として受け取る関数であることを前提としています。
original が関数でない場合、promisify() はエラーをスローします。
original が関数であり、その最後の引数がエラー優先コールバックでない場合でも、最後の引数としてエラー優先コールバックが渡されます。
promisify() を使用するクラス メソッドまたはその他のメソッドに対して this を使用すると、特別に処理されない限り、期待どおりに動作しない場合があります。
import { promisify } from 'node:util';
class Foo {
constructor() {
this.a = 42;
}
bar(callback) {
callback(null, this.a);
}
}
const foo = new Foo();
const naiveBar = promisify(foo.bar);
// TypeError: Cannot read properties of undefined (reading 'a')
// naiveBar().then(a => console.log(a));
naiveBar.call(foo).then((a) => console.log(a)); // '42'
const bindBar = naiveBar.bind(foo);
bindBar().then((a) => console.log(a)); // '42'
function promisify<TCustom>(fn: CustomPromisify<TCustom>): TCustomパラメーター
- fn
-
CustomPromisify<TCustom>
返品
TCustom
aborted(AbortSignal, any)
指定された signal で中止イベントをリッスンし、signal が中止されたときに解決される promise を返します。
resource 指定すると、操作に関連付けられているオブジェクトが弱く参照されるため、resource が中止される前に signal がガベージ コレクションされた場合、返された promise は保留中のままとなります。
これにより、実行時間の長い操作または取り消し不可能な操作でのメモリ リークを防ぐことができます。
import { aborted } from 'node:util';
// Obtain an object with an abortable signal, like a custom resource or operation.
const dependent = obtainSomethingAbortable();
// Pass `dependent` as the resource, indicating the promise should only resolve
// if `dependent` is still in memory when the signal is aborted.
aborted(dependent.signal, dependent).then(() => {
// This code runs when `dependent` is aborted.
console.log('Dependent resource was aborted.');
});
// Simulate an event that triggers the abort.
dependent.on('event', () => {
dependent.abort(); // This will cause the `aborted` promise to resolve.
});
function aborted(signal: AbortSignal, resource: any): Promise<void>パラメーター
- signal
-
AbortSignal
- resource
-
any
中止可能な操作に関連付けられ、弱く保持されている null 以外のオブジェクト。
resource が中止される前に signal がガベージ コレクションされた場合、promise は保留中のままになり、Node.js はその追跡を停止できます。
これは、実行時間の長い操作または取り消し不可能な操作でのメモリ リークを防ぐのに役立ちます。
返品
Promise<void>
addParamToUrl(string, string, string)
指定された URL にパラメーターを追加します
function addParamToUrl(url: string, paramName: string, value: string): stringパラメーター
- url
-
string
- paramName
-
string
- value
-
string
返品
string
assign(any[])
列挙可能なすべてのプロパティの値を 1 つ以上のソース オブジェクトからターゲット オブジェクトにコピーし、ターゲット オブジェクトを返します。
function assign(args: any[]): anyパラメーター
- args
-
any[]
返品
any
autoAuthInEmbedUrl(string)
埋め込み URL に autoAuth=true が含まれているかどうかを確認します。
function autoAuthInEmbedUrl(embedUrl: string): booleanパラメーター
- embedUrl
-
string
返品
boolean
callbackify(() => Promise<void>)
async 関数 (または Promiseを返す関数) を受け取り、エラー優先のコールバック スタイルに従って関数を返します。つまり、最後の引数として (err, value) => ... コールバックを受け取ります。 コールバックでは、最初の引数が拒否理由 (または null 解決された場合は Promise) になり、2 番目の引数は解決された値になります。
import { callbackify } from 'node:util';
async function fn() {
return 'hello world';
}
const callbackFunction = callbackify(fn);
callbackFunction((err, ret) => {
if (err) throw err;
console.log(ret);
});
次の内容が出力されます。
hello world
コールバックは非同期的に実行され、スタック トレースが制限されます。
コールバックがスローされると、プロセスは 'uncaughtException' イベントを出力し、処理されない場合は終了します。
null はコールバックの最初の引数として特別な意味を持つので、ラップされた関数が理由として改ざんされた値を持つ Promise を拒否した場合、値は Errorという名前のフィールドに格納された元の値を持つ reason にラップされます。
import util from 'node:util';
function fn() {
return Promise.reject(null);
}
const callbackFunction = util.callbackify(fn);
callbackFunction((err, ret) => {
// When the Promise was rejected with `null` it is wrapped with an Error and
// the original value is stored in `reason`.
err && Object.hasOwn(err, 'reason') && err.reason === null; // true
});
function callbackify(fn: () => Promise<void>): (callback: (err: ErrnoException) => void) => voidパラメーター
- fn
-
() => Promise<void>
async 関数
返品
(callback: (err: ErrnoException) => void) => void
コールバック スタイル関数
callbackify<TResult>(() => Promise<TResult>)
function callbackify<TResult>(fn: () => Promise<TResult>): (callback: (err: ErrnoException, result: TResult) => void) => voidパラメーター
- fn
-
() => Promise<TResult>
返品
(callback: (err: ErrnoException, result: TResult) => void) => void
callbackify<T1>((arg1: T1) => Promise<void>)
function callbackify<T1>(fn: (arg1: T1) => Promise<void>): (arg1: T1, callback: (err: ErrnoException) => void) => voidパラメーター
- fn
-
(arg1: T1) => Promise<void>
返品
(arg1: T1, callback: (err: ErrnoException) => void) => void
callbackify<T1, TResult>((arg1: T1) => Promise<TResult>)
function callbackify<T1, TResult>(fn: (arg1: T1) => Promise<TResult>): (arg1: T1, callback: (err: ErrnoException, result: TResult) => void) => voidパラメーター
- fn
-
(arg1: T1) => Promise<TResult>
返品
(arg1: T1, callback: (err: ErrnoException, result: TResult) => void) => void
callbackify<T1, T2>((arg1: T1, arg2: T2) => Promise<void>)
function callbackify<T1, T2>(fn: (arg1: T1, arg2: T2) => Promise<void>): (arg1: T1, arg2: T2, callback: (err: ErrnoException) => void) => voidパラメーター
- fn
-
(arg1: T1, arg2: T2) => Promise<void>
返品
(arg1: T1, arg2: T2, callback: (err: ErrnoException) => void) => void
callbackify<T1, T2, TResult>((arg1: T1, arg2: T2) => Promise<TResult>)
function callbackify<T1, T2, TResult>(fn: (arg1: T1, arg2: T2) => Promise<TResult>): (arg1: T1, arg2: T2, callback: (err: ErrnoException | null, result: TResult) => void) => voidパラメーター
- fn
-
(arg1: T1, arg2: T2) => Promise<TResult>
返品
(arg1: T1, arg2: T2, callback: (err: ErrnoException | null, result: TResult) => void) => void
callbackify<T1, T2, T3>((arg1: T1, arg2: T2, arg3: T3) => Promise<void>)
function callbackify<T1, T2, T3>(fn: (arg1: T1, arg2: T2, arg3: T3) => Promise<void>): (arg1: T1, arg2: T2, arg3: T3, callback: (err: ErrnoException) => void) => voidパラメーター
- fn
-
(arg1: T1, arg2: T2, arg3: T3) => Promise<void>
返品
(arg1: T1, arg2: T2, arg3: T3, callback: (err: ErrnoException) => void) => void
callbackify<T1, T2, T3, TResult>((arg1: T1, arg2: T2, arg3: T3) => Promise<TResult>)
function callbackify<T1, T2, T3, TResult>(fn: (arg1: T1, arg2: T2, arg3: T3) => Promise<TResult>): (arg1: T1, arg2: T2, arg3: T3, callback: (err: ErrnoException | null, result: TResult) => void) => voidパラメーター
- fn
-
(arg1: T1, arg2: T2, arg3: T3) => Promise<TResult>
返品
(arg1: T1, arg2: T2, arg3: T3, callback: (err: ErrnoException | null, result: TResult) => void) => void
callbackify<T1, T2, T3, T4>((arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise<void>)
function callbackify<T1, T2, T3, T4>(fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise<void>): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: (err: ErrnoException) => void) => voidパラメーター
- fn
-
(arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise<void>
返品
(arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: (err: ErrnoException) => void) => void
callbackify<T1, T2, T3, T4, TResult>((arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise<TResult>)
function callbackify<T1, T2, T3, T4, TResult>(fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise<TResult>): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: (err: ErrnoException | null, result: TResult) => void) => voidパラメーター
- fn
-
(arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise<TResult>
返品
(arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: (err: ErrnoException | null, result: TResult) => void) => void
callbackify<T1, T2, T3, T4, T5>((arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise<void>)
function callbackify<T1, T2, T3, T4, T5>(fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise<void>): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err: ErrnoException) => void) => voidパラメーター
- fn
-
(arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise<void>
返品
(arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err: ErrnoException) => void) => void
callbackify<T1, T2, T3, T4, T5, TResult>((arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise<TResult>)
function callbackify<T1, T2, T3, T4, T5, TResult>(fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise<TResult>): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err: ErrnoException | null, result: TResult) => void) => voidパラメーター
- fn
-
(arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise<TResult>
返品
(arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err: ErrnoException | null, result: TResult) => void) => void
callbackify<T1, T2, T3, T4, T5, T6>((arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6) => Promise<void>)
function callbackify<T1, T2, T3, T4, T5, T6>(fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6) => Promise<void>): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6, callback: (err: ErrnoException) => void) => voidパラメーター
- fn
-
(arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6) => Promise<void>
返品
(arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6, callback: (err: ErrnoException) => void) => void
callbackify<T1, T2, T3, T4, T5, T6, TResult>((arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6) => Promise<TResult>)
function callbackify<T1, T2, T3, T4, T5, T6, TResult>(fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6) => Promise<TResult>): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6, callback: (err: ErrnoException | null, result: TResult) => void) => voidパラメーター
- fn
-
(arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6) => Promise<TResult>
返品
(arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6, callback: (err: ErrnoException | null, result: TResult) => void) => void
convertProcessSignalToExitCode(Signals)
util.convertProcessSignalToExitCode()メソッドは、シグナル名を対応する POSIX 終了コードに変換します。 POSIX 標準に従って、シグナルによって終了されるプロセスの終了コードは、 128 + signal numberとして計算されます。
signalが有効なシグナル名でない場合は、エラーがスローされます。 有効なシグナルの一覧については、 signal(7) を参照してください。
import { convertProcessSignalToExitCode } from 'node:util';
console.log(convertProcessSignalToExitCode('SIGTERM')); // 143 (128 + 15)
console.log(convertProcessSignalToExitCode('SIGKILL')); // 137 (128 + 9)
これは、プロセスを操作して、プロセスを終了したシグナルに基づいて終了コードを決定する場合に特に便利です。
function convertProcessSignalToExitCode(signal: Signals): numberパラメーター
- signal
-
Signals
シグナル名 (例: 'SIGTERM')
返品
number
に対応する終了コード signal
createRandomString()
ランダムな 5 ~ 6 文字の文字列を生成します。
function createRandomString(): string返品
string
debuglog(string, (fn: DebugLoggerFunction) => void)
util.debuglog() メソッドを使用して、stderr環境変数の存在に基づいてデバッグ メッセージをNODE_DEBUGに条件付きで書き込む関数を作成します。
section 名がその環境変数の値内に表示される場合、返される関数は console.error()と同様に動作します。 そうでない場合、返される関数は no-opです。
import { debuglog } from 'node:util';
const log = debuglog('foo');
log('hello from foo [%d]', 123);
このプログラムを環境内の NODE_DEBUG=foo で実行すると、次のような出力が出力されます。
FOO 3245: hello from foo [123]
ここで、3245 はプロセス ID です。その環境変数が設定された状態で実行されていない場合、何も出力されません。
section ではワイルドカードもサポートされています。
import { debuglog } from 'node:util';
const log = debuglog('foo-bar');
log('hi there, it\'s foo-bar [%d]', 2333);
環境内で NODE_DEBUG=foo* を使用して実行される場合は、次のような出力が出力されます。
FOO-BAR 3257: hi there, it's foo-bar [2333]
section環境変数には、複数のコンマ区切りのNODE_DEBUG名 (NODE_DEBUG=fs,net,tls) を指定できます。
省略可能な callback 引数を使用して、初期化や不要な折り返しがない別の関数でログ関数を置き換えることができます。
import { debuglog } from 'node:util';
let log = debuglog('internals', (debug) => {
// Replace with a logging function that optimizes out
// testing if the section is enabled
log = debug;
});
function debuglog(section: string, callback?: (fn: DebugLoggerFunction) => void): DebugLoggerパラメーター
- section
-
string
debuglog 関数が作成されているアプリケーションの部分を識別する文字列。
- callback
-
(fn: DebugLoggerFunction) => void
より最適化されたログ関数である関数引数を使用してログ関数が初めて呼び出されたときに呼び出されたコールバック。
返品
ログ関数
deprecate<T>(T, string, string, DeprecateOptions)
util.deprecate() メソッドは、fn (関数またはクラスである可能性があります) を、非推奨としてマークされるようにラップします。
import { deprecate } from 'node:util';
export const obsoleteFunction = deprecate(() => {
// Do something here.
}, 'obsoleteFunction() is deprecated. Use newShinyFunction() instead.');
呼び出されると、util.deprecate() は、DeprecationWarning イベントを使用して 'warning' を出力する関数を返します。 警告が出力され、返された関数が初めて呼び出 stderr に出力されます。 警告が生成されると、ラップされた関数は警告を生成せずに呼び出されます。
codeの複数の呼び出しで同じ省略可能な util.deprecate() が指定されている場合、警告はその codeに対して 1 回だけ出力されます。
import { deprecate } from 'node:util';
const fn1 = deprecate(
() => 'a value',
'deprecation message',
'DEP0001',
);
const fn2 = deprecate(
() => 'a different value',
'other dep message',
'DEP0001',
);
fn1(); // Emits a deprecation warning with code DEP0001
fn2(); // Does not emit a deprecation warning because it has the same code
--trace-deprecation または --trace-warnings コマンド ライン フラグが設定されている場合、または process.traceDeprecation プロパティが trueに設定されている場合は、非推奨の関数が初めて呼び出されるときに警告とスタック トレースが stderr に出力されます。
--throw-deprecation コマンド ライン フラグが設定されている場合、または process.throwDeprecation プロパティが trueに設定されている場合は、非推奨の関数が呼び出されたときに例外がスローされます。
--throw-deprecation コマンド ライン フラグと process.throwDeprecation プロパティは、--trace-deprecation と process.traceDeprecationよりも優先されます。
function deprecate<T>(fn: T, msg: string, code?: string, options?: DeprecateOptions): Tパラメーター
- fn
-
T
非推奨となる関数。
- msg
-
string
非推奨の関数が呼び出されたときに表示される警告メッセージ。
- code
-
string
非推奨コード。 コードの一覧については、list of deprecated APIs を参照してください。
- options
- DeprecateOptions
返品
T
非推奨の関数は、警告を出力するためにラップされました。
diff(string | (readonly string[]), string | (readonly string[]))
util.diff() は、2 つの文字列または配列値を比較し、差分エントリの配列を返します。
Myers 差分アルゴリズムを使用して最小限の違いを計算します。これは、アサーション エラー メッセージによって内部的に使用されるのと同じアルゴリズムです。
値が等しい場合は、空の配列が返されます。
const { diff } = require('node:util');
// Comparing strings
const actualString = '12345678';
const expectedString = '12!!5!7!';
console.log(diff(actualString, expectedString));
// [
// [0, '1'],
// [0, '2'],
// [1, '3'],
// [1, '4'],
// [-1, '!'],
// [-1, '!'],
// [0, '5'],
// [1, '6'],
// [-1, '!'],
// [0, '7'],
// [1, '8'],
// [-1, '!'],
// ]
// Comparing arrays
const actualArray = ['1', '2', '3'];
const expectedArray = ['1', '3', '4'];
console.log(diff(actualArray, expectedArray));
// [
// [0, '1'],
// [1, '2'],
// [0, '3'],
// [-1, '4'],
// ]
// Equal values return empty array
console.log(diff('same', 'same'));
// []
function diff(actual: string | (readonly string[]), expected: string | (readonly string[])): DiffEntry[]パラメーター
- actual
-
string | (readonly string[])
比較する最初の値
- expected
-
string | (readonly string[])
比較する 2 番目の値
返品
差分エントリの配列。 各エントリは、2 つの要素を持つ配列です。
- インデックス 0:
number操作コード: 削除用の-1、no-op/unchanged の0、挿入用の1 - インデックス 1:
string操作に関連付けられている値
find<T>((x: T) => boolean, T[])
指定した述語と一致する配列内の最初の値を検索します。
function find<T>(predicate: (x: T) => boolean, xs: T[]): Tパラメーター
- predicate
-
(x: T) => boolean
- xs
-
T[]
返品
T
findIndex<T>((x: T) => boolean, T[])
指定した述語と一致する配列内の最初の値のインデックスを検索します。
function findIndex<T>(predicate: (x: T) => boolean, xs: T[]): numberパラメーター
- predicate
-
(x: T) => boolean
- xs
-
T[]
返品
number
format(any, any[])
util.format() メソッドは、0 個以上の書式指定子を含むことができる printfのような書式指定文字列として、最初の引数を使用して書式設定された文字列を返します。 各指定子は、対応する引数から変換された値に置き換えられます。 サポートされている指定子は次のとおりです。
指定子に対応する引数がない場合は、置き換えされません。
util.format('%s:%s', 'foo');
// Returns: 'foo:%s'
書式指定文字列の一部ではない値は、型が util.inspect()されていない場合、string を使用して書式設定されます。
指定子の数よりも多くの引数が util.format() メソッドに渡される場合、余分な引数は、返された文字列に連結され、スペースで区切られます。
util.format('%s:%s', 'foo', 'bar', 'baz');
// Returns: 'foo:bar baz'
最初の引数に有効な書式指定子が含まれていない場合、util.format() はスペースで区切られたすべての引数を連結した文字列を返します。
util.format(1, 2, 3);
// Returns: '1 2 3'
util.format()に渡される引数が 1 つだけの場合は、書式設定なしでそのまま返されます。
util.format('%% %s');
// Returns: '%% %s'
util.format() は、デバッグ ツールとして使用される同期メソッドです。
一部の入力値には、イベント ループをブロックする可能性のあるパフォーマンス オーバーヘッドが大きくなる可能性があります。 この関数は注意して使用します。ホット コード パスには使用しないでください。
function format(format?: any, param: any[]): stringパラメーター
- format
-
any
printfのような書式指定文字列。
- param
-
any[]
返品
string
formatWithOptions(InspectOptions, any, any[])
この関数は、
util.formatWithOptions({ colors: true }, 'See object %O', { foo: 42 });
// Returns 'See object { foo: 42 }', where `42` is colored as a number
// when printed to a terminal.
function formatWithOptions(inspectOptions: InspectOptions, format?: any, param: any[]): stringパラメーター
- inspectOptions
- InspectOptions
- format
-
any
- param
-
any[]
返品
string
generateUUID()
20 文字の uuid を生成します。
function generateUUID(): string返品
string
getCallSites(number, GetCallSitesOptions)
呼び出し元関数のスタックを含む呼び出しサイト オブジェクトの配列を返します。
error.stackへのアクセスとは異なり、この API から返される結果はError.prepareStackTraceに干渉しません。
import { getCallSites } from 'node:util';
function exampleFunction() {
const callSites = getCallSites();
console.log('Call Sites:');
callSites.forEach((callSite, index) => {
console.log(`CallSite ${index + 1}:`);
console.log(`Function Name: ${callSite.functionName}`);
console.log(`Script Name: ${callSite.scriptName}`);
console.log(`Line Number: ${callSite.lineNumber}`);
console.log(`Column Number: ${callSite.columnNumber}`);
});
// CallSite 1:
// Function Name: exampleFunction
// Script Name: /home/example.js
// Line Number: 5
// Column Number: 26
// CallSite 2:
// Function Name: anotherFunction
// Script Name: /home/example.js
// Line Number: 22
// Column Number: 3
// ...
}
// A function to simulate another stack layer
function anotherFunction() {
exampleFunction();
}
anotherFunction();
オプション sourceMap を trueに設定することで、元の場所を再構築することができます。
ソース マップが使用できない場合、元の場所は現在の場所と同じになります。
--enable-source-maps フラグが有効になっている場合、sourceMapは既定で true になります。
import { getCallSites } from 'node:util';
interface Foo {
foo: string;
}
const callSites = getCallSites({ sourceMap: true });
// With sourceMap:
// Function Name: ''
// Script Name: example.js
// Line Number: 7
// Column Number: 26
// Without sourceMap:
// Function Name: ''
// Script Name: example.js
// Line Number: 2
// Column Number: 26
function getCallSites(frameCount?: number, options?: GetCallSitesOptions): CallSiteObject[]パラメーター
- frameCount
-
number
呼び出しサイト オブジェクトとしてキャプチャするフレームの数。
既定値:10。 許容範囲は 1 ~ 200 です。
- options
- GetCallSitesOptions
返品
呼び出しサイト オブジェクトの配列
getCallSites(GetCallSitesOptions)
function getCallSites(options: GetCallSitesOptions): CallSiteObject[]パラメーター
- options
- GetCallSitesOptions
返品
getRandomValue()
乱数を返します。
function getRandomValue(): number返品
number
getSystemErrorMap()
Node.js API から使用可能なすべてのシステム エラー コードのマップを返します。
エラー コードとエラー名の間のマッピングはプラットフォームに依存します。
一般的なエラーの名前については、Common System Errors を参照してください。
fs.access('file/that/does/not/exist', (err) => {
const errorMap = util.getSystemErrorMap();
const name = errorMap.get(err.errno);
console.error(name); // ENOENT
});
function getSystemErrorMap(): Map<number, [string, string]>返品
Map<number, [string, string]>
getSystemErrorMessage(number)
Node.js API から取得された数値エラー コードの文字列メッセージを返します。 エラー コードと文字列メッセージの間のマッピングは、プラットフォームに依存します。
fs.access('file/that/does/not/exist', (err) => {
const message = util.getSystemErrorMessage(err.errno);
console.error(message); // no such file or directory
});
function getSystemErrorMessage(err: number): stringパラメーター
- err
-
number
返品
string
getSystemErrorName(number)
Node.js API から取得された数値エラー コードの文字列名を返します。
エラー コードとエラー名の間のマッピングはプラットフォームに依存します。
一般的なエラーの名前については、Common System Errors を参照してください。
fs.access('file/that/does/not/exist', (err) => {
const name = util.getSystemErrorName(err.errno);
console.error(name); // ENOENT
});
function getSystemErrorName(err: number): stringパラメーター
- err
-
number
返品
string
getTimeDiffInMilliseconds(Date, Date)
2 つの日付間の時間間隔をミリ秒単位で返します。
function getTimeDiffInMilliseconds(start: Date, end: Date): numberパラメーター
- start
-
Date
- end
-
Date
返品
number
inherits(unknown, unknown)
util.inherits() の使用はお勧めしません。 言語レベルの継承のサポートを取得するには、ES6 class と extends キーワードを使用してください。 また、2つのスタイルは意味的に互換性のない
ある コンストラクター から別のコンストラクターにプロトタイプ メソッドを継承します。
constructor のプロトタイプは、superConstructorから作成された新しいオブジェクトに設定されます。
これにより、主に Object.setPrototypeOf(constructor.prototype, superConstructor.prototype)の上にいくつかの入力検証が追加されます。
さらに便利な superConstructor は、constructor.super_ プロパティを通じてアクセスできます。
const util = require('node:util');
const EventEmitter = require('node: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(`Received data: "${data}"`);
});
stream.write('It works!'); // Received data: "It works!"
class と extendsを使用した ES6 の例:
import EventEmitter from 'node:events';
class MyStream extends EventEmitter {
write(data) {
this.emit('data', data);
}
}
const stream = new MyStream();
stream.on('data', (data) => {
console.log(`Received data: "${data}"`);
});
stream.write('With ES6');
function inherits(constructor: unknown, superConstructor: unknown)パラメーター
- constructor
-
unknown
- superConstructor
-
unknown
inspect(any, InspectOptions)
function inspect(object: any, options?: InspectOptions): stringパラメーター
- object
-
any
- options
- InspectOptions
返品
string
isArray(unknown)
警告
この API は非推奨になりました。
Since v4.0.0 - Use isArray instead.
Array.isArray() の別名。
指定した true が objectの場合は、Array を返します。 それ以外の場合は、 falseを返します。
import util from 'node:util';
util.isArray([]);
// Returns: true
util.isArray(new Array());
// Returns: true
util.isArray({});
// Returns: false
function isArray(object: unknown): object is unknown[]パラメーター
- object
-
unknown
返品
object is unknown[]
isCreate(string)
埋め込み型が作成用であるかどうかを確認します
function isCreate(embedType: string): booleanパラメーター
- embedType
-
string
返品
boolean
isDeepStrictEqual(unknown, unknown, IsDeepStrictEqualOptions)
true と val1の間に厳密な等価性が深い場合は、val2 を返します。
それ以外の場合は、 falseを返します。
詳細な厳密な等価性の詳細については、assert.deepStrictEqual() を参照してください。
function isDeepStrictEqual(val1: unknown, val2: unknown, options?: IsDeepStrictEqualOptions): booleanパラメーター
- val1
-
unknown
- val2
-
unknown
- options
- IsDeepStrictEqualOptions
返品
boolean
isRDLEmbed(string)
埋め込み URL が RDL レポート用であるかどうかを確認します。
function isRDLEmbed(embedUrl: string): booleanパラメーター
- embedUrl
-
string
返品
boolean
isSavedInternal(HttpPostMessage, string, Window)
レポートが保存されているかどうかを確認します。
function isSavedInternal(hpm: HttpPostMessage, uid: string, contentWindow: Window): Promise<boolean>パラメーター
- hpm
-
HttpPostMessage
- uid
-
string
- contentWindow
- Window
返品
Promise<boolean>
parseArgs<T>(T)
process.argv を直接操作するよりも、コマンドライン引数の解析に関する高レベルの API を提供します。 予期される引数の指定を受け取り、解析されたオプションと位置指定を持つ構造化オブジェクトを返します。
import { parseArgs } from 'node:util';
const args = ['-f', '--bar', 'b'];
const options = {
foo: {
type: 'boolean',
short: 'f',
},
bar: {
type: 'string',
},
};
const {
values,
positionals,
} = parseArgs({ args, options });
console.log(values, positionals);
// Prints: [Object: null prototype] { foo: true, bar: 'b' } []
function parseArgs<T>(config?: T): ParsedResults<T>パラメーター
- config
-
T
解析の引数を指定し、パーサーを構成するために使用します。
config では、次のプロパティがサポートされています。
返品
ParsedResults<T>
解析されたコマンド ライン引数:
parseEnv(string)
安定性: 1.1 - アクティブな開発 .env ファイルの例を考えると:
import { parseEnv } from 'node:util';
parseEnv('HELLO=world\nHELLO=oh my\n');
// Returns: { HELLO: 'oh my' }
function parseEnv(content: string): Dict<string>パラメーター
- content
-
string
.env ファイルの生の内容。
返品
Dict<string>
promisify<TResult>((callback: (err: any, result: TResult) => void) => void)
function promisify<TResult>(fn: (callback: (err: any, result: TResult) => void) => void): () => Promise<TResult>パラメーター
- fn
-
(callback: (err: any, result: TResult) => void) => void
返品
() => Promise<TResult>
promisify((callback: (err?: any) => void) => void)
function promisify(fn: (callback: (err?: any) => void) => void): () => Promise<void>パラメーター
- fn
-
(callback: (err?: any) => void) => void
返品
() => Promise<void>
promisify<T1, TResult>((arg1: T1, callback: (err: any, result: TResult) => void) => void)
function promisify<T1, TResult>(fn: (arg1: T1, callback: (err: any, result: TResult) => void) => void): (arg1: T1) => Promise<TResult>パラメーター
- fn
-
(arg1: T1, callback: (err: any, result: TResult) => void) => void
返品
(arg1: T1) => Promise<TResult>
promisify<T1>((arg1: T1, callback: (err?: any) => void) => void)
function promisify<T1>(fn: (arg1: T1, callback: (err?: any) => void) => void): (arg1: T1) => Promise<void>パラメーター
- fn
-
(arg1: T1, callback: (err?: any) => void) => void
返品
(arg1: T1) => Promise<void>
promisify<T1, T2, TResult>((arg1: T1, arg2: T2, callback: (err: any, result: TResult) => void) => void)
function promisify<T1, T2, TResult>(fn: (arg1: T1, arg2: T2, callback: (err: any, result: TResult) => void) => void): (arg1: T1, arg2: T2) => Promise<TResult>パラメーター
- fn
-
(arg1: T1, arg2: T2, callback: (err: any, result: TResult) => void) => void
返品
(arg1: T1, arg2: T2) => Promise<TResult>
promisify<T1, T2>((arg1: T1, arg2: T2, callback: (err?: any) => void) => void)
function promisify<T1, T2>(fn: (arg1: T1, arg2: T2, callback: (err?: any) => void) => void): (arg1: T1, arg2: T2) => Promise<void>パラメーター
- fn
-
(arg1: T1, arg2: T2, callback: (err?: any) => void) => void
返品
(arg1: T1, arg2: T2) => Promise<void>
promisify<T1, T2, T3, TResult>((arg1: T1, arg2: T2, arg3: T3, callback: (err: any, result: TResult) => void) => void)
function promisify<T1, T2, T3, TResult>(fn: (arg1: T1, arg2: T2, arg3: T3, callback: (err: any, result: TResult) => void) => void): (arg1: T1, arg2: T2, arg3: T3) => Promise<TResult>パラメーター
- fn
-
(arg1: T1, arg2: T2, arg3: T3, callback: (err: any, result: TResult) => void) => void
返品
(arg1: T1, arg2: T2, arg3: T3) => Promise<TResult>
promisify<T1, T2, T3>((arg1: T1, arg2: T2, arg3: T3, callback: (err?: any) => void) => void)
function promisify<T1, T2, T3>(fn: (arg1: T1, arg2: T2, arg3: T3, callback: (err?: any) => void) => void): (arg1: T1, arg2: T2, arg3: T3) => Promise<void>パラメーター
- fn
-
(arg1: T1, arg2: T2, arg3: T3, callback: (err?: any) => void) => void
返品
(arg1: T1, arg2: T2, arg3: T3) => Promise<void>
promisify<T1, T2, T3, T4, TResult>((arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: (err: any, result: TResult) => void) => void)
function promisify<T1, T2, T3, T4, TResult>(fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: (err: any, result: TResult) => void) => void): (arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise<TResult>パラメーター
- fn
-
(arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: (err: any, result: TResult) => void) => void
返品
(arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise<TResult>
promisify<T1, T2, T3, T4>((arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: (err?: any) => void) => void)
function promisify<T1, T2, T3, T4>(fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: (err?: any) => void) => void): (arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise<void>パラメーター
- fn
-
(arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: (err?: any) => void) => void
返品
(arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise<void>
promisify<T1, T2, T3, T4, T5, TResult>((arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err: any, result: TResult) => void) => void)
function promisify<T1, T2, T3, T4, T5, TResult>(fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err: any, result: TResult) => void) => void): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise<TResult>パラメーター
- fn
-
(arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err: any, result: TResult) => void) => void
返品
(arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise<TResult>
promisify<T1, T2, T3, T4, T5>((arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err?: any) => void) => void)
function promisify<T1, T2, T3, T4, T5>(fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err?: any) => void) => void): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise<void>パラメーター
- fn
-
(arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err?: any) => void) => void
返品
(arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise<void>
promisify(Function)
function promisify(fn: Function): Functionパラメーター
- fn
-
Function
返品
Function
raiseCustomEvent(HTMLElement, string, any)
指定した HTML 要素のイベント データを含むカスタム イベントを発生させます。
function raiseCustomEvent(element: HTMLElement, eventName: string, eventData: any)パラメーター
- element
-
HTMLElement
- eventName
-
string
- eventData
-
any
remove<T>((x: T) => boolean, T[])
function remove<T>(predicate: (x: T) => boolean, xs: T[])パラメーター
- predicate
-
(x: T) => boolean
- xs
-
T[]
setTraceSigInt(boolean)
SIGINTでのスタック トレースの印刷を有効または無効にします。 API はメイン スレッドでのみ使用できます。
function setTraceSigInt(enable: boolean)パラメーター
- enable
-
boolean
stripVTControlCharacters(string)
ANSI エスケープ コードが削除された str を返します。
console.log(util.stripVTControlCharacters('\u001B[4mvalue\u001B[0m'));
// Prints "value"
function stripVTControlCharacters(str: string): stringパラメーター
- str
-
string
返品
string
styleText(InspectColor | Object | (readonly InspectColor | `#${string}`[]), string, StyleTextOptions)
この関数は、ターミナルで印刷するために渡された format を考慮して書式設定されたテキストを返します。 ターミナルの機能を認識し、 NO_COLOR、 NODE_DISABLE_COLORS 、および FORCE_COLOR 環境変数を介して設定された構成に従って動作します。
import { styleText } from 'node:util';
import { stderr } from 'node:process';
const successMessage = styleText('green', 'Success!');
console.log(successMessage);
const errorMessage = styleText(
'red',
'Error! Error!',
// Validate if process.stderr has TTY
{ stream: stderr },
);
console.error(errorMessage);
util.inspect.colors には、italicや underline などのテキスト形式も用意されており、次の両方を組み合わせることができます。
console.log(
util.styleText(['underline', 'italic'], 'My italic underlined message'),
);
書式の配列を渡す場合、適用される書式の順序は左から右に移動するため、次のスタイルによって前のスタイルが上書きされる可能性があります。
console.log(
util.styleText(['red', 'green'], 'text'), // green
);
特殊な書式値 none は、テキストに追加のスタイル設定を適用しません。
定義済みの色名に加えて、 util.styleText() では ANSI TrueColor (24 ビット) エスケープ シーケンスを使用した 16 進色文字列がサポートされます。 16 進数の色は、3 桁 (#RGB) または 6 桁 (#RRGGBB) 形式で指定できます。
import { styleText } from 'node:util';
// 6-digit hex color
console.log(styleText('#ff5733', 'Orange text'));
// 3-digit hex color (shorthand)
console.log(styleText('#f00', 'Red text'));
// Hex color combined with other modifiers
console.log(styleText(['#00f', 'bold'], 'Bold blue text'));
形式の完全な一覧は、
function styleText(format: InspectColor | Object | (readonly InspectColor | `#${string}`[]), text: string, options?: StyleTextOptions): stringパラメーター
- format
-
InspectColor | Object | (readonly InspectColor |
#${string}[])
util.inspect.colorsで定義されたテキスト形式、#RGBまたは#RRGGBB形式の 16 進色、またはテキスト形式や 16 進色の配列。
- text
-
string
書式設定するテキスト。
- options
- StyleTextOptions
返品
string
toUSVString(string)
サロゲート コード ポイント (または同等に、ペアになっていないサロゲート コード 単位) を Unicode の "置換文字" U+FFFD に置き換えた後の string を返します。
function toUSVString(string: string): stringパラメーター
- string
-
string
返品
string
transferableAbortController()
AbortController が転送可能としてマークされ、AbortSignal または structuredClone()で使用できる postMessage() インスタンスを作成して返します。
function transferableAbortController(): AbortController返品
AbortController
転送可能な AbortController
transferableAbortSignal(AbortSignal)
指定された AbortSignal を転送可能としてマークして、structuredClone() および postMessage()で使用できるようにします。
const signal = transferableAbortSignal(AbortSignal.timeout(100));
const channel = new MessageChannel();
channel.port2.postMessage(signal, [signal]);
function transferableAbortSignal(signal: AbortSignal): AbortSignalパラメーター
- signal
-
AbortSignal
The AbortSignal
返品
AbortSignal
同じ AbortSignal
変数の詳細
APINotSupportedForRDLError
APINotSupportedForRDLError: "This API is currently not supported for RDL reports"型
"This API is currently not supported for RDL reports"
EmbedUrlNotSupported
EmbedUrlNotSupported: "Embed URL is invalid for this scenario. Please use Power BI REST APIs to get the valid URL"型
"Embed URL is invalid for this scenario. Please use Power BI REST APIs to get the valid URL"
TextDecoder
TextDecoder: (label?: string, options?: TextDecoderOptions) => TextDecoder型
(label?: string, options?: TextDecoderOptions) => TextDecoder
TextEncoder
TextEncoder: () => TextEncoder型
() => TextEncoder
Document
Document: () => Document型
() => Document
HTMLIFrameElement
HTMLIFrameElement: () => HTMLIFrameElement型
() => HTMLIFrameElement
Window
Window: () => Window型
() => Window
config
config: { type: string, version: string }型
{ type: string, version: string }
invalidEmbedUrlErrorMessage
invalidEmbedUrlErrorMessage: string型
string
hpmFactory
hpmFactory: IHpmFactory型
IHpmFactory
routerFactory
routerFactory: IRouterFactory型
IRouterFactory
wpmpFactory
wpmpFactory: IWpmpFactory型
IWpmpFactory