npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

color-manipulation-library

v1.0.2

Published

A simple Node.js library for converting between different color formats and applying color adjustments and filters.

Downloads

14

Readme

Color Manipulation Library

A simple Node.js library for converting between different color formats and applying color adjustments and filters.

Installation

This library can be installed via npm. Use the following command:

npm install color-manipulation-library

Functions

hexToRgb(hex)

Converts a HEX color code to RGB values. Can be 3 character of 6 character hex.

  • Parameters:

    • hex (string): The HEX color code to convert.
  • Returns: A Promise that resolves to an object containing the RGB values.

rgbToHex(r, g, b)

Converts RGB values to a HEX color code.

  • Parameters:

    • r (number): The red value (0-255).
    • g (number): The green value (0-255).
    • b (number): The blue value (0-255).
  • Returns: A Promise that resolves to the HEX color code.

rgbToHsl(r, g, b)

Converts RGB values to HSL (Hue, Saturation, Lightness) color values.

  • Parameters:

    • r (number): The red value (0-255).
    • g (number): The green value (0-255).
    • b (number): The blue value (0-255).
  • Returns: A Promise that resolves to an object containing the HSL values.

hslToRgb(h, s, l)

Converts HSL color values to RGB.

  • Parameters:

    • h (number): The hue value (0-1).
    • s (number): The saturation value (0-1).
    • l (number): The lightness value (0-1).
  • Returns: A Promise that resolves to an object containing the RGB values.

adjustBrightness(color, percentage)

Adjusts the brightness of a color.

  • Parameters:

    • color (object): An object containing the RGB values.
    • percentage (number): The percentage by which to adjust brightness (-100 to 100).
  • Returns: A Promise that resolves to an object containing the adjusted RGB values.

clamp(value, min, max)

Clamps a value within a specified range.

  • Parameters:

    • value (number): The value to clamp.
    • min (number): The minimum allowed value.
    • max (number): The maximum allowed value.
  • Returns: The clamped value.

Error Classes

InvalidColorFormatError

This error class is thrown when the HEX color format is invalid.

ValueOutOfRangeError

This error class is thrown when values are outside the expected range.

Example Usage

Here's an example of how to use the library to convert a HEX color to RGB:

const { hexToRgb } = require('color-manipulation-library');

hexToRgb('#ff0000')
    .then(result => {
        console.log(result); // { r: 255, g: 0, b: 0 }
    })
    .catch((error) => {
        console.error(error);
    });

License

This library is distributed under the MIT License.