Détail du package

@yoroi/types

Emurgo937Apache-2.06.0.0

The Yoroi Types package of Yoroi SDK

yoroi, cardano, types, react

readme

@yoroi/types

npm version License codecov

The Types package of Yoroi SDK - A collection of TypeScript type definitions and interfaces used across the Yoroi ecosystem.

📦 Installation

npm install @yoroi/types
# or
yarn add @yoroi/types

🔧 Requirements

  • Node.js >= 22.12.0
  • TypeScript >= 5.3.3
  • Peer Dependencies:
    • @emurgo/yoroi-lib >= 2.0.0
    • axios >= 1.9.0
    • bignumber.js >= 9.3.0
    • rxjs >= 7.8.2

🚀 Usage

import { /* your imports */ } from '@yoroi/types';

📚 Documentation

For detailed documentation, please visit our documentation site.

🧪 Testing

# Run tests
npm test

# Run tests in watch mode
npm run test:watch

🏗️ Development

# Install dependencies
npm install

# Build the package
npm run build

# Build for development
npm run build:dev

# Build for release
npm run build:release

📊 Code Coverage

The package maintains a minimum code coverage threshold of 20% with a 1% threshold for status checks.

Code Coverage

📈 Dependency Graph

Below is a visualization of the package's internal dependencies:

Dependency Graph

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for more details.

📄 License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

🔗 Links