refactor: rename enhanceContrast to autoLevel

Author: opatiny

src/filters/__tests__/__image_snapshots__/enhance-contrast-test-ts-bigger-image-1-snap.png renamed to src/filters/__tests__/__image_snapshots__/auto-level-test-ts-bigger-image-1-snap.png

@@ -1,4 +1,4 @@
-import { enhanceContrast } from '../enhanceContrast';
+import { autoLevel } from '../autoLevel';
 
 test('3x1 rgba image, custom output min and max', () => {
   const image = testUtils.createRgbaImage([
@@ -7,7 +7,7 @@ test('3x1 rgba image, custom output min and max', () => {
     [255, 200, 0, 50],
   ]);
 
-  const result = enhanceContrast(image);
+  const result = autoLevel(image);
 
   expect(result).toMatchImageData([
     [0, 0, 0, 50],
@@ -18,15 +18,15 @@ test('3x1 rgba image, custom output min and max', () => {
 
 test('1x3 grey image', () => {
   const image = testUtils.createGreyImage([[50, 100]]);
-  expect(enhanceContrast(image)).toMatchImageData([[0, 255]]);
+  expect(autoLevel(image)).toMatchImageData([[0, 255]]);
 });
 
 test('alpha should not be modified', () => {
   const image = testUtils.createGreyaImage([
     [50, 100],
     [100, 50],
   ]);
-  expect(enhanceContrast(image)).toMatchImageData([
+  expect(autoLevel(image)).toMatchImageData([
     [0, 100],
     [255, 50],
   ]);
@@ -38,7 +38,7 @@ test('out option', () => {
     [30, 40],
     [60, 70],
   ]);
-  const result = enhanceContrast(image, { out: image });
+  const result = autoLevel(image, { out: image });
   expect(result).toMatchImageData([
     [0, 10],
     [127, 40],
@@ -49,5 +49,5 @@ test('out option', () => {
 
 test('bigger image', () => {
   const image = testUtils.load('featureMatching/id-crops/crop1.png');
-  expect(enhanceContrast(image)).toMatchImageSnapshot();
+  expect(autoLevel(image)).toMatchImageSnapshot();
 });

src/filters/__tests__/enhanceContrast.test.ts renamed to src/filters/__tests__/autoLevel.test.ts

@@ -3,7 +3,7 @@ import checkProcessable from '../utils/checkProcessable';
 import { ImageColorModel } from '../utils/constants/colorModels';
 import { getOutputImage } from '../utils/getOutputImage';
 
-export interface EnhanceContrastOptions {
+export interface AutoLevelOptions {
   /**
    * Image to which to output.
    */
@@ -17,10 +17,7 @@ export interface EnhanceContrastOptions {
  * @param options - Enhance contrast options.
  * @returns The enhanced image.
  */
-export function enhanceContrast(
-  image: Image,
-  options: EnhanceContrastOptions = {},
-): Image {
+export function autoLevel(image: Image, options: AutoLevelOptions = {}): Image {
   checkProcessable(image, {
     bitDepth: [8, 16],
   });

src/filters/enhanceContrast.ts renamed to src/filters/autoLevel.ts

@@ -2,7 +2,7 @@ export * from './and';
 export * from './blur';
 export * from './convolution';
 export * from './derivativeFilter';
-export * from './enhanceContrast';
+export * from './autoLevel';
 export * from './gaussianBlur';
 export * from './gradientFilter';
 export * from './hypotenuse';

src/filters/index.ts

@@ -124,7 +124,9 @@ function getValueArray(
     if (value.length === imageChannels) {
       return value;
     } else {
-      throw new Error('array length is not compatible with channel option');
+      throw new RangeError(
+        'array length is not compatible with channel option',
+      );
     }
   } else {
     return new Array(imageChannels).fill(value);