process.emitWarning(warning[, options])
warning
<string> | <Error> 要触发的警告。options
<Object>type
<string> 当warning
是String
时,type
是用于触发警告的 type 的名称。 默认值:'Warning'
。code
<string> 触发的警告实例的唯一标识符。ctor
<Function> 当warning
为String
时,ctor
是可选函数,用于限制生成的堆栈跟踪。 默认值:process.emitWarning
。detail
<string> 要包含在错误中的额外文本。
process.emitWarning()
方法可用于触发自定义或特定于应用程序的进程警告。
这些可以通过向 'warning'
事件添加句柄来监听。
import { emitWarning } from 'node:process';
// 触发带有代码和其他详细信息的警告。
emitWarning('Something happened!', {
code: 'MY_WARNING',
detail: 'This is some additional information',
});
// 触发:
// (node:56338) [MY_WARNING] Warning: Something happened!
// This is some additional information
const { emitWarning } = require('node:process');
// 触发带有代码和其他详细信息的警告。
emitWarning('Something happened!', {
code: 'MY_WARNING',
detail: 'This is some additional information',
});
// 触发:
// (node:56338) [MY_WARNING] Warning: Something happened!
// This is some additional information
在此示例中,Error
对象由 process.emitWarning()
在内部生成并传给 'warning'
句柄。
import process from 'node:process';
process.on('warning', (warning) => {
console.warn(warning.name); // 'Warning'
console.warn(warning.message); // 'Something happened!'
console.warn(warning.code); // 'MY_WARNING'
console.warn(warning.stack); // Stack trace
console.warn(warning.detail); // 'This is some additional information'
});
const process = require('node:process');
process.on('warning', (warning) => {
console.warn(warning.name); // 'Warning'
console.warn(warning.message); // 'Something happened!'
console.warn(warning.code); // 'MY_WARNING'
console.warn(warning.stack); // Stack trace
console.warn(warning.detail); // 'This is some additional information'
});
如果 warning
作为 Error
对象传入,则忽略 options
参数。
warning
<string> | <Error> The warning to emit.options
<Object>type
<string> Whenwarning
is aString
,type
is the name to use for the type of warning being emitted. Default:'Warning'
.code
<string> A unique identifier for the warning instance being emitted.ctor
<Function> Whenwarning
is aString
,ctor
is an optional function used to limit the generated stack trace. Default:process.emitWarning
.detail
<string> Additional text to include with the error.
The process.emitWarning()
method can be used to emit custom or application
specific process warnings. These can be listened for by adding a handler to the
'warning'
event.
import { emitWarning } from 'node:process';
// Emit a warning with a code and additional detail.
emitWarning('Something happened!', {
code: 'MY_WARNING',
detail: 'This is some additional information',
});
// Emits:
// (node:56338) [MY_WARNING] Warning: Something happened!
// This is some additional information
const { emitWarning } = require('node:process');
// Emit a warning with a code and additional detail.
emitWarning('Something happened!', {
code: 'MY_WARNING',
detail: 'This is some additional information',
});
// Emits:
// (node:56338) [MY_WARNING] Warning: Something happened!
// This is some additional information
In this example, an Error
object is generated internally by
process.emitWarning()
and passed through to the
'warning'
handler.
import process from 'node:process';
process.on('warning', (warning) => {
console.warn(warning.name); // 'Warning'
console.warn(warning.message); // 'Something happened!'
console.warn(warning.code); // 'MY_WARNING'
console.warn(warning.stack); // Stack trace
console.warn(warning.detail); // 'This is some additional information'
});
const process = require('node:process');
process.on('warning', (warning) => {
console.warn(warning.name); // 'Warning'
console.warn(warning.message); // 'Something happened!'
console.warn(warning.code); // 'MY_WARNING'
console.warn(warning.stack); // Stack trace
console.warn(warning.detail); // 'This is some additional information'
});
If warning
is passed as an Error
object, the options
argument is ignored.