global: snapshot

modules/brk-client/docs/classes/BrkError.md

@@ -0,0 +1,65 @@
+[**brk-client**](../README.md)
+
+***
+
+[brk-client](../globals.md) / BrkError
+
+# Class: BrkError
+
+Defined in: [Developer/brk/modules/brk-client/index.js:532](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L532)
+
+Custom error class for BRK client errors
+
+## Extends
+
+- `Error`
+
+## Constructors
+
+### Constructor
+
+> **new BrkError**(`message`, `status?`): `BrkError`
+
+Defined in: [Developer/brk/modules/brk-client/index.js:537](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L537)
+
+#### Parameters
+
+##### message
+
+`string`
+
+##### status?
+
+`number`
+
+#### Returns
+
+`BrkError`
+
+#### Overrides
+
+`Error.constructor`
+
+## Methods
+
+### isError()
+
+> `static` **isError**(`error`): `error is Error`
+
+Defined in: .npm/\_npx/940582f83630445a/node\_modules/typescript/lib/lib.esnext.error.d.ts:23
+
+Indicates whether the argument provided is a built-in Error instance or not.
+
+#### Parameters
+
+##### error
+
+`unknown`
+
+#### Returns
+
+`error is Error`
+
+#### Inherited from
+
+`Error.isError`