@dxos/errors 0.8.4-main.5ea62a8 → 0.8.4-main.60689f5b1c

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,9 +1,11 @@
1
- export type BaseErrorOptions = {
1
+ /**
2
+ * Options for creating a BaseError.
3
+ */
4
+ export type BaseErrorOptions = ErrorOptions & {
2
5
  /**
3
- * The cause of the error.
4
- * An instance of Error.
6
+ * Override base message.
5
7
  */
6
- cause?: unknown;
8
+ message?: string;
7
9
  /**
8
10
  * Structured details about the error.
9
11
  */
@@ -12,52 +14,47 @@ export type BaseErrorOptions = {
12
14
  /**
13
15
  * Base class for all DXOS errors.
14
16
  */
15
- export declare class BaseError<Code extends string = string> extends Error {
16
- #private;
17
+ export declare class BaseError<Name extends string = string> extends Error {
17
18
  /**
18
19
  * Primary way of defining new error classes.
19
- *
20
- * Expample:
21
- *
22
- * ```ts
23
- * export class AiInputPreprocessingError extends BaseError.extend('AI_INPUT_PREPROCESSING_ERROR') {}
24
- * ```
20
+ * Extended class may specialize constructor for required context params.
21
+ * @param name - Error name.
22
+ * @param message - Default error message.
25
23
  */
26
- static extend<Code extends string>(code: Code): {
27
- new (message: string, options?: BaseErrorOptions): {
28
- #code: Code;
29
- #context: Record<string, unknown>;
30
- get name(): Code;
31
- get code(): Code;
32
- get _tag(): Code;
33
- get context(): Record<string, unknown>;
34
- message: string;
35
- stack?: string;
24
+ static extend<Name extends string = string>(name: Name, message?: string): {
25
+ new (options?: BaseErrorOptions): {
36
26
  cause?: unknown;
27
+ stack?: string;
28
+ name: Name;
29
+ context: Record<string, unknown>;
30
+ /** Fallback message. */
31
+ get message(): string;
32
+ get _tag(): Name;
37
33
  };
38
- code: Code;
34
+ isError(error: unknown): error is Error;
35
+ name: Name;
39
36
  is(error: unknown): error is BaseError;
40
- wrap(message: string, options?: Omit<BaseErrorOptions, "cause">): (error: unknown) => {
41
- #code: Code;
42
- #context: Record<string, unknown>;
43
- get name(): Code;
44
- get code(): Code;
45
- get _tag(): Code;
46
- get context(): Record<string, unknown>;
47
- message: string;
48
- stack?: string;
37
+ wrap(options?: Omit<BaseErrorOptions, 'cause'> & {
38
+ ifTypeDiffers?: boolean;
39
+ }): (error: unknown) => {
49
40
  cause?: unknown;
41
+ stack?: string;
42
+ name: Name;
43
+ context: Record<string, unknown>;
44
+ /** Fallback message. */
45
+ get message(): string;
46
+ get _tag(): Name;
50
47
  };
51
- extend<Code extends string>(code: Code): /*elided*/ any;
52
- isError(error: unknown): error is Error;
48
+ extend<Name extends string = string>(name: Name, message?: string): /*elided*/ any;
53
49
  captureStackTrace(targetObject: object, constructorOpt?: Function): void;
54
50
  prepareStackTrace?: ((err: Error, stackTraces: NodeJS.CallSite[]) => any) | undefined;
55
51
  stackTraceLimit: number;
56
52
  };
57
- constructor(code: Code, message: string, options?: BaseErrorOptions);
58
- get name(): Code;
59
- get code(): Code;
60
- get _tag(): Code;
61
- get context(): Record<string, unknown>;
53
+ name: Name;
54
+ context: Record<string, unknown>;
55
+ constructor(name: Name, options?: BaseErrorOptions);
56
+ /** Fallback message. */
57
+ get message(): string;
58
+ get _tag(): Name;
62
59
  }
63
60
  //# sourceMappingURL=base.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../src/base.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC,CAAC;AAEF;;GAEG;AACH,qBAAa,SAAS,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,KAAK;;IAChE;;;;;;;;OAQG;IACH,MAAM,CAAC,MAAM,CAAC,IAAI,SAAS,MAAM,EAAE,IAAI,EAAE,IAAI;sBAYpB,MAAM,YAAY,gBAAgB;;sBAOjD,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;;;;;;;;;;kBAfZ,OAAO,GAAG,KAAK,IAAI,SAAS;sBAIxB,MAAM,YAAY,IAAI,CAAC,gBAAgB,EAAE,OAAO,CAAC,IAC5D,OAAO,OAAO;;sBAUlB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;;;;;;;;;eAnBnB,IAAI,SAAS,MAAM,QAAQ,IAAI;;;;;;gBAqBjC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB;IAQnE,IAAa,IAAI,SAEhB;IAED,IAAI,IAAI,IAAI,IAAI,CAEf;IAGD,IAAI,IAAI,IAAI,IAAI,CAEf;IAED,IAAI,OAAO,4BAEV;CACF"}
1
+ {"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../src/base.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,YAAY,GAAG;IAC5C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC,CAAC;AAEF;;GAEG;AACH,qBAAa,SAAS,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,KAAK;IAChE;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE,MAAM;uBAsB9C,gBAAgB;;;;qBAQjC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;YAgBhC,wBAAwB;;;;;cA5CE,IAAI;kBAET,OAAO,GAAG,KAAK,IAAI,SAAS;uBAKjC,IAAI,CAAC,gBAAgB,EAAE,OAAO,CAAC,GAAG;YAAE,aAAa,CAAC,EAAE,OAAO,CAAA;SAAE,GACtE,CAAC,KAAK,EAAE,OAAO;;;;qBAoBb,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;YAgBhC,wBAAwB;;;SApCgB;eAV1B,IAAI,SAAS,MAAM,iBAAiB,IAAI,YAAY,MAAM;;;;MA0BvE;IAGQ,IAAI,EAAE,IAAI,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEjC,YAAY,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE,gBAAgB,EAYjD;IAED,wBAAwB;IACxB,IAAa,OAAO,WAEnB;IAGD,IAAI,IAAI,IAAI,IAAI,CAEf;CACF"}