Type Alias FileSpecificationProperties

Represents a PDF file specification, defining how external files are referenced or embedded.

This class implements the PDF specification for file references, supporting three primary methods:

URI Reference - Link to an external resource
- Use the uri property
External File - Reference to a non-embedded file
- Use the fileName property
Embedded Stream - File content embedded directly in the PDF
- Use the stream property

Usage Notes:

At least one of the three properties must be specified
fileName and stream can be combined to create an embedded file with a specific name

The FileSpecification class can be used in more complex cases.

type FileSpecificationProperties = {
    desc?: string;
    fileName?: string;
    stream?: EmbeddedFileStreamProperties;
    uri?: string;
}

Index

Properties

desc? fileName? stream? uri?

Properties

`Optional`desc

desc?: string

The optional description.

`Optional`fileName

fileName?: string

The file name.

`Optional`stream

stream?: EmbeddedFileStreamProperties

The EmbeddedFileStreamProperties defining properties of embedded stream,

`Optional`uri

uri?: string

The external uri.