Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add basic type declarations for PDF file parsing #137

Merged
merged 1 commit into from
Aug 13, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
export type InitOptions = { password?: string; debug?: boolean };
export type Error = null | string;

export type DataEntry = {
page?: number;
width?: number;
height?: number;
text?: string;
file?: {
path?: string;
buffer?: string;
};
} | null;

export type ItemHandler = (err: Error, data: DataEntry) => void;

export declare class PdfReader {
constructor(opts: InitOptions | null): PdfReader;
parseFileItems(pdfFilePath: string, itemHandler: ItemHandler): void;
parseBuffer(buffer: Buffer, itemHandler: ItemHandler): void;
}
Loading