Class PDFString

constructor

• new PDFString(options?: Options): PDFString

  Create a PDFString instance. Instead of creating an instance in new mode, use create to create an instance.

  Parameters

  • Optionaloptions: Options

    Create a PDFString instance with the specified options.

  Returns PDFString

  Example

  const pdfStr = await PDFString.create({
    str: 'Hello World'
  });
  Copy

options

destroy

• destroy(): Promise<void>

  Destroys the PDFString object.

  Returns Promise<void>

  A promise that resolves when the object is destroyed.

getString

• getString(): Promise<string>

  Retrieves the string representation.

  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.

  Parameters

  • otherStr: PDFStringType

    Another string object to compare with.

  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.

  Returns Promise<boolean>

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

setHex

• setHex(isHex?: boolean): Promise<void>

  Sets the hexadecimal representation of the object.

  Parameters

  • OptionalisHex: boolean = true

    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.

Staticcreate

• create(options?: Options): Promise<PDFStringType>

  Creates a string object from a byte string.

  Parameters

  • Optionaloptions: Options

    str - The string value to be used to create the string object.
    isHex - A boolean value that specifies whether the string is in hexadecimal format (optional, default = true).

  Returns Promise<PDFStringType>

  • A promise that resolves with a new PDFString object.