feat: check helper for base error

Author: tada5hi

packages/ebec/src/check.ts

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2026.
+ *  Author Peter Placzek (tada5hi)
+ *  For the full copyright and license information,
+ *  view the LICENSE file that was distributed with this source code.
+ */
+import { isOptions } from './options';
+import { isObject } from './utils';
+import { BaseError } from './module';
+
+export function isBaseError(
+    input: unknown,
+): input is BaseError {
+    if (!isObject(input)) {
+        return false;
+    }
+
+    if (input instanceof BaseError) {
+        return true;
+    }
+
+    if (!isOptions(input)) {
+        return false;
+    }
+
+    if (!isObject(input.data)) {
+        return false;
+    }
+
+    return typeof input.message === 'string';
+}

packages/ebec/src/index.ts

@@ -1,3 +1,12 @@
+/*
+ * Copyright (c) 2026.
+ *  Author Peter Placzek (tada5hi)
+ *  For the full copyright and license information,
+ *  view the LICENSE file that was distributed with this source code.
+ */
+
 export * from './types';
+export * from './check';
 export * from './module';
-export * from './helpers';
+export * from './options';
+export * from './utils';

packages/ebec/src/module.ts

@@ -1,37 +1,43 @@
-import type { Input } from './types';
+/*
+ * Copyright (c) 2026.
+ *  Author Peter Placzek (tada5hi)
+ *  For the full copyright and license information,
+ *  view the LICENSE file that was distributed with this source code.
+ */
+
+import type { ErrorInput, ObjectLiteral } from './types';
 import {
     extractOptions,
-    isOptions,
-} from './helpers';
+} from './options';
 
 export class BaseError extends Error {
     /**
      * A unique identifier for the error,
      * which can be a short uppercase string or a numeric code.
      */
-    code?: string | number | null;
+    readonly code?: string | number | null;
 
     /**
      * Additional data associated with the error. This property can hold
      * unstructured information or supplementary details that provide context
      * to the error.
      */
-    data?: unknown;
+    readonly data: ObjectLiteral;
 
     /**
      * Determines whether the error message can be safely exposed externally.
      */
-    expose?: boolean;
+    readonly expose?: boolean;
 
     /**
      * Indicates whether the error should be logged in the application's logs.
      */
-    logMessage?: boolean;
+    readonly logMessage?: boolean;
 
     /**
      * Specifies the log level at which this error should be recorded.
      */
-    logLevel?: string | number;
+    readonly logLevel?: string | number;
 
     /**
      * Represents the underlying cause or source of the error.
@@ -40,7 +46,7 @@ export class BaseError extends Error {
 
     //--------------------------------------------------------------------
 
-    constructor(...input: Input[]) {
+    constructor(...input: ErrorInput[]) {
         const options = extractOptions(...input);
 
         super(options.message, { cause: options.cause });
@@ -67,16 +73,6 @@ export class BaseError extends Error {
         this.expose = options.expose;
         this.logMessage = options.logMessage;
         this.logLevel = options.logLevel;
-        this.data = options.data;
+        this.data = options.data || {};
     }
 }
-
-export function isBaseError(
-    input: unknown,
-): input is BaseError {
-    if (!isOptions(input)) {
-        return false;
-    }
-
-    return typeof input.message === 'string';
-}

packages/ebec/src/helpers/check.ts packages/ebec/src/options/check.tspackages/ebec/src/helpers/check.ts renamed to packages/ebec/src/options/check.ts

@@ -5,7 +5,7 @@
  *  view the LICENSE file that was distributed with this source code.
  */
 
-import { isObject } from './object';
+import { isObject } from '../utils/object';
 
 export function isError(input: unknown) : input is Error & { [key: string]: any } {
     if (!isObject(input)) {

packages/ebec/src/options/index.ts

@@ -0,0 +1,10 @@
+/*
+ * Copyright (c) 2026.
+ *  Author Peter Placzek (tada5hi)
+ *  For the full copyright and license information,
+ *  view the LICENSE file that was distributed with this source code.
+ */
+
+export * from './check';
+export * from './module';
+export * from './types';

packages/ebec/src/helpers/options.ts packages/ebec/src/options/module.tspackages/ebec/src/helpers/options.ts renamed to packages/ebec/src/options/module.ts

@@ -7,13 +7,14 @@
 
 import {
     isObject,
-} from './object';
-import type { Input, Options } from '../types';
+} from '../utils';
+import type { ErrorInput } from '../types';
 import { isError } from './check';
+import type { Options } from './types';
 
 type CheckFn<T> = (input: unknown) => input is T;
 export function createExtractOptionsFn<T extends Options>(fn: CheckFn<T>) {
-    return (...input: Input[]) : T => {
+    return (...input: ErrorInput[]) : T => {
         const output : T = {} as T;
         for (let i = 0; i < input.length; i++) {
             const element = input[i];
@@ -92,6 +93,6 @@ export function isOptions(input: unknown) : input is Options {
 }
 
 const check = createExtractOptionsFn(isOptions);
-export function extractOptions(...input: Input[]) {
+export function extractOptions(...input: ErrorInput[]) {
     return check(...input);
 }

packages/ebec/src/options/types.ts

@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) 2026.
+ *  Author Peter Placzek (tada5hi)
+ *  For the full copyright and license information,
+ *  view the LICENSE file that was distributed with this source code.
+ */
+import type { ObjectLiteral } from '../types';
+
+export type Options = {
+    /**
+     * The actual error message, if not provided on another way.
+     */
+    message?: string,
+
+    /**
+     * Trace of which functions were called.
+     */
+    stack?: string
+
+    /**
+     * A unique identifier for the error,
+     * which can be a short uppercase string or a numeric code.
+     */
+    code?: string | number | null,
+
+    /**
+     * Additional data associated with the error. This property can hold
+     * unstructured information or supplementary details that provide context
+     * to the error.
+     */
+    data?: ObjectLiteral,
+
+    /**
+     * Determines whether the error message can be safely exposed externally.
+     */
+    expose?: boolean;
+
+    /**
+     * Indicates whether the error should be logged in the application's logs.
+     */
+    logMessage?: boolean,
+
+    /**
+     * Specifies the log level at which this error should be recorded.
+     */
+    logLevel?: string | number,
+
+    /**
+     * Represents the underlying cause or source of the error.
+     */
+    cause?: unknown
+};

packages/ebec/src/types.ts

@@ -1,46 +1,12 @@
-export type Options = {
-    /**
-     * The actual error message, if not provided on another way.
-     */
-    message?: string,
+/*
+ * Copyright (c) 2026.
+ *  Author Peter Placzek (tada5hi)
+ *  For the full copyright and license information,
+ *  view the LICENSE file that was distributed with this source code.
+ */
 
-    /**
-     * Trace of which functions were called.
-     */
-    stack?: string
+import type { Options } from './options';
 
-    /**
-     * A unique identifier for the error,
-     * which can be a short uppercase string or a numeric code.
-     */
-    code?: string | number | null,
+export type ObjectLiteral = Record<PropertyKey, any>;
 
-    /**
-     * Additional data associated with the error. This property can hold
-     * unstructured information or supplementary details that provide context
-     * to the error.
-     */
-    data?: unknown,
-
-    /**
-     * Determines whether the error message can be safely exposed externally.
-     */
-    expose?: boolean;
-
-    /**
-     * Indicates whether the error should be logged in the application's logs.
-     */
-    logMessage?: boolean,
-
-    /**
-     * Specifies the log level at which this error should be recorded.
-     */
-    logLevel?: string | number,
-
-    /**
-     * Represents the underlying cause or source of the error.
-     */
-    cause?: unknown
-};
-
-export type Input = Options | Error | string;
+export type ErrorInput = Options | Error | string;

packages/ebec/src/helpers/index.ts packages/ebec/src/utils/index.tspackages/ebec/src/helpers/index.ts renamed to packages/ebec/src/utils/index.ts

@@ -5,6 +5,4 @@
  *  view the LICENSE file that was distributed with this source code.
  */
 
-export * from './check';
 export * from './object';
-export * from './options';