Skip to content

Add kuzzleStack property to KuzzleError #620

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 23, 2021
Merged

Add kuzzleStack property to KuzzleError #620

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
004bb25
Add kuzzleStack to error
Mar 21, 2021
8479500
add doc
Mar 23, 2021
d88551d
doc
Mar 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions doc/7/core-classes/kuzzle-error/properties/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,12 @@ order: 10

# Properties

| Property name | Type | Description |
| -------------------- | -------- | --------------------------------------- |
| `message` | <pre>string</pre> | Error message |
| `status` | <pre>number</pre> | Error status code |
| `stack` | <pre>string</pre> | Error stacktrace (only in development mode) |
| `id` | <pre>string</pre> | Error unique identifier |
| `code` | <pre>string</pre> | Error unique code |
| Property name | Type | Description |
|---------------|-------------------|---------------------------------------------------------------------|
| `kuzzleStack` | <pre>string</pre> | Kuzzle stacktrace (only in development mode) |
| `message` | <pre>string</pre> | Error message |
| `status` | <pre>number</pre> | Error status code |
| `stack` | <pre>string</pre> | Complete error stacktrace (Kuzzle + SDK) (only in development mode) |
| `id` | <pre>string</pre> | Error unique identifier |
| `code` | <pre>string</pre> | Error unique code |

12 changes: 7 additions & 5 deletions doc/7/essentials/error-handling/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,13 @@ All SDK methods return a promise, that can be rejected with a `KuzzleError` valu

[KuzzleError](/sdk/js/7/core-classes/kuzzle-error/introduction) objects inherit the standard `Error` object, and add the following properties to it:

| Property | Type | Description |
| -------- | ----------------- | ------------------------------------------------------------------------------------------ |
| `status` | <pre>number</pre> | Status following [HTTP Standards](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) |
| `stack` | <pre>string</pre> | Error stacktrace (Only in development mode) | `id` | <pre>string</pre> | Error unique identifier |
| `code` | <pre>string</pre> | Error unique code |
| Property | Type | Description |
|---------------|-------------------|----------------------------------------------|
| `kuzzleStack` | <pre>string</pre> | Kuzzle stacktrace (only in development mode) |
| `status` | <pre>number</pre> | Error status code |
| `id` | <pre>string</pre> | Error unique identifier |
| `code` | <pre>string</pre> | Error unique code |



You can find a detailed list of possible errors messages and statuses in the [documentation API](/core/2/api/errors/types).
Expand Down
1 change: 1 addition & 0 deletions src/KuzzleError.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ export class KuzzleError extends Error {
// If we have a stacktrace coming from Kuzzle, merge it with
// the SDK one
if (apiError.stack) {
this.kuzzleStack = apiError.stack;
this.stack = apiError.stack + '\n';
this.stack += ' |\n';
this.stack += ' |\n';
Expand Down