Interface PDFObjectType

interface PDFObjectType {
    destroy: () => Promise<void>;
    getArray: () => Promise<null | PDFObjectType>;
    getConstString: (obj: PDFObjectType) => Promise<string>;
    getDict: () => Promise<null | PDFObjectType>;
    getDirect: () => Promise<null | PDFObjectType>;
    getDirectType: () => Promise<number>;
    getInteger: () => Promise<number>;
    getNumber: () => Promise<number>;
    getObjNum: () => Promise<number>;
    getString: () => Promise<string>;
    getType: () => Promise<number>;
    getUnicodeText: () => Promise<string>;
    isIdentical: (otherObj: PDFObjectType) => Promise<boolean>;
    isModified: () => Promise<boolean>;
    options: Options;
    setModified: (modified: boolean) => Promise<void>;
    setUnicodeText: (str: string) => Promise<void>;
}

Implemented by

Properties

destroy getArray getConstString getDict getDirect getDirectType getInteger getNumber getObjNum getString getType getUnicodeText isIdentical isModified options setModified setUnicodeText

Properties

destroy

destroy: () => Promise<void>

Destroys the pdfObject.

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

      A promise that resolves when the object is destroyed.

getArray

getArray: () => Promise<null | PDFObjectType>

Retrieves the array of the object.

Type declaration

getConstString

getConstString: (obj: PDFObjectType) => Promise<string>

Retrieves the constant string of the object.

Type declaration

    • (obj: PDFObjectType): Promise<string>

    • Parameters

      • obj: PDFObjectType

        The object from which to retrieve the constant string.

      Returns Promise<string>

      A promise that resolves to the constant string of the object.

getDict

getDict: () => Promise<null | PDFObjectType>

Retrieves the dictionary of the object.

Type declaration

getDirect

getDirect: () => Promise<null | PDFObjectType>

Retrieves the direct reference of the object.

Type declaration

getDirectType

getDirectType: () => Promise<number>

Retrieves the direct type of the object.

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      A promise that resolves to a number representing the direct type of the object.

getInteger

getInteger: () => Promise<number>

Retrieves the integer value of the object.

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      A promise that resolves to the integer value of the object.

getNumber

getNumber: () => Promise<number>

Retrieves the numeric value of the object.

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      A promise that resolves to the numeric value of the object.

getObjNum

getObjNum: () => Promise<number>

Retrieves the object number.

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      A promise that resolves to a number representing the object's number.

getString

getString: () => Promise<string>

Retrieves the string representation of the object.

Type declaration

    • (): Promise<string>

    • Returns Promise<string>

      A promise that resolves to a string representing the object.

getType

getType: () => Promise<number>

Retrieves the type of the object.

Type declaration

getUnicodeText

getUnicodeText: () => Promise<string>

Retrieves the Unicode text of the object.

Type declaration

    • (): Promise<string>

    • Returns Promise<string>

      A promise that resolves to the Unicode text of the object.

isIdentical

isIdentical: (otherObj: PDFObjectType) => Promise<boolean>

Determines if the current object is identical to another object.

Type declaration

    • (otherObj: PDFObjectType): Promise<boolean>

    • Parameters

      • otherObj: PDFObjectType

        Another PDFObject instance to compare with.

      Returns Promise<boolean>

      A promise that resolves to a boolean indicating whether the two objects are identical.

isModified

isModified: () => Promise<boolean>

Determines if the object has been modified.

Type declaration

    • (): Promise<boolean>

    • Returns Promise<boolean>

      A promise that resolves to a boolean indicating whether the object has been modified.

options

options: Options

setModified

setModified: (modified: boolean) => Promise<void>

Sets whether the object has been modified.

Type declaration

    • (modified: boolean): Promise<void>

    • Parameters

      • modified: boolean

        Whether the object has been modified. Defaults to false.

      Returns Promise<void>

      A promise that resolves when the modification status is set.

setUnicodeText

setUnicodeText: (str: string) => Promise<void>

Sets the Unicode text to the object.

Type declaration

    • (str: string): Promise<void>

    • Parameters

      • str: string

        The string to set.

      Returns Promise<void>

      A promise that resolves when the text is set.

Settings

Member Visibility

On This Page

Properties