@e-mc/image

Interface

import type { IHost, ModuleConstructor } from "./index";
import type { IFileThread } from "./asset";
import type { CommandData, CropData, QualityData, ResizeData, RotateData, TransformOptions } from "./image";
import type { ImageModule } from "./settings";

interface IImage extends IClient<IHost, ImageModule> {
    resizeData?: ResizeData | null;
    cropData?: CropData | null;
    rotateData?: RotateData | null;
    qualityData?: QualityData | null;
    methodData?: [string, unknown[]?][] | null;
    opacityValue?: number;
    outputType?: string;
    setCommand(value: string | CommandData, outputAs?: string): void;
    getCommand(): string;
    parseCommand(value: string): CommandData;
    parseMethod(value: string): [string, unknown[]?][] | null | undefined;
    parseResize(value: string): ResizeData | null | undefined;
    parseCrop(value: string): CropData | null | undefined;
    parseRotate(value: string): RotateData | null | undefined;
    parseQuality(value: string): QualityData | null | undefined;
    parseOpacity(value: string): number;
    parseWorker(command: string | CommandData, outputType?: string): CommandData | null;
    using?(data: IFileThread, command: string): Promise<unknown>;
    get outputAs(): string;
}

interface ImageConstructor extends ModuleConstructor {
    readonly MIME_JPEG: string;
    readonly MIME_PNG: string;
    readonly MIME_WEBP: string;
    readonly MIME_SVG: string;
    readonly MIME_GIF: string;
    readonly MIME_BMP: string;
    readonly MIME_TIFF: string;
    transform(file: string | Buffer, command: string, options: { tempFile: true }): Promise<string>;
    transform(file: string | Buffer, command: string, options?: TransformOptions): Promise<Buffer | null>;
    clamp(value: unknown, min?: number, max?: number): number;
    isBinary(mime: unknown): mime is string;
    toABGR(buffer: Uint8Array | Buffer): Buffer;
    asBuffer(data: Buffer | Uint8Array): Buffer;
    readonly prototype: IImage;
    new(module?: ImageModule): IImage;
}

Changelog

Added in version 0.12.0:

ImageConstructor function asBuffer for copying a Uint8Array was created.
ImageConstructor property getters for MIME types:
MIME_JPEG

MIME_PNG
MIME_WEBP

MIME_SVG
MIME_GIF

MIME_BMP
MIME_TIFF
IImage function parseWorker for transform capabilities was created.

Removed in version 0.12.0:

ImageConstructor property REGEXP_SIZERANGE was for internal use in @e-mc/file-manager.

Added in version 0.11.0:

IImage property outputType for storing MIME write was created.

Settings

View JSON

import type { PermittedDirectories } from "./core";

interface ImageModule {
    // handler: "@pi-r/jimp";
    webp?: string;
    settings?: {
        broadcast_id?: string | string[];
        cache?: boolean;
        jimp?: {
            exec?: {
                uid?: number;
                gid?: number;
            };
            cache_expires?: number | string;
            rotate_clockwise?: boolean;
        };
        webp?: {
            path?: string;
            cwebp?: string[];
            gif2webp?: string[];
        };
    };
    permission?: PermittedDirectories;
}

Example usage

@pi-r/jimp

Note

Usage without a Host is conducted through static methods. The using class method is called by the Host to perform the transformation.