#カスタムエラー
Result.fail() でエラーを作成する際、単純な文字列やジェネリックなErrorオブジェクトではなく、カスタムエラーの使用を強くお勧めします。
このガイドでは、カスタムエラーとは何か、なぜ有益なのか、そして効果的に作成する方法を説明します。
#カスタムエラーとは?
カスタムエラーは、ジェネリックなErrorオブジェクトよりも多くの構造とコンテキストを提供する特殊化されたエラークラスです。 一般的に採用されるカスタムエラーには主に2つの形式があります。
#1. カスタムエラークラス(推奨)
カスタムエラークラスは組み込みの Error クラスを継承し、追加の機能を提供する方法です。
import { import Result Result } from '@praha/byethrow';
import { import z z } from 'zod';
class class ValidationError ValidationError extends var Error: ErrorConstructor Error {
public override readonly ValidationError.name: "ValidationError" name = 'ValidationError';
constructor(message: string message : string, options: ErrorOptions | undefined options ?: ErrorOptions) {
super(message: string message , options: ErrorOptions | undefined options );
}
}
// Result.fail()での使用
const const validateEmail: (email: string) => Result.Result<string, ValidationError> validateEmail = (email: string email : string): import Result Result .type Result<T, E> = Result.Success<T> | Result.Failure<E>A union type representing either a success or a failure.
@typeParamT - The type of the Success value.@typeParamE - The type of the Failure value.@exampleimport { Result } from '@praha/byethrow';
const doSomething = (): Result.Result<number, string> => {
return Math.random() > 0.5
? { type: 'Success', value: 10 }
: { type: 'Failure', error: 'Oops' };
};
@categoryCore Types Result <string, class ValidationError ValidationError > => {
return import Result Result .const pipe: <string, Result.Result<string, readonly StandardSchemaV1<Input = unknown, Output = Input>.Issue[]>, Result.Result<string, ValidationError>>(a: string, ab: (a: string) => Result.Result<string, readonly StandardSchemaV1.Issue[]>, bc: (b: Result.Result<string, readonly StandardSchemaV1.Issue[]>) => Result.Result<string, ValidationError>) => Result.Result<string, ValidationError> (+25 overloads) pipe (
email: string email ,
import Result Result .const parse: <z.ZodString>(schema: z.ZodString) => (value: unknown) => Result.Result<string, readonly StandardSchemaV1<Input = unknown, Output = Input>.Issue[]> (+1 overload) parse (import z z .function string(params?: string | z.core.$ZodStringParams): z.ZodString (+1 overload) string ().ZodString.email(params?: string | z.core.$ZodCheckEmailParams): z.ZodString@deprecatedUse z.email() instead. email ()),
import Result Result .const mapError: <Result.Result<string, readonly StandardSchemaV1<Input = unknown, Output = Input>.Issue[]>, ValidationError>(fn: (a: readonly StandardSchemaV1.Issue[]) => ValidationError) => (result: Result.Result<string, readonly StandardSchemaV1.Issue[]>) => Result.Result<string, ValidationError> (+1 overload) mapError ((error: readonly StandardSchemaV1.Issue[] error ) => new constructor ValidationError(message: string, options?: ErrorOptions): ValidationError ValidationError ('Invalid email format', { ErrorOptions.cause?: unknown cause : error: readonly StandardSchemaV1.Issue[] error })),
);
};#2. 識別可能なタグを持つオブジェクト
プレーンなオブジェクトに識別可能なプロパティを持たせる事でエラー型として使用することもできます。
import { import Result Result } from '@praha/byethrow';
import { import z z } from 'zod';
type type ValidationError = {
type: "ValidationError";
message: string;
value: string;
}
ValidationError = {
type: "ValidationError" type : 'ValidationError';
message: string message : string;
value: string value : string;
};
const const validateEmail: (email: string) => Result.Result<string, ValidationError> validateEmail = (email: string email : string): import Result Result .type Result<T, E> = Result.Success<T> | Result.Failure<E>A union type representing either a success or a failure.
@typeParamT - The type of the Success value.@typeParamE - The type of the Failure value.@exampleimport { Result } from '@praha/byethrow';
const doSomething = (): Result.Result<number, string> => {
return Math.random() > 0.5
? { type: 'Success', value: 10 }
: { type: 'Failure', error: 'Oops' };
};
@categoryCore Types Result <string, type ValidationError = {
type: "ValidationError";
message: string;
value: string;
}
ValidationError > => {
return import Result Result .const pipe: <string, Result.Result<string, readonly StandardSchemaV1<Input = unknown, Output = Input>.Issue[]>, Result.Result<string, {
readonly type: "ValidationError";
readonly message: "Invalid email format";
readonly value: string;
}>>(a: string, ab: (a: string) => Result.Result<string, readonly StandardSchemaV1.Issue[]>, bc: (b: Result.Result<string, readonly StandardSchemaV1.Issue[]>) => Result.Result<string, {
readonly type: "ValidationError";
readonly message: "Invalid email format";
readonly value: string;
}>) => Result.Result<...> (+25 overloads)
pipe (
email: string email ,
import Result Result .const parse: <z.ZodString>(schema: z.ZodString) => (value: unknown) => Result.Result<string, readonly StandardSchemaV1<Input = unknown, Output = Input>.Issue[]> (+1 overload) parse (import z z .function string(params?: string | z.core.$ZodStringParams): z.ZodString (+1 overload) string ().ZodString.email(params?: string | z.core.$ZodCheckEmailParams): z.ZodString@deprecatedUse z.email() instead. email ()),
import Result Result .const mapError: <Result.Result<string, readonly StandardSchemaV1<Input = unknown, Output = Input>.Issue[]>, {
readonly type: "ValidationError";
readonly message: "Invalid email format";
readonly value: string;
}>(fn: (a: readonly StandardSchemaV1.Issue[]) => {
readonly type: "ValidationError";
readonly message: "Invalid email format";
readonly value: string;
}) => (result: Result.Result<string, readonly StandardSchemaV1.Issue[]>) => Result.Result<string, {
readonly type: "ValidationError";
readonly message: "Invalid email format";
readonly value: string;
}> (+1 overload)
mapError ((error: readonly StandardSchemaV1.Issue[] error ) => ({
type: "ValidationError" type : 'ValidationError',
message: "Invalid email format" message : 'Invalid email format',
value: string value : email: string email ,
})),
);
};#なぜカスタムエラークラスを使うのか?
どちらのアプローチでも機能しますが、以下の理由からカスタムErrorクラスの使用をお勧めします。
#スタックトレースの利用可能性
カスタムErrorクラスは自動的にスタックトレースをキャプチャするため、デバッグが非常に容易になります。
import { import Result Result } from '@praha/byethrow';
class class DatabaseError DatabaseError extends var Error: ErrorConstructor Error {
public override readonly DatabaseError.name: "DatabaseError" name = 'DatabaseError';
constructor(message: string message : string, options: ErrorOptions | undefined options ?: ErrorOptions) {
super(message: string message , options: ErrorOptions | undefined options );
}
}
const const fetchUser: (id: string) => Result.Result<User, DatabaseError> fetchUser = (id: string id : string): import Result Result .type Result<T, E> = Result.Success<T> | Result.Failure<E>A union type representing either a success or a failure.
@typeParamT - The type of the Success value.@typeParamE - The type of the Failure value.@exampleimport { Result } from '@praha/byethrow';
const doSomething = (): Result.Result<number, string> => {
return Math.random() > 0.5
? { type: 'Success', value: 10 }
: { type: 'Failure', error: 'Oops' };
};
@categoryCore Types Result <type User = {
id: string;
name: string;
}
User , class DatabaseError DatabaseError > => {
try {
// データベース操作...
} catch (function (local var) error: unknown error ) {
// スタックトレースはエラーが発生した正確な場所を示します
return import Result Result .const fail: <DatabaseError>(error: DatabaseError) => Result.Result<never, DatabaseError> (+1 overload) fail (new constructor DatabaseError(message: string, options?: ErrorOptions): DatabaseError DatabaseError ('Failed to fetch user'));
}
};#cause オプションによるエラーチェイン
カスタムErrorクラスは cause オプションをサポートしており、元のエラーコンテキストを保持できます。
import { import Result Result } from '@praha/byethrow';
class class DatabaseError DatabaseError extends var Error: ErrorConstructor Error {
public override readonly DatabaseError.name: "DatabaseError" name = 'DatabaseError';
constructor(message: string message : string, options: ErrorOptions | undefined options ?: ErrorOptions) {
super(message: string message , options: ErrorOptions | undefined options );
}
}
const const fetchUser: (id: string) => Result.Result<User, DatabaseError> fetchUser = (id: string id : string): import Result Result .type Result<T, E> = Result.Success<T> | Result.Failure<E>A union type representing either a success or a failure.
@typeParamT - The type of the Success value.@typeParamE - The type of the Failure value.@exampleimport { Result } from '@praha/byethrow';
const doSomething = (): Result.Result<number, string> => {
return Math.random() > 0.5
? { type: 'Success', value: 10 }
: { type: 'Failure', error: 'Oops' };
};
@categoryCore Types Result <type User = {
id: string;
name: string;
}
User , class DatabaseError DatabaseError > => {
try {
// データベース操作...
} catch (function (local var) error: unknown error ) {
// 元のエラーをcauseとして保持
return import Result Result .const fail: <DatabaseError>(error: DatabaseError) => Result.Result<never, DatabaseError> (+1 overload) fail (new constructor DatabaseError(message: string, options?: ErrorOptions): DatabaseError DatabaseError ('Failed to fetch user', {
ErrorOptions.cause?: unknown cause : function (local var) error: unknown error
}));
}
};#推奨:@praha/error-factory を使用する
カスタムエラークラスを効率的に作成するために、@praha/error-factory の使用をお勧めします。
このライブラリはボイラープレートコードを削減し、一貫したエラー構造を保証します。
#インストール
npm install @praha/error-factoryyarn add @praha/error-factorypnpm add @praha/error-factorybun add @praha/error-factorydeno add npm:@praha/error-factory#Resultとの基本的な使い方
まず、必要なカスタムエラーを定義します。
import { const ErrorFactory: {
<Name extends string, Message extends string, Fields extends ErrorFields>(props: {
name: Name;
message: Message | ((fields: Fields) => Message);
fields?: Fields;
}): ErrorConstructor<Name, Message, Fields>;
fields<Fields extends ErrorFields>(): Fields;
}
ErrorFactory } from '@praha/error-factory';
class class ValidationError ValidationError extends ErrorFactory<"ValidationError", "Invalid input provided", ErrorFields>(props: {
name: "ValidationError";
message: "Invalid input provided" | ((fields: ErrorFields) => "Invalid input provided");
fields?: ErrorFields | undefined;
}): (new (options?: ErrorOptions) => Error & Readonly<{
name: "ValidationError";
message: "Invalid input provided";
}>) & {
name: "ValidationError";
}
ErrorFactory ({
name: "ValidationError" name : 'ValidationError',
message: "Invalid input provided" | ((fields: ErrorFields) => "Invalid input provided") message : 'Invalid input provided',
}) {}
class class QueryError QueryError extends ErrorFactory<"QueryError", "An error occurred while executing a query", {
query: string;
}>(props: {
name: "QueryError";
message: "An error occurred while executing a query" | ((fields: {
query: string;
}) => "An error occurred while executing a query");
fields?: {
query: string;
} | undefined;
}): (new (options: ErrorOptions & {
query: string;
}) => Error & Readonly<{
name: "QueryError";
message: "An error occurred while executing a query";
}> & Readonly<{
query: string;
}>) & {
name: "QueryError";
}
ErrorFactory ({
name: "QueryError" name : 'QueryError',
message: "An error occurred while executing a query" | ((fields: {
query: string;
}) => "An error occurred while executing a query")
message : 'An error occurred while executing a query',
fields?: {
query: string;
} | undefined
fields : const ErrorFactory: {
<Name extends string, Message extends string, Fields extends ErrorFields>(props: {
name: Name;
message: Message | ((fields: Fields) => Message);
fields?: Fields;
}): ErrorConstructor<Name, Message, Fields>;
fields<Fields extends ErrorFields>(): Fields;
}
ErrorFactory .fields<{
query: string;
}>(): {
query: string;
}
fields <{ query: string query : string }>(),
}) {}
class class NotFoundError NotFoundError extends ErrorFactory<"NotFoundError", "Resource not found", ErrorFields>(props: {
name: "NotFoundError";
message: "Resource not found" | ((fields: ErrorFields) => "Resource not found");
fields?: ErrorFields | undefined;
}): (new (options?: ErrorOptions) => Error & Readonly<{
name: "NotFoundError";
message: "Resource not found";
}>) & {
name: "NotFoundError";
}
ErrorFactory ({
name: "NotFoundError" name : 'NotFoundError',
message: "Resource not found" | ((fields: ErrorFields) => "Resource not found") message : 'Resource not found',
}) {}次に、先ほど定義したカスタムエラーと Result を一緒に返す関数を作成します。
import { import Result Result } from '@praha/byethrow';
import { import z z } from 'zod';
// Result操作でカスタムエラーを使用
const const validateId: (id: string) => Result.Result<string, ValidationError> validateId = (id: string id : string) => {
return import Result Result .const pipe: <string, Result.Result<string, readonly StandardSchemaV1<Input = unknown, Output = Input>.Issue[]>, Result.Result<string, ValidationError>>(a: string, ab: (a: string) => Result.Result<string, readonly StandardSchemaV1.Issue[]>, bc: (b: Result.Result<string, readonly StandardSchemaV1.Issue[]>) => Result.Result<string, ValidationError>) => Result.Result<string, ValidationError> (+25 overloads) pipe (
id: string id ,
import Result Result .const parse: <z.ZodString>(schema: z.ZodString) => (value: unknown) => Result.Result<string, readonly StandardSchemaV1<Input = unknown, Output = Input>.Issue[]> (+1 overload) parse (import z z .function string(params?: string | z.core.$ZodStringParams): z.ZodString (+1 overload) string ()._ZodString<$ZodStringInternals<string>>.startsWith(value: string, params?: string | z.core.$ZodCheckStartsWithParams): z.ZodString startsWith ('u')),
import Result Result .const mapError: <Result.Result<string, readonly StandardSchemaV1<Input = unknown, Output = Input>.Issue[]>, ValidationError>(fn: (a: readonly StandardSchemaV1.Issue[]) => ValidationError) => (result: Result.Result<string, readonly StandardSchemaV1.Issue[]>) => Result.Result<string, ValidationError> (+1 overload) mapError ((error: readonly StandardSchemaV1.Issue[] error ) => new constructor ValidationError(options?: ErrorOptions): ValidationError ValidationError ({ ErrorOptions.cause?: unknown cause : error: readonly StandardSchemaV1.Issue[] error })),
);
};
const const executeQuery: (sql: string) => Result.ResultAsync<QueryResult, QueryError> executeQuery = (sql: string sql : string) => {
return import Result Result .try<() => Promise<QueryResult>, QueryError>(options: {
try: () => Promise<QueryResult>;
catch: (error: unknown) => QueryError;
}): Result.ResultAsync<QueryResult, QueryError> (+3 overloads)
export try
Executes a function that may throw and wraps the result in a
Result
or
ResultAsync
.
You can use either a custom catch handler or rely on the safe: true option
to assume the function cannot throw.
@function@typeParamT - The function type to execute (sync or async) or a Promise type.@typeParamE - The error type to return if catch is used.@returnsA Result or ResultAsync wrapping the function's return value or the caught error.@exampleSync try-catch
import { Result } from '@praha/byethrow';
const result = Result.try({
try: () => {
const x = Math.random() * 10 - 5;
if (x < 0) throw new Error('Negative!');
return x * 2;
},
catch: (error) => new Error('Oops!', { cause: error }),
});
// result is Result<number, Error>
@exampleSync safe
import { Result } from '@praha/byethrow';
const result = Result.try({
safe: true,
try: () => Math.random() + 1,
});
// result is Result<number, never>
@exampleAsync try-catch
import { Result } from '@praha/byethrow';
const result = Result.try({
try: () => fetch('/api/data'),
catch: (error) => new Error('Fetch failed', { cause: error }),
});
// result is ResultAsync<Response, Error>
@exampleAsync safe
import { Result } from '@praha/byethrow';
const result = Result.try({
safe: true,
try: () => Promise.resolve('ok'),
});
// result is ResultAsync<string, never>
@categoryCreators try ({
try: () => Promise<QueryResult> try : () => const database: {
query: (sql: string) => Promise<QueryResult>;
}
database .query: (sql: string) => Promise<QueryResult> query (sql: string sql ),
catch: (error: unknown) => QueryError catch : (error: unknown error ) => new constructor QueryError(options: ErrorOptions & {
query: string;
}): QueryError
QueryError ({ query: string query : sql: string sql , ErrorOptions.cause?: unknown cause : error: unknown error }),
});
};
// すべてを組み合わせる
const const findUser: (id: string) => Result.ResultAsync<{
readonly id: string;
readonly name: string;
}, ValidationError | QueryError | NotFoundError>
findUser = (id: string id : string) => {
return import Result Result .const pipe: <Result.Result<string, ValidationError>, Result.ResultAsync<QueryResult, ValidationError | QueryError>, Result.ResultAsync<{
readonly id: string;
readonly name: string;
}, ValidationError | QueryError | NotFoundError>>(a: Result.Result<string, ValidationError>, ab: (a: Result.Result<string, ValidationError>) => Result.ResultAsync<QueryResult, ValidationError | QueryError>, bc: (b: Result.ResultAsync<...>) => Result.ResultAsync<...>) => Result.ResultAsync<...> (+25 overloads)
pipe (
const validateId: (id: string) => Result.Result<string, ValidationError> validateId (id: string id ),
import Result Result .const andThen: <Result.Result<string, ValidationError>, Result.ResultAsync<QueryResult, QueryError>>(fn: (a: string) => Result.ResultAsync<QueryResult, QueryError>) => (result: Result.Result<string, ValidationError>) => Result.ResultAsync<QueryResult, ValidationError | QueryError> (+1 overload) andThen ((id: string id ) => const executeQuery: (sql: string) => Result.ResultAsync<QueryResult, QueryError> executeQuery (`SELECT * FROM users WHERE id = '${id: string id }'`)),
import Result Result .const andThen: <Result.ResultAsync<QueryResult, ValidationError | QueryError>, Result.Failure<NotFoundError> | Result.Success<{
readonly id: string;
readonly name: string;
}>>(fn: (a: QueryResult) => Result.Failure<NotFoundError> | Result.Success<{
readonly id: string;
readonly name: string;
}>) => (result: Result.ResultAsync<QueryResult, ValidationError | QueryError>) => Result.ResultAsync<...> (+1 overload)
andThen ((row: QueryResult row ) => {
if (!row: QueryResult row ) {
return import Result Result .const fail: <NotFoundError>(error: NotFoundError) => Result.Result<never, NotFoundError> (+1 overload) fail (new constructor NotFoundError(options?: ErrorOptions): NotFoundError NotFoundError ());
}
return import Result Result .const succeed: <{
readonly id: string;
readonly name: string;
}>(value: {
readonly id: string;
readonly name: string;
}) => Result.Result<{
readonly id: string;
readonly name: string;
}, never> (+1 overload)
succeed ({ id: string id : row: QueryResult row .string id , name: string name : row: QueryResult row .string name });
}),
);
};最後に、関数を実行して適切にハンドリングします。
// 実行してエラーをハンドリング
const const result: Result.Result<{
readonly id: string;
readonly name: string;
}, ValidationError | QueryError | NotFoundError>
result = await const findUser: (id: string) => Result.ResultAsync<{
readonly id: string;
readonly name: string;
}, ValidationError | QueryError | NotFoundError>
findUser ('u123');
if (import Result Result .const isSuccess: <{
readonly id: string;
readonly name: string;
}>(result: Result.Result<{
readonly id: string;
readonly name: string;
}, unknown>) => result is Result.Success<{
readonly id: string;
readonly name: string;
}>
Type guard to check if a
Result
is a
Success
.
@function@typeParamT - The type of the success value.@paramresult - The Result to check.@returnstrue if the result is a Success, otherwise false.@exampleimport { Result } from '@praha/byethrow';
const result: Result.Result<number, string> = { type: 'Success', value: 10 };
if (Result.isSuccess(result)) {
console.log(result.value); // Safe access to value
}
@categoryType Guards isSuccess (const result: Result.Result<{
readonly id: string;
readonly name: string;
}, ValidationError | QueryError | NotFoundError>
result )) {
var console: ConsoleThe console module provides a simple debugging console that is similar to the
JavaScript console mechanism provided by web browsers.
The module exports two specific components:
- A
Console class with methods such as console.log(), console.error() and console.warn() that can be used to write to any Node.js stream.
- A global
console instance configured to write to process.stdout and
process.stderr. The global console can be used without importing the node:console module.
Warning: The global console object's methods are neither consistently
synchronous like the browser APIs they resemble, nor are they consistently
asynchronous like all other Node.js streams. See the note on process I/O for
more information.
Example using the global console:
console.log('hello world');
// Prints: hello world, to stdout
console.log('hello %s', 'world');
// Prints: hello world, to stdout
console.error(new Error('Whoops, something bad happened'));
// Prints error message and stack trace to stderr:
// Error: Whoops, something bad happened
// at [eval]:5:15
// at Script.runInThisContext (node:vm:132:18)
// at Object.runInThisContext (node:vm:309:38)
// at node:internal/process/execution:77:19
// at [eval]-wrapper:6:22
// at evalScript (node:internal/process/execution:76:60)
// at node:internal/main/eval_string:23:3
const name = 'Will Robinson';
console.warn(`Danger ${name}! Danger!`);
// Prints: Danger Will Robinson! Danger!, to stderr
Example using the Console class:
const out = getStreamSomehow();
const err = getStreamSomehow();
const myConsole = new console.Console(out, err);
myConsole.log('hello world');
// Prints: hello world, to out
myConsole.log('hello %s', 'world');
// Prints: hello world, to out
myConsole.error(new Error('Whoops, something bad happened'));
// Prints: [Error: Whoops, something bad happened], to err
const name = 'Will Robinson';
myConsole.warn(`Danger ${name}! Danger!`);
// Prints: Danger Will Robinson! Danger!, to err
@seesource console .Console.log(message?: any, ...optionalParams: any[]): void (+1 overload)Prints to stdout with newline. Multiple arguments can be passed, with the
first used as the primary message and all additional used as substitution
values similar to printf(3)
(the arguments are all passed to util.format()).
const count = 5;
console.log('count: %d', count);
// Prints: count: 5, to stdout
console.log('count:', count);
// Prints: count: 5, to stdout
See util.format() for more information.
@sincev0 .1.100 log (const result: Result.Success<{
readonly id: string;
readonly name: string;
}>
result .value: {
readonly id: string;
readonly name: string;
}
value );
} else {
// 各エラータイプを個別にハンドリング
switch (const result: Result.Failure<ValidationError | QueryError | NotFoundError> result .error: ValidationError | QueryError | NotFoundError error .Error.name: "ValidationError" | "QueryError" | "NotFoundError" name ) {
case 'ValidationError':
var console: ConsoleThe console module provides a simple debugging console that is similar to the
JavaScript console mechanism provided by web browsers.
The module exports two specific components:
- A
Console class with methods such as console.log(), console.error() and console.warn() that can be used to write to any Node.js stream.
- A global
console instance configured to write to process.stdout and
process.stderr. The global console can be used without importing the node:console module.
Warning: The global console object's methods are neither consistently
synchronous like the browser APIs they resemble, nor are they consistently
asynchronous like all other Node.js streams. See the note on process I/O for
more information.
Example using the global console:
console.log('hello world');
// Prints: hello world, to stdout
console.log('hello %s', 'world');
// Prints: hello world, to stdout
console.error(new Error('Whoops, something bad happened'));
// Prints error message and stack trace to stderr:
// Error: Whoops, something bad happened
// at [eval]:5:15
// at Script.runInThisContext (node:vm:132:18)
// at Object.runInThisContext (node:vm:309:38)
// at node:internal/process/execution:77:19
// at [eval]-wrapper:6:22
// at evalScript (node:internal/process/execution:76:60)
// at node:internal/main/eval_string:23:3
const name = 'Will Robinson';
console.warn(`Danger ${name}! Danger!`);
// Prints: Danger Will Robinson! Danger!, to stderr
Example using the Console class:
const out = getStreamSomehow();
const err = getStreamSomehow();
const myConsole = new console.Console(out, err);
myConsole.log('hello world');
// Prints: hello world, to out
myConsole.log('hello %s', 'world');
// Prints: hello world, to out
myConsole.error(new Error('Whoops, something bad happened'));
// Prints: [Error: Whoops, something bad happened], to err
const name = 'Will Robinson';
myConsole.warn(`Danger ${name}! Danger!`);
// Prints: Danger Will Robinson! Danger!, to err
@seesource console .Console.error(message?: any, ...optionalParams: any[]): void (+1 overload)Prints to stderr with newline. Multiple arguments can be passed, with the
first used as the primary message and all additional used as substitution
values similar to printf(3)
(the arguments are all passed to util.format()).
const code = 5;
console.error('error #%d', code);
// Prints: error #5, to stderr
console.error('error', code);
// Prints: error 5, to stderr
If formatting elements (e.g. %d) are not found in the first string then
util.inspect() is called on each argument and the
resulting string values are concatenated. See util.format()
for more information.
@sincev0 .1.100 error ('Validation error:', const result: Result.Failure<ValidationError | QueryError | NotFoundError> result .error: ValidationError error .Error.message: "Invalid input provided" message );
break;
case 'QueryError':
var console: ConsoleThe console module provides a simple debugging console that is similar to the
JavaScript console mechanism provided by web browsers.
The module exports two specific components:
- A
Console class with methods such as console.log(), console.error() and console.warn() that can be used to write to any Node.js stream.
- A global
console instance configured to write to process.stdout and
process.stderr. The global console can be used without importing the node:console module.
Warning: The global console object's methods are neither consistently
synchronous like the browser APIs they resemble, nor are they consistently
asynchronous like all other Node.js streams. See the note on process I/O for
more information.
Example using the global console:
console.log('hello world');
// Prints: hello world, to stdout
console.log('hello %s', 'world');
// Prints: hello world, to stdout
console.error(new Error('Whoops, something bad happened'));
// Prints error message and stack trace to stderr:
// Error: Whoops, something bad happened
// at [eval]:5:15
// at Script.runInThisContext (node:vm:132:18)
// at Object.runInThisContext (node:vm:309:38)
// at node:internal/process/execution:77:19
// at [eval]-wrapper:6:22
// at evalScript (node:internal/process/execution:76:60)
// at node:internal/main/eval_string:23:3
const name = 'Will Robinson';
console.warn(`Danger ${name}! Danger!`);
// Prints: Danger Will Robinson! Danger!, to stderr
Example using the Console class:
const out = getStreamSomehow();
const err = getStreamSomehow();
const myConsole = new console.Console(out, err);
myConsole.log('hello world');
// Prints: hello world, to out
myConsole.log('hello %s', 'world');
// Prints: hello world, to out
myConsole.error(new Error('Whoops, something bad happened'));
// Prints: [Error: Whoops, something bad happened], to err
const name = 'Will Robinson';
myConsole.warn(`Danger ${name}! Danger!`);
// Prints: Danger Will Robinson! Danger!, to err
@seesource console .Console.error(message?: any, ...optionalParams: any[]): void (+1 overload)Prints to stderr with newline. Multiple arguments can be passed, with the
first used as the primary message and all additional used as substitution
values similar to printf(3)
(the arguments are all passed to util.format()).
const code = 5;
console.error('error #%d', code);
// Prints: error #5, to stderr
console.error('error', code);
// Prints: error 5, to stderr
If formatting elements (e.g. %d) are not found in the first string then
util.inspect() is called on each argument and the
resulting string values are concatenated. See util.format()
for more information.
@sincev0 .1.100 error ('Query error:', const result: Result.Failure<ValidationError | QueryError | NotFoundError> result .error: QueryError error .Error.message: "An error occurred while executing a query" message , 'Query:', const result: Result.Failure<ValidationError | QueryError | NotFoundError> result .error: QueryError error .query: string query );
break;
case 'NotFoundError':
var console: ConsoleThe console module provides a simple debugging console that is similar to the
JavaScript console mechanism provided by web browsers.
The module exports two specific components:
- A
Console class with methods such as console.log(), console.error() and console.warn() that can be used to write to any Node.js stream.
- A global
console instance configured to write to process.stdout and
process.stderr. The global console can be used without importing the node:console module.
Warning: The global console object's methods are neither consistently
synchronous like the browser APIs they resemble, nor are they consistently
asynchronous like all other Node.js streams. See the note on process I/O for
more information.
Example using the global console:
console.log('hello world');
// Prints: hello world, to stdout
console.log('hello %s', 'world');
// Prints: hello world, to stdout
console.error(new Error('Whoops, something bad happened'));
// Prints error message and stack trace to stderr:
// Error: Whoops, something bad happened
// at [eval]:5:15
// at Script.runInThisContext (node:vm:132:18)
// at Object.runInThisContext (node:vm:309:38)
// at node:internal/process/execution:77:19
// at [eval]-wrapper:6:22
// at evalScript (node:internal/process/execution:76:60)
// at node:internal/main/eval_string:23:3
const name = 'Will Robinson';
console.warn(`Danger ${name}! Danger!`);
// Prints: Danger Will Robinson! Danger!, to stderr
Example using the Console class:
const out = getStreamSomehow();
const err = getStreamSomehow();
const myConsole = new console.Console(out, err);
myConsole.log('hello world');
// Prints: hello world, to out
myConsole.log('hello %s', 'world');
// Prints: hello world, to out
myConsole.error(new Error('Whoops, something bad happened'));
// Prints: [Error: Whoops, something bad happened], to err
const name = 'Will Robinson';
myConsole.warn(`Danger ${name}! Danger!`);
// Prints: Danger Will Robinson! Danger!, to err
@seesource console .Console.error(message?: any, ...optionalParams: any[]): void (+1 overload)Prints to stderr with newline. Multiple arguments can be passed, with the
first used as the primary message and all additional used as substitution
values similar to printf(3)
(the arguments are all passed to util.format()).
const code = 5;
console.error('error #%d', code);
// Prints: error #5, to stderr
console.error('error', code);
// Prints: error 5, to stderr
If formatting elements (e.g. %d) are not found in the first string then
util.inspect() is called on each argument and the
resulting string values are concatenated. See util.format()
for more information.
@sincev0 .1.100 error ('Not found error:', const result: Result.Failure<ValidationError | QueryError | NotFoundError> result .error: NotFoundError error .Error.message: "Resource not found" message );
break;
}
}