Skip to content

Repository files navigation

license npm latest package npm downloads Follow on Twitter

LI.FI - Types

Types for the LI.FI stack.

Summary

This package contains all common types for the LI.FI SDK. Learn more about LI.FI on (https://li.fi).

Check out the Changelog to see what changed in the last releases.

Installation

pnpm add @lifi/types

or

npm install --save @lifi/types

Development

  • pnpm lint / pnpm lint:fix — lint with oxlint
  • pnpm format / pnpm format:check — format with oxfmt
  • pnpm typecheck — type-check with TypeScript 7
  • pnpm build — build CJS, ESM and declarations

TypeScript 7 does not ship tsserver, so VS Code's built-in TypeScript support falls back to its bundled version. Install the "TypeScript 7" extension (TypeScriptTeam.native-preview) to get editor diagnostics that match pnpm typecheck.

Git hooks (husky + lint-staged) run oxlint and oxfmt on staged files and check commit messages with commitlint.

Release

This package is released with Changesets.

  1. Add a changeset to your PR: pnpm changeset (pick the bump and write a 1–2 line summary).
  2. When the PR merges, CI opens or updates the chore: version packages PR.
  3. Merging that PR publishes the new version to npm, pushes the vX.Y.Z tag and creates a GitHub Release.

To share an unmerged build, add the release-preview label to a PR that has a changeset. CI publishes 0.0.0-preview-<sha> under the preview dist-tag and comments the install command on the PR.

Releases

Used by

Contributors

Languages