Interface PDFStringType

interface PDFStringType {
    destroy: () => Promise<void>;
    getString: () => Promise<string>;
    identical: (otherStr: PDFStringType) => Promise<boolean>;
    isHex: () => Promise<boolean>;
    options?: Options;
    setHex: (isHex: boolean) => Promise<void>;
}

Implemented by

Properties

destroy getString identical isHex options? setHex

Properties

destroy

destroy: () => Promise<void>

Destroys the PDFString object.

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

      A promise that resolves when the object is destroyed.

getString

getString: () => Promise<string>

Retrieves the string representation.

Type declaration

    • (): Promise<string>

    • Returns Promise<string>

      A promise that resolves to a string representing the object.

identical

identical: (otherStr: PDFStringType) => Promise<boolean>

Determines if two string objects are identical.

Type declaration

    • (otherStr: PDFStringType): Promise<boolean>

    • Parameters

      Returns Promise<boolean>

      A promise that resolves to true if the two objects are identical; otherwise, false.

isHex

isHex: () => Promise<boolean>

Determines if the object is hexadecimal.

Type declaration

    • (): Promise<boolean>

    • Returns Promise<boolean>

      A promise that resolves to true if the object is hexadecimal; otherwise, false.

Optionaloptions

options?: Options

setHex

setHex: (isHex: boolean) => Promise<void>

Sets the hexadecimal representation of the object.

Type declaration

    • (isHex: boolean): Promise<void>

    • Parameters

      • isHex: boolean

        Whether to set the string representation as hexadecimal (optional, defaults to true).

      Returns Promise<void>

      A promise that resolves when the hexadecimal representation is set.

Settings

Member Visibility

On This Page

Properties