Interface PDFLinkType

interface PDFLinkType {
    destroy: () => Promise<void>;
    getLinkAtPoint: (
        linkAtPoint: LinkAtPointType,
    ) => Promise<null | PDFLinkType>;
    getLinksCount: (doc: DocType, page: PageType) => Promise<number>;
    options?: Options;
}

Implemented by

PDFLink

Index

Properties

destroy getLinkAtPoint getLinksCount options?

Properties

destroy

destroy: () => Promise<void>

Destroys the pdfLink object.

Type declaration

- (): Promise<void>
- Returns Promise<void>
  A promise that resolves when the object is destroyed.

getLinkAtPoint

getLinkAtPoint: (linkAtPoint: LinkAtPointType) => Promise<null | PDFLinkType>

Retrieves the link at the specified point.

Type declaration

- (linkAtPoint: LinkAtPointType): Promise<null | PDFLinkType>
- Parameters
  - linkAtPoint: LinkAtPointType
  Returns Promise<null | PDFLinkType>
  A promise that resolves to a PDFLink instance or null if not found.

getLinksCount

getLinksCount: (doc: DocType, page: PageType) => Promise<number>

Retrieves the number of links in the document.

Type declaration

- (doc: DocType, page: PageType): Promise<number>
- Parameters
  - doc: DocType
    The PDF document object.
  - page: PageType
    The PDF page object.
  Returns Promise<number>
  A promise that resolves to the number of links.

`Optional`options

options?: Options