@maschinenlesbar.org/openka-cli
    Preparing search index...

    Class PdfDocument

    Index
    buf decodeBudget encrypted lostObjectStreams trailers
    version
    catalog declaredPageCount dict get getObject num pages resolve load
    buf: Buffer
    decodeBudget: DecodeBudget

    What every stream this document decodes is charged to — see MAX_DECODED_BYTES.

    encrypted: boolean

    True when the document declares an /Encrypt dictionary.

    lostObjectStreams: LostObjectStream[]

    Object streams that would not decode; their objects are missing from objects.

    trailers: PdfDict[]
    • get version(): string

      The PDF version from the header, e.g. 1.4.

      Returns string

    • The document catalog, found via a trailer /Root or by type as a fallback.

      Returns PdfDict | undefined

    • The page count the page tree's root declares (/Count), if it declares one.

      Returns number | undefined

    • Parameters

      • value: PdfValue | undefined

      Returns PdfDict | undefined

    • Resolve a dictionary entry.

      Parameters

      • dict: PdfDict | undefined
      • key: string

      Returns PdfValue | undefined

    • Fetch object num, parsing it on first use.

      Parameters

      • num: number

      Returns PdfValue | undefined

    • Parameters

      • value: PdfValue | undefined

      Returns number | undefined

    • The pages in reading order. Walks the page tree from the catalog; if that is missing or broken, falls back to every object of /Type /Page in object-number order, which is the order they were written in.

      Returns PdfPage[]

    • Follow indirect references until a direct value is reached.

      Parameters

      • value: PdfValue | undefined

      Returns PdfValue | undefined

    • Parse a PDF from bytes. Throws ParseError when the file is not a PDF.

      Parameters

      • buf: Buffer

      Returns PdfDocument

    Settings
    Member Visibility

    On This Page
    Properties
    Accessors
    Methods