Class Parser

constructor

• new Parser(options?: Options): Parser

  创建一个 Parser 实例。 与其使用 new 模式创建实例，不如使用 create 来创建实例。

  Parameters

  • Optionaloptions: Options

    使用指定的选项创建一个 Parser 实例。

  Returns Parser

  Example

  const parser = await Parser.create();
  Copy

Optionaloptions

closeParser

• closeParser(reParse?: boolean): Promise<void>

  关闭解析器。

  Parameters

  • reParse: boolean = false

    关闭解析器以及文件。如果使用重新解析，将保留文档。默认值为 false。

  Returns Promise<void>

destroy

• destroy(): Promise<void>

  销毁当前对象。

  Returns Promise<void>

getDoc

• getDoc(): Promise<null | DocType>

  获取文档对象。

  Returns Promise<null | DocType>

  返回文档对象。

getEncryptDict

• getEncryptDict(): Promise<null | PDFDictionaryType>

  获取加密字典。

  Returns Promise<null | PDFDictionaryType>

  返回加密字典。

getLastObjNum

• getLastObjNum(): Promise<number>

  获取最后一个对象编号。

  Returns Promise<number>

  返回最后一个对象编号。

getPassword

• getPassword(): Promise<string>

  获取密码。

  Returns Promise<string>

  返回密码。

getRootObjNum

• getRootObjNum(): Promise<number>

  获取根对象编号。

  Returns Promise<number>

  返回根对象编号。

getTrailer

• getTrailer(): Promise<null | PDFObjectType>

  获取 trailer 字典。

  Returns Promise<null | PDFObjectType>

  返回 trailer 字典。

isOwner

• isOwner(): Promise<boolean>

  用户是否拥有该文档的所有者权限。

  Returns Promise<boolean>

  如果用户拥有该文档的所有者权限则返回 true，否则返回 false。

setPassword

• setPassword(password: string): Promise<void>

  设置密码。

  Parameters

  • password: string

    要设置的密码。

  Returns Promise<void>

  Example

  const parser = await Parser.create();
  const status = await parser.startParse('d://xxx.pdf', false);
  if (status === FPD_PARSE_ERROR_PASSWORD) {
     parser.setPassword('123456');
     status = await parser.startParse('d://xxx.pdf', false);
  }
  Copy

startParse

• startParse(fileName: string, reParse?: boolean): Promise<number>

  开始解析文件。

  Parameters

  • fileName: string

    文件路径，例如 d://xxx.pdf。
  • reParse: boolean = false

    是否重新解析，默认为 false。

  Returns Promise<number>

  返回 PDF 解析状态。例如：

  • DefineConst.FPD_PARSE_ERROR_SUCCESS
  • DefineConst.FPD_PARSE_ERROR_FILE
  • DefineConst.FPD_PARSE_ERROR_FORMAT
  • DefineConst.FPD_PARSE_ERROR_PASSWORD
  • DefineConst.FPD_PARSE_ERROR_HANDLER
  • DefineConst.FPD_PARSE_ERROR_CERT
  • DefineConst.FPD_PARSE_ERROR_TOBECONTINUED
  • DefineConst.FPD_PARSE_ERROR_FAILED
  • DefineConst.FPD_PARSE_ERROR_DATA_SCARCITY

  Example

  const parser = await Parser.create();
  const status = await parser.startParse('d://xxx.pdf', false);
  if (status === DefineConst.FPD_PARSE_ERROR_SUCCESS) {
     console.log('Parse success');
  }
  Copy

Staticcreate

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

  创建一个 Parser 实例。

  Parameters

  • Optionaloptions: Options

    使用指定的选项创建一个 Parser 实例。

  Returns Promise<ParserType>

  Example

  const parser = await Parser.create();
  Copy