🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more

contextual-error

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

contextual-error

Emit errors described by a code and context.

0.0.11
latest
Version published
Maintainers
1
Created

contextual-error

Emit errors described by a code and context.

Installation

yarn add contextual-error
# Or if you are using NPM:
# npm install --save contextual-error

Example

import { ContextualError } from 'contextual-error';

type AppErrorContext = (
  {
    code: 'ServerError';
    metadata: Record<string, never>;
  }
  | {
    code: 'ValidationError';
    metadata: {
      name: string;
      reason: string;
      value?: unknown;
    };
   }
);

class AppError extends ContextualError<AppErrorContext> {}

try {

  const request = {
    age: 'abc',
  };

  if ('number' !== typeof request.age) {
    throw new AppError({
      code: 'ValidationError',
      metadata: {
        name: 'age',
        reason: 'Value must be a number',
        value: request.age,
      },
    });
  }

} catch (err) {

  console.log(err);
  // AppError: ValidationError
  //   ...stack...
  //   context: {
  //     code: 'ValidationError',
  //     metadata: {
  //       name: 'age',
  //       reason: 'Value must be a number',
  //       value: 'abc',
  //     },
  //   },
  //   timestamp: '2000-01-01T00:00:00Z'

  if (err instanceof AppError) {
    switch (err.context.code) {
      case 'ValidationError':
        const { name, reason, value } = err.context.metadata;
        alert(`Invalid value provided for "${name}". ${reason} but you provided "${String(value ?? '')}".`);
        // Invalid value provided for "age". Value must be a number but you provided "abc".
        break;
      case 'ServerError':
        alert('Please try again later.');
        break;
    }
  }

}

FAQs

Package last updated on 25 Mar 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts