Method getTitle

src/api/pdf.ts:1058–1072

* Get the document title. * * @returns The title, or undefined if not set * * @example * ```typescript * const title = pdf.getTitle(); * if (title) { * console.log(`Document: ${title}`); * } * ```

()

   * ```
   */
  getTitle(): string | undefined {
    const infoRef = this.ctx.info.trailer.getRef("Info");

    if (!infoRef) {
      return undefined;
    }

    const info = this.ctx.registry.getObject(infoRef);

    if (!(info instanceof PdfDict)) {
      return undefined;
    }

    return info.getString("Title")?.asString();
  }

  /**
   * Set the document title.