Skip to content

v1.5.0

Latest
Compare
Choose a tag to compare
@Adedoyin-Emmanuel Adedoyin-Emmanuel released this 13 Feb 20:04

TsFluent v1.5.2 Release Notes ๐ŸŽ‰

Major Features ๐ŸŒŸ

CommonJS and ESM Support

  • Added dual module support for both CommonJS and ES Modules
  • Improved package configuration for better module compatibility
  • Enhanced TypeScript configuration for broader project support

Package Configuration Updates

  • Fixed module resolution issues
  • Improved compatibility with different project setups
  • Better support for various import methods

Module System Support ๐Ÿ“ฆ

CommonJS Usage

// Using require
const { Result } = require("tsfluent");

// Using dynamic import
const { Result } = await import("tsfluent");

ES Modules Usage

// Using ES Module import
import { Result } from "tsfluent";

Configuration Examples ๐Ÿ› ๏ธ

For CommonJS Projects

// tsconfig.json
{
  "compilerOptions": {
    "module": "CommonJS",
    "esModuleInterop": true
  }
}

For ES Module Projects

// package.json
{
  "type": "module"
}

// tsconfig.json
{
  "compilerOptions": {
    "module": "ESNext",
    "moduleResolution": "bundler"
  }
}

Breaking Changes โš ๏ธ

  • No breaking changes in this release
  • Maintains backward compatibility with v1.3.x
  • All existing APIs remain unchanged

Bug Fixes ๐Ÿ›

  • Fixed package configuration issues
  • Resolved module resolution conflicts
  • Improved TypeScript type definitions

Documentation Updates ๐Ÿ“š

  • Added clear examples for different module systems
  • Updated installation and usage instructions
  • Enhanced API documentation clarity

Migration Guide ๐Ÿ”„

Updating from v1.3.x

No migration steps required! This release is fully backward compatible.

For optimal usage:

  1. Update to the latest version:

    npm install tsfluent@latest
    # or
    yarn add tsfluent@latest
    # or
    pnpm add tsfluent@latest
    # or
    bun add tsfluent@latest
  2. Choose your preferred import style:

    // ES Modules
    import { Result } from "tsfluent";
    
    // CommonJS
    const { Result } = require("tsfluent");

Performance Improvements โšก

  • Optimized module loading
  • Improved type checking performance
  • Better tree-shaking support

What's Next? ๐Ÿ”ฎ

We're planning several exciting features for upcoming releases:

  • Enhanced error handling patterns
  • Additional utility functions
  • More convenience methods
  • Performance optimizations

Feedback and Support ๐Ÿ’ฌ

We welcome your feedback and contributions! Please:

Contributors ๐Ÿ‘ฅ

Special thanks to all contributors who helped make this release possible! Your contributions are greatly appreciated.

License ๐Ÿ“„

TsFluent is released under the MIT License. See the LICENSE file for details.