Skip to content

Updated and fixed the types #78

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.

Sign up for GitHub

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

Open
linusbrolin wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Updated and fixed the types #78

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
edcd9b6
fixed wrong types
linusbrolin Sep 25, 2023
d0fb31d
added missing types
linusbrolin Sep 25, 2023
60ce6f4
fixed imports/exports
linusbrolin Sep 25, 2023
2cfc3e7
fixed wrong typing
linusbrolin Sep 25, 2023
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
60 changes: 38 additions & 22 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,40 @@
declare module 'pdfkit-table'
{
import PDFDocument from 'pdfkit';
import * as PDFDocument from 'pdfkit';

interface Rect {
export interface Rect {
x: number;
y: number;
width: number;
height: number;
}

interface Header {
export interface RowOptions {
columnColor?: string;
columnOpacity?: number;
backgroundColor?: string;
backgroundOpacity?: number;
background?: {
color: string;
opacity: number;
}
separation?: boolean;
}

export interface DataOptions {
fontSize?: number;
fontFamily?: string;
color?: string;
}

export type Data = {
[key: string]: string | { label: string; options?: DataOptions; };
} | {
[key: string]: any;
options?: RowOptions;
};

export interface Header {
label?: string;
property?: string;
width?: number;
Expand All @@ -24,50 +49,40 @@ declare module 'pdfkit-table'
value: any,
indexColumn?: number,
indexRow?: number,
row?: number,
row?: Data,
rectRow?: Rect,
rectCell?: Rect
) => string;
}

interface DataOptions {
fontSize: number;
fontFamily: string;
separation: boolean;
}

interface Data {
[key: string]: string | { label: string; options?: DataOptions };
}

interface Table {
export interface Table {
title?: string;
subtitle?: string;
headers?: (string | Header)[];
datas?: Data[];
rows?: string[][];
}

interface DividerOptions {
export interface DividerOptions {
disabled?: boolean;
width?: number;
opacity?: number;
}

interface Divider {
export interface Divider {
header?: DividerOptions;
horizontal?: DividerOptions;
}

interface Title
export interface Title
{
label: string;
fontSize?: number;
fontFamily?: string;
color?: string;
}

interface Options {
export interface Options {
title?: string | Title ;
subtitle?: string | Title;
width?: number;
Expand All @@ -76,7 +91,7 @@ declare module 'pdfkit-table'
divider?: Divider;
columnsSize?: number[];
columnSpacing?: number; //default 5
padding?: number[];
padding?: number | number[];
addPage?: boolean; //default false
hideHeader?: boolean;
minRowHeight?: number;
Expand All @@ -90,8 +105,9 @@ declare module 'pdfkit-table'
) => PDFDocumentWithTables;
}

class PDFDocumentWithTables extends PDFDocument {
public table(table: Table, options?: Options): Promise<void>;
export class PDFDocumentWithTables extends PDFDocument {
public addBackground(rect: Rect, fillColor: string, fillOpacity: number, callback?: (doc: PDFDocumentWithTables) => void): void;
public table(table: Table, options?: Options, callback?: (doc: PDFDocumentWithTables) => void): Promise<void>;
}

// export = PDFDocumentWithTables;
Expand Down