Echo-Utils

Package for creating echo related Echo Utils.

⚠️ Dependency Rules

Source of truth: /eslint.config.js - The @nx/enforce-module-boundaries rule defines all allowed dependencies.

echo-utils is a foundation utility library and CANNOT import from any other echo library.

See libs/README.md for the full dependency flow diagram.

/bundlephobia/:format/:packageName

• Echo-Utils
• Install
  • NPM
• Development
  • Run
  • Test

Install

NPM

npm install @equinor/echo-utils --save

Development

Run

For development we have provided a test playground to be able to test Echo utils. This can be run by using.

npm start

Test

Echo tempPack is set upt to run Jest test suite. To run tests use.

npm run test

For abetter overview, run tests with test coverage.

npm run test-coverage

Documentation

Documentation generated using typedoc can be found here.

Imports in Test Handlers

Test handlers can import from the main entry point:

import { getLinkParamsOrThrow } from '@equinor/echo-utils';

Modern tree-shaking ensures that only the used utilities are included in test bundles.