Skip to content

README.md

Latest commit

 

History

History
67 lines (46 loc) · 1.34 KB

README.md

File metadata and controls

67 lines (46 loc) · 1.34 KB

@ydbjs/error

The @ydbjs/error package provides utilities for handling YDB-specific errors in JavaScript/TypeScript applications. It simplifies error classification and provides detailed error messages for better debugging and troubleshooting.

Features

  • Error classification for YDB-specific error codes
  • Detailed error messages with severity levels
  • TypeScript support with type definitions

Installation

Install the package using npm:

npm install @ydbjs/error@6.0.0-alpha.2

Usage

Handling YDB Errors

import { YDBError } from '@ydbjs/error'
import { StatusIds_StatusCode } from '@ydbjs/api/operation'

try {
  throw new YDBError(StatusIds_StatusCode.ABORTED, [
    { severity: 0, issueCode: 14, message: 'Some error message' },
  ])
} catch (error) {
  if (error instanceof YDBError) {
    console.error('YDB Error:', error.message)
    console.error('Error Code:', error.code)
  }
}

Development

Building the Package

npm run build

Running Tests

npm test

For watch mode during development:

npm run test:watch

License

This project is licensed under the Apache 2.0 License.

Links