@e-mc/image

* NodeJS 18.20 LTS
* ES2022

General Usage

* Read the Docs

Interface

* View Source

``typescript
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 {
resizeData?: ResizeData;
cropData?: CropData;
rotateData?: RotateData;
qualityData?: QualityData;
methodData?: [string, unknown[]?][];
opacityValue?: number;
outputType?: string;
setCommand(value: string | CommandData, outputAs?: string): void;
getCommand(): string;
parseCommand(value: string): CommandData;
parseMethod(value: string): [string, unknown[]?][] | undefined;
parseResize(value: string): ResizeData | undefined;
parseCrop(value: string): CropData | undefined;
parseRotate(value: string): RotateData | undefined;
parseQuality(value: string): QualityData | undefined;
parseOpacity(value: string): number;
parseWorker(command: string | CommandData, outputType?: string): CommandData | null;
using?(data: IFileThread, command: string): Promise;
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, command: string, options: { tempFile: true }): Promise;
transform(file: string, command: string, options?: TransformOptions): Promise;
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, ...args: unknown[]): IImage;
}
`

Settings

`typescript
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;
}
``

$3

- @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.

References

- https://www.unpkg.com/@e-mc/types@0.13.8/lib/asset.d.ts
- https://www.unpkg.com/@e-mc/types@0.13.8/lib/image.d.ts
- https://www.unpkg.com/@e-mc/types@0.13.8/lib/settings.d.ts

LICENSE

BSD 3-Clause