From 3371a40c6f92b72a593ff86a2b949958b6e83554 Mon Sep 17 00:00:00 2001 From: taoqf Date: Thu, 8 Nov 2018 15:38:25 +0800 Subject: [PATCH 1/3] add typedefinition for pdf2image --- types/pdf2image/index.d.ts | 53 ++++++++++++++++++++++++++++++ types/pdf2image/pdf2image-tests.ts | 8 +++++ types/pdf2image/tsconfig.json | 23 +++++++++++++ types/pdf2image/tslint.json | 1 + 4 files changed, 85 insertions(+) create mode 100644 types/pdf2image/index.d.ts create mode 100644 types/pdf2image/pdf2image-tests.ts create mode 100644 types/pdf2image/tsconfig.json create mode 100644 types/pdf2image/tslint.json diff --git a/types/pdf2image/index.d.ts b/types/pdf2image/index.d.ts new file mode 100644 index 0000000000..90dda0953b --- /dev/null +++ b/types/pdf2image/index.d.ts @@ -0,0 +1,53 @@ +// Type definitions for pdf2image 1.2 +// Project: https://bitbucket.org/RicardoCacheira/pdf2image#readme +// Definitions by: taoqf +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +// TypeScript Version: 2.9 + +/** + * A token starts with the character '%' + * + * d - the page number, if the first page of the PDF is page 1 + * D - the page number, if the first page of the PDF is page 0 + * i - the processed page number, if the first processed page is page 1 + * I - the processed page number, if the first processed page is page 0 + * t - the total number of pages in the pdf + * T - the total of processed pages + * s - the name of the pdf file + * p - the path of the pdf file + * % - the character '%' + * {...} - a custom piece of code where all of the above values can be used + */ + +/// + +export type OutputFormat = ((page_num: number, page_index: number, totalPagesProcessed: number, totalPDFPages: number, name: string, path: string, vm: typeof import ('vm')) => string) | string; + +export interface Options { + density: number; + height: number; + width: number; + outputType: 'jpg' | 'png' | '.jpg' | '.png'; + quality: number; + pages: '*' | string; // * | even | odd | '/1,/3,5-6,-8, 9-' + singleProcess: boolean; + backgroundColor: string; // #ffffff + outputFormat: OutputFormat; +} + +export interface ConvertedFile { + page: number; + index: number; + name: string; + path: string; +} + +export function convertPDF(pdfFilePath: string, options?: Partial): Promise; + +export interface Converter { + convertPDF(pdfFilePath: string): Promise; + convertPDFList(pdfList: string[]): Promise; +} + +export function compileConverter(options?: Partial): Converter; diff --git a/types/pdf2image/pdf2image-tests.ts b/types/pdf2image/pdf2image-tests.ts new file mode 100644 index 0000000000..5b12192b2d --- /dev/null +++ b/types/pdf2image/pdf2image-tests.ts @@ -0,0 +1,8 @@ +import { convertPDF } from 'pdf2image'; + +// converts all the pages of the given pdf using the default options +convertPDF('example.pdf').then( + (pageList) => { + console.log(pageList); + } +); diff --git a/types/pdf2image/tsconfig.json b/types/pdf2image/tsconfig.json new file mode 100644 index 0000000000..9593266a66 --- /dev/null +++ b/types/pdf2image/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "strictFunctionTypes": true, + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "pdf2image-tests.ts" + ] +} \ No newline at end of file diff --git a/types/pdf2image/tslint.json b/types/pdf2image/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/pdf2image/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } From e0537dcd7620ad53bb08d39801d21aacf3417cd9 Mon Sep 17 00:00:00 2001 From: taoqf Date: Fri, 9 Nov 2018 10:04:20 +0800 Subject: [PATCH 2/3] change variant name --- types/pdf2image/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/pdf2image/index.d.ts b/types/pdf2image/index.d.ts index 90dda0953b..d9255721a7 100644 --- a/types/pdf2image/index.d.ts +++ b/types/pdf2image/index.d.ts @@ -22,7 +22,7 @@ /// -export type OutputFormat = ((page_num: number, page_index: number, totalPagesProcessed: number, totalPDFPages: number, name: string, path: string, vm: typeof import ('vm')) => string) | string; +export type OutputFormat = ((pageNum: number, pageIndex: number, totalPagesProcessed: number, totalPDFPages: number, name: string, path: string, vm: typeof import('vm')) => string) | string; export interface Options { density: number; From 0ee1082e87acaf41c7ef060d3cb060dd3ec5f18f Mon Sep 17 00:00:00 2001 From: taoqf Date: Fri, 9 Nov 2018 10:06:08 +0800 Subject: [PATCH 3/3] add whitespace --- types/pdf2image/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/pdf2image/index.d.ts b/types/pdf2image/index.d.ts index d9255721a7..b02ccb8852 100644 --- a/types/pdf2image/index.d.ts +++ b/types/pdf2image/index.d.ts @@ -22,7 +22,7 @@ /// -export type OutputFormat = ((pageNum: number, pageIndex: number, totalPagesProcessed: number, totalPDFPages: number, name: string, path: string, vm: typeof import('vm')) => string) | string; +export type OutputFormat = ((pageNum: number, pageIndex: number, totalPagesProcessed: number, totalPDFPages: number, name: string, path: string, vm: typeof import ('vm')) => string) | string; export interface Options { density: number;