Renamed MagickAlphaOption to AlphaAction.

Author: dlemstra

src/enums/magick-alpha-option.ts src/enums/alpha-action.ts

@@ -4,9 +4,9 @@
 */
 
 /**
- * Specifies alpha options.
+ * Specifies alpha actions.
  */
-export const MagickAlphaOption = {
+export const AlphaAction = {
     /**
      * Undefined.
      */
@@ -107,4 +107,4 @@ export const MagickAlphaOption = {
     OffIfOpaque: 16
 } as const;
 
-export type MagickAlphaOption = typeof MagickAlphaOption[keyof typeof MagickAlphaOption];
+export type AlphaAction = typeof AlphaAction[keyof typeof AlphaAction];

src/index.ts

@@ -34,6 +34,7 @@ export * from './drawing/drawable-text';
 export * from './drawing/drawable';
 export * from './drawing/drawables';
 export * from './drawing/drawing-wand';
+export * from './enums/alpha-action';
 export * from './enums/auto-threshold-method';
 export * from './enums/channels';
 export * from './enums/class-type';
@@ -55,7 +56,6 @@ export * from './enums/gravity';
 export * from './enums/interlace';
 export * from './enums/kernel';
 export * from './enums/log-event-types';
-export * from './enums/magick-alpha-option';
 export * from './enums/magick-error-severity';
 export * from './enums/magick-format';
 export * from './enums/magick-orientation';

src/magick-image.ts

@@ -3,6 +3,7 @@
   Licensed under the Apache License, Version 2.0.
 */
 
+import { AlphaAction } from './enums/alpha-action';
 import { AsyncImageCallback, AsyncImageCollectionCallback, ImageCallback, ImageCollectionCallback, SyncImageCallback, SyncImageCollectionCallback } from './types/callbacks';
 import { AutoThresholdMethod } from './enums/auto-threshold-method';
 import { ByteArray, _isByteArray } from './byte-array';
@@ -42,7 +43,6 @@ import { IDrawable } from './drawing/drawable';
 import { ImageMagick } from './image-magick';
 import { ImageProfile, IImageProfile } from './profiles/image-profile';
 import { Interlace } from './enums/interlace';
-import { MagickAlphaOption } from './enums/magick-alpha-option';
 import { MagickColor, IMagickColor } from './magick-color';
 import { MagickError } from './magick-error';
 import { MagickErrorInfo } from './types/magick-error-info';
@@ -440,10 +440,10 @@ export interface IMagickImage extends IDisposable {
     addNoise(noiseType: NoiseType, attenuate: number, channels: Channels): void;
 
     /**
-     * Applies the specified alpha option.
-     * @param value The option to use.
+     * Applies the specified alpha action.
+     * @param value The action to use.
      */
-    alpha(value: MagickAlphaOption): void;
+    alpha(value: AlphaAction): void;
 
     /**
      * Annotate using specified text, and bounding area.
@@ -2213,7 +2213,7 @@ export class MagickImage extends NativeInstance implements IMagickImage {
     set hasAlpha(value: boolean) {
         this.useExceptionPointer(exception => {
             if (value)
-                this.alpha(MagickAlphaOption.Opaque);
+                this.alpha(AlphaAction.Opaque);
 
             ImageMagick._api._MagickImage_HasAlpha_Set(this._instance, this.fromBool(value), exception);
         });
@@ -2430,7 +2430,7 @@ export class MagickImage extends NativeInstance implements IMagickImage {
         });
     }
 
-    alpha(value: MagickAlphaOption): void {
+    alpha(value: AlphaAction): void {
         this.useExceptionPointer(exception => {
             ImageMagick._api._MagickImage_SetAlpha(this._instance, value, exception);
         });

tests/magick-image/alpha.spec.ts

@@ -3,13 +3,13 @@
   Licensed under the Apache License, Version 2.0.
 */
 
-import { MagickAlphaOption } from '@src/enums/magick-alpha-option';
+import { AlphaAction } from '@src/enums/alpha-action';
 import { TestFiles } from '@test/test-files';
 
 describe('MagickImage#alpha', () => {
     it('should enable alpha channel', () => {
         TestFiles.Images.Builtin.logo.use(image => {
-            image.alpha(MagickAlphaOption.On);
+            image.alpha(AlphaAction.On);
             expect(image.channelCount).toBe(5);
             expect(image.hasAlpha).toBe(true);
         });

tests/magick-image/channels.spec.ts

@@ -3,7 +3,7 @@
   Licensed under the Apache License, Version 2.0.
 */
 
-import { MagickAlphaOption } from '@src/enums/magick-alpha-option';
+import { AlphaAction } from '@src/enums/alpha-action';
 import { PixelChannel } from '@src/enums/pixel-channel';
 import { TestFiles } from '@test/test-files';
 
@@ -21,7 +21,7 @@ describe('MagickImage#channels', () => {
 
     it('should return the correct channels for a cmyk image', () => {
         TestFiles.Images.cmykJpg.use(image => {
-            image.alpha(MagickAlphaOption.Activate);
+            image.alpha(AlphaAction.Activate);
 
             const channels = image.channels;
 

tests/magick-image/distort.spec.ts

@@ -5,7 +5,7 @@
 
 import { DistortMethod } from '@src/enums/distort-method';
 import { DistortSettings } from '@src/settings/distort-settings';
-import { MagickAlphaOption } from '@src/enums/magick-alpha-option';
+import { AlphaAction } from '@src/enums/alpha-action';
 import { VirtualPixelMethod } from '@src/enums/virtual-pixel-method';
 import { TestFiles } from '@test/test-files';
 
@@ -20,7 +20,7 @@ describe('MagickImage#distort', () => {
 
     it('should distort the image', () => {
         TestFiles.Images.Builtin.rose.use(image => {
-            image.alpha(MagickAlphaOption.Set);
+            image.alpha(AlphaAction.Set);
             image.virtualPixelMethod = VirtualPixelMethod.Transparent;
             image.distort(DistortMethod.PerspectiveProjection, [1.40, 0.25, 3.0, 0.15, 1.30, 0.0, 0.007, 0.009]);
 
@@ -34,7 +34,7 @@ describe('MagickImage#distort', () => {
 
     it('should distort the image with the settings', () => {
         TestFiles.Images.Builtin.rose.use(image => {
-            image.alpha(MagickAlphaOption.Set);
+            image.alpha(AlphaAction.Set);
             image.virtualPixelMethod = VirtualPixelMethod.Transparent;
 
             const settings = new DistortSettings(DistortMethod.PerspectiveProjection);

tests/magick-image/negate-gray-scale.spec.ts

@@ -4,7 +4,7 @@
 */
 
 import { Channels } from '@src/enums/channels';
-import { MagickAlphaOption } from '@src/enums/magick-alpha-option';
+import { AlphaAction } from '@src/enums/alpha-action';
 import { MagickColors } from '@src/magick-colors';
 import { TestFiles } from '@test/test-files';
 
@@ -27,7 +27,7 @@ describe('MagickImage#negateGrayScale', () => {
     it('should only negate grascale on specified channels', () => {
         TestFiles.Images.empty.use((image) => {
             image.read(MagickColors.White, 2, 1);
-            image.alpha(MagickAlphaOption.Opaque);
+            image.alpha(AlphaAction.Opaque);
 
             image.getPixels(pixels => {
                 pixels.setPixel(1, 0, [255, 0, 0]);