relative-luminance

npm install relative-luminance

Calculate the relative luminance of an RGB triplet color.

Note that as of 1.0.0, this module doesn't directly export a function if you're using CommonJS: use the default export, like:

var luminance = require('relative-luminance').default;

API

Table of Contents

• relativeLuminance
  • Parameters
  • Examples

relativeLuminance

Given a 3-element array of R, G, B varying from 0 to 255, return the luminance as a number from 0 to 1.

Parameters

• rgb Array<number> 3-element array of a color

Examples

var luminance = require('relative-luminance');
var black_lum = luminance([0, 0, 0]); // 0

Returns number luminance, between 0 and 1

Change Log

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

2.0.1 (2018-12-30)

2.0.0 (2018-08-20)

Features

• UMD builds, simplified stack (0bef765)

BREAKING CHANGES

• completely new main, unpkg, and module entry points.

1.0.2 (2018-04-16)

Bug Fixes

• move esm dependency out devDependencies (6d6d5bf)

1.0.1 (2018-03-21)

Bug Fixes

• Be conservative about files included in the package. (f96e583)

1.0.0 (2018-03-21)

Features

• JS modules: use esm to provide both CommonJS and ES6 entry points (2984a5f)

0.0.2 (2017-05-03)

0.0.1 (2017-05-03)