tryError API Documentation v0.0.1-alpha.1

---

tryError API Documentation / PluginCapabilities

Interface: PluginCapabilities

Defined in: plugins.ts:56

Plugin capabilities

Properties

config?

optional config: Partial<TryErrorConfig>;

Defined in: plugins.ts:60

Configuration modifications

---

errorTypes?

optional errorTypes: Record<string, (message, context?) => TryError>;

Defined in: plugins.ts:70

Custom error types to register

---

middleware?

optional middleware: ErrorMiddleware[];

Defined in: plugins.ts:65

Middleware to add

---

transformers?

optional transformers: {
  error?: (error) => TryError;
  result?: <T>(result) => TryResult<T>;
};

Defined in: plugins.ts:80

Custom transformers

error()?

optional error: (error) => TryError;

Parameters

error

TryError

Returns

TryError

result()?

optional result: <T>(result) => TryResult<T>;

Type Parameters

T

T

Parameters

result

TryResult<T>

Returns

TryResult<T>

---

utilities?

optional utilities: Record<string, Function>;

Defined in: plugins.ts:75

Custom utilities to expose