Installation

npm install --save @types/utif

Summary

This package contains type definitions for utif (https://github.com/photopea/UTIF.js).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/utif.

index.d.ts

1import "node";
2
3export as namespace UTIF;
4
5export type TiffTag = string[] | number[];
6
7/**
8 * Each IFD is an object, keys are "tXYZ" (XYZ is a TIFF tag number), values are values of these tags.
9 * You can get the the dimension (and other properties, "metadata") of the image without decompressing pixel data.
10 * For more information on what each tag means, refer https://github.com/photopea/UTIF.js/blob/master/UTIF.js#L742 or TIFF 6 specification.
11 */
12// eslint-disable-next-line @typescript-eslint/naming-convention
13export interface IFD {
14    [property: string]: TiffTag | number | Uint8Array;
15    data: Uint8Array;
16    width: number;
17    height: number;
18}
19
20/**
21 * Returns an array of "IFDs" (image file directories).
22 *
23 * @param buffer A Buffer or ArrayBuffer containing TIFF or EXIF data.
24 */
25export function decode(buffer: Buffer | ArrayBuffer): IFD[];
26
27/**
28 * If there is an image inside the IFD, it is decoded and three new properties are added to the IFD: width, height and data.
29 * Note: TIFF files may have various number of channels and various color depth. The interpretation of data depends on many tags (see the TIFF 6 specification).
30 *
31 * @param buffer A Buffer or ArrayBuffer containing TIFF or EXIF data
32 * @param ifd The element of the output of UTIF.decode()
33 */
34export function decodeImage(buffer: Buffer | ArrayBuffer, ifd: IFD): void;
35
36/**
37 * Returns Uint8Array of the image in RGBA format, 8 bits per channel (ready to use in context2d.putImageData() etc.)
38 *
39 * @param ifd An image file directory
40 */
41export function toRGBA8(ifd: IFD): Uint8Array;
42
43/**
44 * Returns an ArrayBuffer of the binary TIFF file.
45 * Note: No compression available right now.
46 *
47 * @param rgba A Uint8Array containing RGBA pixel data.
48 * @param w Width of the image.
49 * @param h Height of the image.
50 * @param metadata [optional] The image file directory which should be encoded.
51 */
52export function encodeImage(rgba: Uint8Array, w: number, h: number, metadata?: IFD): ArrayBuffer;
53
54/**
55 * Returns ArrayBuffer of binary data which can be used to encode EXIF data.
56 *
57 * @param ifds The array of IFDs (image file directories) to be encoded.
58 */
59export function encode(ifds: IFD[]): ArrayBuffer;
60
61/**
62 * Replaces all Image elements in the document with Canvas elements.
63 * The attributes "id", "class" and "style" will be copied from the original Image to the new Canvas.
64 */
65export function replaceIMG(): void;
66

Additional Details

• Last updated: Mon, 20 Nov 2023 23:36:24 GMT
• Dependencies: @types/node

Credits

These definitions were written by Jan Pesa, Naveen Kumar Sangi, and Massimiliano Caniparoli.