Class PDFNumber

constructor

• new PDFNumber(options?: PDFNumberOptions): PDFNumber

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

  Parameters

  • Optionaloptions: PDFNumberOptions

    Create a PDFNumber instance with the specified options.

  Returns PDFNumber

  Example

  const pdfNumber = await PDFNumber.create({
     int: 1
  });
  // or
  const pdfNumber = await PDFNumber.create({
    float: 1.1
  });
  // or
  const pdfNumber = await PDFNumber.create({
   str: '1'
  });
  Copy

options

destroy

• destroy(): Promise<void>

  Destroys the PDFNumber object.

  Returns Promise<void>

  A promise that resolves when the object is destroyed.

getFloat

• getFloat(): Promise<number>

  Retrieves the float value of the PDFNumber object.

  Returns Promise<number>

  A promise that resolves to the float value of the PDFNumber.

getInteger

• getInteger(): Promise<number>

  Retrieves the integer value of the PDFNumber object.

  Returns Promise<number>

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

getNumber

• getNumber(): Promise<number>

  Retrieves the numeric value of the PDFNumber object.

  Returns Promise<number>

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

getString

• getString(): Promise<string>

  Retrieves the string representation of the PDFNumber object.

  Returns Promise<string>

  A promise that resolves to the string representation of the PDFNumber.

identical

• identical(otherNumber: PDFNumberType): Promise<boolean>

  Checks if two PDFNumber instances are equal.

  Parameters

  • otherNumber: PDFNumberType

    The second PDFNumber instance to compare.

  Returns Promise<boolean>

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

isInteger

• isInteger(): Promise<boolean>

  Determines if the PDFNumber object is an integer.

  Returns Promise<boolean>

  A promise that resolves to true if the PDFNumber is an integer; otherwise, false.

setNumber

• setNumber(value: number): Promise<void>

  Sets the numeric value of the PDFNumber object.

  Parameters

  • value: number

    The value to set.

  Returns Promise<void>

  A promise that resolves when the value is set.

setString

• setString(str: string): Promise<void>

  Sets the string representation of the PDFNumber object.

  Parameters

  • str: string

    The string to set.

  Returns Promise<void>

  A promise that resolves when the string is set.

Staticcreate

• create(options?: PDFNumberOptions): Promise<PDFNumberType>

  Creates an instance of PDFNumber.

  Parameters

  • Optionaloptions: PDFNumberOptions

    numbers: The number to create the PDFNumber.

  Returns Promise<PDFNumberType>

  A promise that resolves to a PDFNumber instance.