0.96.1 • Published 9 months ago

@fuel-ts/errors v0.96.1

Weekly downloads
-
License
Apache-2.0
Repository
-
Last release
9 months ago

@fuel-ts/errors

@fuel-ts/errors is a sub-module for interacting with Fuel.

This package contains core utilities regarding throwing errors internally inside of the fuels-ts SDK.

Table of contents

Documentation

See Fuels-ts Documentation

Usage

Installation

pnpm add @fuel-ts/errors
# or
npm add @fuel-ts/errors

Internal usage

import { FuelError, ErrorCodes } from "@fuel-ts/error";

export function singleImport() {
  throw new FuelError(FuelError.CODES.INVALID_DATA, "Invalid data");
}

export function multipleImports() {
  throw new FuelError(ErrorCodes.INVALID_DATA, "Invalid data");
}

Test Utilities

You can use the expectToThrowFuelError test utility when asserting errors.

// can also be imported from `fuels` when using the umbrella package
import { expectToThrowFuelError } from "@fuel-ts/errors";

import { myFn } from "...";

describe('this and that' () => {
  const code = FuelError.CODES.INVALID_DATA;

  it("should throw FuelError", async () => {
    const expected = new FuelError(code);
    await expectToThrowFuelError(() => myFn(), expected);
  });

  it("should throw something else", async () => {
    const expected = new FuelError(code);
    const fn = () => expectToThrowFuelError(() => myFn(), expected)
    await expect(fn).rejects.toThrow('Something else');
  });
})

External usage

import { FuelError, Provider } from "fuels";

type Locale = "pt-BR" | "bs-BA" | "en-GB";

const currentLocale: Locale = "pt-BR";

const i18nDict = {
  pt-BR: {
    [FuelError.CODES.INVALID_DATA]: "Dados inválidos",
  },
  bs-BA: {
    [FuelError.CODES.INVALID_DATA]: "Nevažeći podaci",
  },
  en-GB: {
    [FuelError.CODES.INVALID_DATA]: "Invalid data",
  },
};

function translateError(e: unknown) {
  const { code } = FuelError.parse(e);
  return i18nDict[currentLocale][code];
}

function main() {
  try {
    const p = new Provider("0004:tƨoʜlɒɔol//:qttʜ");
    console.log(p);
  } catch (e) {
    const prettyError = translateError(e);
    console.log({ prettyError });
  }
};

Contributing

In order to contribute to @fuel-ts/errors, please see the main fuels-ts monorepo.

Changelog

The @fuel-ts/errors changelog can be found at CHANGELOG.

License

The primary license for @fuel-ts/errors is Apache 2.0, see LICENSE.

0.94.9

10 months ago

0.94.7

10 months ago

0.94.8

10 months ago

0.95.0

10 months ago

0.96.0

10 months ago

0.96.1

10 months ago

0.94.6

11 months ago

0.94.5

11 months ago

0.94.4

11 months ago

0.94.3

11 months ago

0.94.2

11 months ago

0.90.0

1 year ago

0.94.1

11 months ago

0.94.0

12 months ago

0.91.0

1 year ago

0.92.0

1 year ago

0.92.1

1 year ago

0.89.0

1 year ago

0.89.1

1 year ago

0.89.2

1 year ago

0.93.0

1 year ago

0.88.0

1 year ago

0.88.1

1 year ago

0.87.0

1 year ago

0.86.0

1 year ago

0.85.0

1 year ago

0.84.0

1 year ago

0.83.0

1 year ago

0.82.0

1 year ago

0.81.0

1 year ago

0.80.0

1 year ago

0.76.9

1 year ago

0.76.11

1 year ago

0.76.10

1 year ago

0.76.12

1 year ago

0.76.8

1 year ago

0.76.7

1 year ago

0.79.0

1 year ago

0.76.5

1 year ago

0.76.4

1 year ago

0.78.0

1 year ago

0.76.3

1 year ago

0.76.2

1 year ago

0.76.1

1 year ago

0.77.0

1 year ago

0.76.0

1 year ago

0.75.0

1 year ago

0.74.0

1 year ago

0.73.0

1 year ago

0.72.0

2 years ago

0.71.1

2 years ago

0.70.1

2 years ago

0.71.0

2 years ago

0.69.1

2 years ago

0.68.0

2 years ago

0.69.0

2 years ago

0.67.0

2 years ago

0.66.1

2 years ago

0.66.0

2 years ago

0.65.0

2 years ago

0.64.1

2 years ago

0.64.0

2 years ago

0.63.0

2 years ago

0.62.0

2 years ago

0.61.0

2 years ago

0.60.0

2 years ago

0.59.0

2 years ago

0.58.0

2 years ago

0.57.0

2 years ago

0.56.1

2 years ago

0.56.0

2 years ago

0.55.0

2 years ago

0.54.1

2 years ago

0.54.0

2 years ago

0.53.0

2 years ago