« Changelog History


gradient-string v3.0.0 Release Notes

Release Date: 2024-09-27 // over 1 year ago
    • gradient-string v3 is now written in TypeScript & pure ESM
    • 🔒 All dependencies are up-to-date, all security issues patched
    • 🆕 New super-fast unit tests made with Vitest
    • 👌 Improved documentation

    ⚠ ⚠️ v2 to v3 migration

    💥 Breaking changes

    • gradient-string requires Node.js 14+ (instead of 10 before)

    • You cannot require gradient-string anymore, you have to import it

      • const gradient = require('gradient-string');+ import gradient, { rainbow } from 'gradient-string';

    🗄 Deprecated

    The following recommendations are not breaking changes, but you should migrate your code to avoid problems in the future.
    N.B You may see @deprecated warnings or TypeScript errors/warnings if you decide not to.

    // Don't use aliases like this- import gradient from 'gradient-string';- gradient.rainbow('Hello, World!');// Import aliases separately instead+ import { rainbow } from 'gradient-string';+ rainbow('Hello, World!');

// Don't separate your colors in different arguments- const coolGradient = gradient('red', 'blue')('Hello, World!');// Use an array instead+ const coolGradient = gradient(['red', 'blue'])('Hello, World!');

// Don't pass your options when you call your already initialized gradient- const coolGradient = gradient(['red', 'blue'])- coolGradient('Hello, World!', { interpolation: 'hsv' }); // Options were needed here// Pass your options directly when you initialize it+ const coolGradient = gradient(['red', 'blue'], { interpolation: 'hsv' }) // Pass them here+ coolGradient('Hello, World!');

Previous changes from v2.0.2

    • 🔒 Upgrade dependencies to patch security issues