https://github.com/jesusgraterol/error-message-utils
The error-message-utils package simplifies error management in your web applications and RESTful APIs. It ensures consistent and scalable handling of error messages, saving you time and effort. Moreover, it gives you the ability to assign custom error codes so all possible cases can be handled accordingly.
https://github.com/jesusgraterol/error-message-utils
decoder encoder error error-decoder error-encoder error-handling error-management error-utilities error-utils standard-error stderr utilities utils
Last synced: 6 months ago
JSON representation
The error-message-utils package simplifies error management in your web applications and RESTful APIs. It ensures consistent and scalable handling of error messages, saving you time and effort. Moreover, it gives you the ability to assign custom error codes so all possible cases can be handled accordingly.
- Host: GitHub
- URL: https://github.com/jesusgraterol/error-message-utils
- Owner: jesusgraterol
- License: mit
- Created: 2024-05-06T15:34:00.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-03T15:20:28.000Z (10 months ago)
- Last Synced: 2025-03-29T04:02:57.757Z (7 months ago)
- Topics: decoder, encoder, error, error-decoder, error-encoder, error-handling, error-management, error-utilities, error-utils, standard-error, stderr, utilities, utils
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/error-message-utils
- Size: 427 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Error Message Utils
The `error-message-utils` package simplifies error management in your web applications and RESTful APIs. It ensures consistent and scalable handling of error messages, saving you time and effort. Moreover, it gives you the ability to assign custom error codes so all possible cases can be handled accordingly.
## Getting Started
Install the package:
```bash
npm install -S error-message-utils
```
### Examples
Encoding an error:
```typescript
import { encodeError } from 'error-message-utils';
if (emailExists()) {
throw new Error(encodeError(
'The provided email is already in use.',
'EMAIL_EXISTS'
));
// 'The provided email is already in use.{(EMAIL_EXISTS)}'
}
```
Decoding an error:
```typescript
import { decodeError } from 'error-message-utils';
decodeError('The provided email is already in use.{(EMAIL_EXISTS)}');
// {
// message: 'The provided email is already in use.',
// code: 'EMAIL_EXISTS'
// }
```
Error messages can be extracted recursively from complex structures, including nested `cause` data properties from `Error` instances:
```typescript
import { extractMessage } from 'error-message-utils';
extractMessage(new Error('Top level error', {
cause: new Error('First nested cause', {
cause: new Error('Second nested cause'),
}),
}));
// 'Top level error; [CAUSE]: First nested cause; [CAUSE]: Second nested cause'
extractMessage({
message: {
err: {
message: 'This error message is nested deeply!'
}
}
});
// 'This error message is nested deeply!'
```
Identifying encoded errors:
```typescript
import { isEncodedError, encodeError } from 'error-message-utils';
isEncodedError('Some random unencoded error');
// false
isEncodedError(new Error('Some random unencoded error'));
// false
isEncodedError(encodeError('Some unknown error.', 'NASTY_ERROR'));
// true
isEncodedError(encodeError(new Error('Some unknown error.'), 'NASTY_ERROR'));
// true
```
## Types
```typescript
/**
* Error Code
* The code that is inserted when encoding an error. If none is provided or none can be extracted, it defaults to -1.
*/
type IErrorCode = string | number;
/**
* Decoded Error
* The object obtained when an error is decoded. Keep in mind that if the error message or the code cannot be extracted for any reason, the default values will be set instead.
*/
type IDecodedError = {
message: string,
code: IErrorCode,
};
```
## Built With
- TypeScript
## Running the Tests
```bash
npm run test:unit
```
## License
[MIT](https://choosealicense.com/licenses/mit/)
## Deployment
Install dependencies:
```bash
npm install
```
Build the library:
```bash
npm start
```
Publish to `npm`:
```bash
npm publish
```