Interface ParserType

interface ParserType {
    closeParser: (reParse?: boolean) => Promise<void>;
    destroy: () => Promise<void>;
    getDoc: () => Promise<null | DocType>;
    getEncryptDict: () => Promise<null | PDFDictionaryType>;
    getLastObjNum: () => Promise<number>;
    getPassword: () => Promise<string>;
    getRootObjNum: () => Promise<number>;
    getTrailer: () => Promise<null | PDFObjectType>;
    isOwner: () => Promise<boolean>;
    options?: Options;
    setPassword: (password: string) => Promise<void>;
    startParse: (fileName: string, reParse: boolean) => Promise<number>;
}

Implemented by

Properties

closeParser destroy getDoc getEncryptDict getLastObjNum getPassword getRootObjNum getTrailer isOwner options? setPassword startParse

Properties

closeParser

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

关闭解析器。

Type declaration

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

    • Parameters

      • OptionalreParse: boolean

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

      Returns Promise<void>

destroy

destroy: () => Promise<void>

销毁当前对象。

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

getDoc

getDoc: () => Promise<null | DocType>

获取文档对象。

Type declaration

    • (): Promise<null | DocType>

    • Returns Promise<null | DocType>

      返回文档对象。

getEncryptDict

getEncryptDict: () => Promise<null | PDFDictionaryType>

获取加密字典。

Type declaration

getLastObjNum

getLastObjNum: () => Promise<number>

获取最后一个对象编号。

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      返回最后一个对象编号。

getPassword

getPassword: () => Promise<string>

获取密码。

Type declaration

    • (): Promise<string>

    • Returns Promise<string>

      返回密码。

getRootObjNum

getRootObjNum: () => Promise<number>

获取根对象编号。

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      返回根对象编号。

getTrailer

getTrailer: () => Promise<null | PDFObjectType>

获取 trailer 字典。

Type declaration

isOwner

isOwner: () => Promise<boolean>

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

Type declaration

    • (): Promise<boolean>

    • Returns Promise<boolean>

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

Optionaloptions

options?: Options

setPassword

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

设置密码。

Type declaration

    • (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);
}

startParse

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

开始解析文件。

Type declaration

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

    • Parameters

      • fileName: string

        文件路径，例如 d://xxx.pdf。

      • reParse: boolean

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

      Returns Promise<number>

      返回 PDF 解析状态。如 FPD_PARSE_ERROR_SUCCESS、FPD_PARSE_ERROR_PASSWORD 等。

Example

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

Settings

Member Visibility

On This Page

Properties