Interface Metadata

Metadata written by the encoders. Each format stores the fields it has a place for:

Format Fields
PNG, APNG all (as text chunks)
JPEG author, description, copyright, creation time, software (Exif); comment (comment marker)
WebP, AVIF, JPEG XL author, description, copyright, creation time, software (Exif)
GIF software, comment (comment extensions)
TGA author, comment, creation time, software (extension area)

Empty fields are left out

interface Metadata {
    author?: string;
    comment?: string;
    copyright?: string;
    creationTime?: string | number | Date;
    description?: string;
    disclaimer?: string;
    software?: string;
    source?: string;
    title?: string;
    warning?: string;
}

Properties

author? comment? copyright? creationTime? description? disclaimer? software? source? title? warning?

Properties

Optionalauthor

author?: string

The image's author

Optionalcomment

comment?: string

A comment for the image

Optionalcopyright

copyright?: string

The image's copyright info

OptionalcreationTime

creationTime?: string | number | Date

The image's creation time. Default: now

Optionaldescription

description?: string

The image's description

Optionaldisclaimer

disclaimer?: string

A disclaimer for the image

Optionalsoftware

software?: string

The software used to create the image. Default: 'github.com/matmen/ImageScript vX.X.X', '' leaves it out

Optionalsource

source?: string

The image's source

Optionaltitle

title?: string

The image's title

Optionalwarning

warning?: string

A warning for the image

Settings

Member Visibility

On This Page

Properties