Skip to main content

Interface: AttachmentInfo<Params>

ghostly-runtime.AttachmentInfo

Metadata about an attachment.

Type parameters​

NameType
Paramsunknown

Hierarchy​

Properties​

contentType​

β€’ contentType: string

The view's type (for instance, text/html or application/pdf).

Inherited from​

View.contentType

Defined in​

ghostly-runtime/src/types.ts:73


description​

β€’ Optional description: string

An optional description of the attachment.

Defined in​

ghostly-runtime/src/types.ts:99


dpi​

β€’ Optional dpi: number

The resolution be used when rendering the view. Used for viewport size calculations.

Inherited from​

View.dpi

Defined in​

ghostly-runtime/src/types.ts:79


htmlTransforms​

β€’ Optional htmlTransforms: HTMLTransform[]

An array of transformations to apply when producing HTML results. Defaults to [ 'inline', 'noscript', 'minimize' ].

Inherited from​

View.htmlTransforms

Defined in​

ghostly-runtime/src/types.ts:90


name​

β€’ name: string

The name of the attachment (including file extension).

Defined in​

ghostly-runtime/src/types.ts:96


paperSize​

β€’ Optional paperSize: PaperSize

The paper size to be used when rendering documents.

Inherited from​

View.paperSize

Defined in​

ghostly-runtime/src/types.ts:82


params​

β€’ Optional params: Params

Optional view params.

Inherited from​

View.params

Defined in​

ghostly-runtime/src/types.ts:76


viewportSize​

β€’ Optional viewportSize: ViewportSize

The size of the viewport to use, in pixels. Will be calculated from dpi and paperSize, if not provided.

Inherited from​

View.viewportSize

Defined in​

ghostly-runtime/src/types.ts:85