CompressOptions

type CompressOptions = {
  convertHeic?: boolean;
  convertSize?: number;
  keepOriginalDimensions?: boolean;
  maxHeight?: number;
  maxWidth?: number;
  mimeType?: "image/jpeg" | "image/webp";
  onProgress?: (stage) => void;
  quality?: number;
  strict?: boolean;
};

Defined in: packages/sdk/src/index.ts:999

Subset of compressorjs options exposed through the SDK. Re-imported here to avoid a hard import dependency on ./web from this top-level module (the /web subpath uses browser-only APIs). The runtime compress implementation is lazy-loaded so Node/Bun callers don’t pay the bundle cost — see aq.upload below.

Properties

convertHeic?

optional convertHeic?: boolean;

Defined in: packages/sdk/src/index.ts:1007

---

convertSize?

optional convertSize?: number;

Defined in: packages/sdk/src/index.ts:1004

---

keepOriginalDimensions?

optional keepOriginalDimensions?: boolean;

Defined in: packages/sdk/src/index.ts:1006

---

maxHeight?

optional maxHeight?: number;

Defined in: packages/sdk/src/index.ts:1003

---

maxWidth?

optional maxWidth?: number;

Defined in: packages/sdk/src/index.ts:1002

---

mimeType?

optional mimeType?: "image/jpeg" | "image/webp";

Defined in: packages/sdk/src/index.ts:1001

---

onProgress?

optional onProgress?: (stage) => void;

Defined in: packages/sdk/src/index.ts:1008

Parameters

Parameter	Type
stage	"convertingHeic" | "compressing" | "compressingKeepingDimensions"

Returns

void

---

quality?

optional quality?: number;

Defined in: packages/sdk/src/index.ts:1000

---

strict?

optional strict?: boolean;

Defined in: packages/sdk/src/index.ts:1005