Class Parser

constructor

• new Parser(options?: Options): Parser

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

  Parameters

  • Optionaloptions: Options

    Create a Parser instance with the specified options.

  Returns Parser

  Example

  const parser = await Parser.create();
  Copy

Optionaloptions

closeParser

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

  Close the parser.

  Parameters

  • reParse: boolean = false

    Close the parser, as well as the file. If reparsing is used, the document will be kept. Default is false.

  Returns Promise<void>

destroy

• destroy(): Promise<void>

  Destroy the current object.

  Returns Promise<void>

getDoc

• getDoc(): Promise<null | DocType>

  Get the document object.

  Returns Promise<null | DocType>

  Return the document object.

getEncryptDict

• getEncryptDict(): Promise<null | PDFDictionaryType>

  Get the encrypt dictionary.

  Returns Promise<null | PDFDictionaryType>

  Return the encrypt dictionary.

getLastObjNum

• getLastObjNum(): Promise<number>

  Get the last object number.

  Returns Promise<number>

  Return the last object number.

getPassword

• getPassword(): Promise<string>

  Get the password.

  Returns Promise<string>

  Return the password.

getRootObjNum

• getRootObjNum(): Promise<number>

  Get the root object number.

  Returns Promise<number>

  Return the root object number.

getTrailer

• getTrailer(): Promise<null | PDFObjectType>

  Get the trailer dictionary.

  Returns Promise<null | PDFObjectType>

  Return the trailer dictionary.

isOwner

• isOwner(): Promise<boolean>

  Whether the user has the owner permission of the document.

  Returns Promise<boolean>

  Return true if the user has the owner permission of the document, otherwise return false.

setPassword

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

  Set the password.

  Parameters

  • password: string

    The password to be set.

  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>

  Start parse the file.

  Parameters

  • fileName: string

    The file path, eg. d://xxx.pdf.
  • reParse: boolean = false

    Whether to re-parse, default is false.

  Returns Promise<number>

  Return the status of PDF parse. Like:

  • 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>

  Create a Parser instance.

  Parameters

  • Optionaloptions: Options

    Create a Parser instance with the specified options.

  Returns Promise<ParserType>

  Example

  const parser = await Parser.create();
  Copy