Class ImageBlock

constructor

• new ImageBlock(data: ImageBlockData): ImageBlock

  Parameters

  • data: ImageBlockData

  Returns ImageBlock

Readonlytype

Readonlyformat

Readonlysource

toJSON

• toJSON(): {
      image: {
          format: ImageFormat;
          source: | { bytes: string }
          | { s3Location: { uri: string; bucketOwner?: string } }
          | { url: string };
      };
  }

  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 }
              | { s3Location: { uri: string; bucketOwner?: string } }
              | { url: string };
      };
  }

StaticfromJSON

• fromJSON(
      data: {
          image: {
              format: ImageFormat;
              source:
                  | { bytes: string
                  | Uint8Array<ArrayBufferLike> }
                  | { s3Location: { uri: string; bucketOwner?: string } }
                  | { url: string };
          };
      },
  ): ImageBlock

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

  Parameters

  • data: {
        image: {
            format: ImageFormat;
            source:
                | { bytes: string
                | Uint8Array<ArrayBufferLike> }
                | { s3Location: { uri: string; bucketOwner?: string } }
                | { url: string };
        };
    }

    Wrapped ImageBlockData to deserialize (accepts both string and Uint8Array for bytes)

  Returns ImageBlock

  ImageBlock instance