Class PDFName

constructor

• new PDFName(options?: Options): PDFName

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

  Parameters

  • Optionaloptions: Options

    Create a PDFName instance with the specified options.

  Returns PDFName

  Example

  const pdfName = await PDFName.create();
  Copy

options

destroy

• destroy(): Promise<void>

  Destroys the PDFName object.

  Returns Promise<void>

  A promise that resolves when the object is destroyed.

getString

• getString(): Promise<string>

  Retrieves the string representation of the PDF Name object.

  Returns Promise<string>

  A promise that resolves to a string representing the value of the current FPDObject.

identical

• identical(otherPdfName: PDFNameType): Promise<boolean>

  Checks if another PDFName is identical to the current instance.

  Parameters

  • otherPdfName: PDFNameType

    The second FPD Name instance to compare.

  Returns Promise<boolean>

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

Staticcreate

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

  Creates an instance of PDFName.

  Parameters

  • Optionaloptions: Options

    string of name: The string of name to create the name. example: { "str": "Object Name" }

  Returns Promise<PDFNameType>

  A promise that resolves to a PDFNameType instance.