ImageBlock

Defined in: src/types/media.ts:172

Image content block.

Implements

• ImageBlockData
• JSONSerializable<{ image: Serialized<ImageBlockData>; }>

Constructors

Constructor

new ImageBlock(data): ImageBlock;

Defined in: src/types/media.ts:188

Parameters

Parameter	Type
data	ImageBlockData

Returns

ImageBlock

Properties

type

readonly type: "imageBlock";

Defined in: src/types/media.ts:176

Discriminator for image content.

---

format

readonly format: ImageFormat;

Defined in: src/types/media.ts:181

Image format.

Implementation of

ImageBlockData.format

---

source

readonly source: ImageSource;

Defined in: src/types/media.ts:186

Image source.

Implementation of

ImageBlockData.source

Methods

toJSON()

toJSON(): {
  image: {
     format: ImageFormat;
     source:   | {
        bytes: string;
      }
        | {
        location: {
           type: "s3";
           uri: string;
           bucketOwner?: string;
        };
      }
        | {
        url: string;
      };
  };
};

Defined in: src/types/media.ts:220

Serializes the ImageBlock to a JSON-compatible ContentBlockData object. Called automatically by JSON.stringify(). Uint8Array bytes are encoded as base64 string.

Returns

{
  image: {
     format: ImageFormat;
     source:   | {
        bytes: string;
      }
        | {
        location: {
           type: "s3";
           uri: string;
           bucketOwner?: string;
        };
      }
        | {
        url: string;
      };
  };
}

Name	Type	Description	Defined in
image	{ format: ImageFormat; source: | { bytes: string; } | { location: { type: "s3"; uri: string; bucketOwner?: string; }; } | { url: string; }; }	-	src/types/media.ts:220
image.format	ImageFormat	Image format.	src/types/media.ts:161
image.source	| { bytes: string; } | { location: { type: "s3"; uri: string; bucketOwner?: string; }; } | { url: string; }	Image source.	src/types/media.ts:166

Implementation of

JSONSerializable.toJSON

---

fromJSON()

static fromJSON(data): ImageBlock;

Defined in: src/types/media.ts:244

Creates an ImageBlock instance from its wrapped data format. Base64-encoded bytes are decoded back to Uint8Array.

Parameters

Parameter	Type	Description
data	{ image: { format: ImageFormat; source: | { bytes: string | Uint8Array<ArrayBufferLike>; } | { location: { type: "s3"; uri: string; bucketOwner?: string; }; } | { url: string; }; }; }	Wrapped ImageBlockData to deserialize (accepts both string and Uint8Array for bytes)
data.image	{ format: ImageFormat; source: | { bytes: string | Uint8Array<ArrayBufferLike>; } | { location: { type: "s3"; uri: string; bucketOwner?: string; }; } | { url: string; }; }	-
data.image.format	ImageFormat	Image format.
data.image.source	| { bytes: string | Uint8Array<ArrayBufferLike>; } | { location: { type: "s3"; uri: string; bucketOwner?: string; }; } | { url: string; }	Image source.

Returns

ImageBlock

ImageBlock instance