Skip to content

[pull] master from DefinitelyTyped:master #1339

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

Merged
pull merged 2 commits into from
Sep 4, 2025
Merged

[pull] master from DefinitelyTyped:master #1339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7b66b88
🤖 Merge PR #73406 [@types/pdfkit] Further define table related proper…
BenAldebert Sep 4, 2025
f9ce87b
🤖 dprint fmt
typescript-bot Sep 4, 2025
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
105 changes: 70 additions & 35 deletions types/pdfkit/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,42 @@ declare namespace PDFKit.Mixins {

type BoundingBox = [number, number, number, number];

type SizeUnits =
| "em"
| "in"
| "px"
| "cm"
| "mm"
| "pc"
| "ex"
| "ch"
| "rem"
| "vw"
| "vmin"
| "vmax"
| "%"
| "pt";

type Size = number | `${number}` | `${number}${SizeUnits}`;

type Wideness = Size | boolean;

type Sides<T> = T | [T, T] | [T, T, T, T] | SlightlyExpandedSides<T> | ExpandedSides<T>;

type PartialSides<T> = T | [T, T] | [T, T, T, T] | Partial<SlightlyExpandedSides<T>> | Partial<ExpandedSides<T>>;

interface SlightlyExpandedSides<T> {
vertical: T;
horizontal: T;
}

interface ExpandedSides<T> {
top: T;
right: T;
bottom: T;
left: T;
}

interface PDFColor {
fillColor(color: ColorValue, opacity?: number): this;
strokeColor(color: ColorValue, opacity?: number): this;
Expand All @@ -361,6 +397,7 @@ declare namespace PDFKit.Mixins {
font(src: PDFFontSource, size?: number): this;
font(src: PDFFontSource, family: string, size?: number): this;
fontSize(size: number): this;
sizeToPoint(size: Size, defaultValue?: number, page?: PDFPage, percentageWidth?: number): number;
currentLineHeight(includeGap?: boolean): number;
/** Helpful method to give a font an alias, eg: `registerFont('bold', './Roboto.ttf')` */
registerFont(
Expand Down Expand Up @@ -399,22 +436,26 @@ declare namespace PDFKit.Mixins {
}

interface CellStyle {
/** The text stroke (default 0) */
textStroke?: number | boolean;
/** Sets the text stroke color of the cells text (default black) */
textStrokeColor?: ColorValue;
/** Sets the text color of the cells text (default black) */
textColor?: ColorValue;
/** The border for the cell (default 1pt) */
border?: boolean | number | Array<boolean | number> | {
top?: number;
right?: number;
bottom?: number;
left?: number;
} | undefined;
border?: PartialSides<Wideness> | undefined;
/** The border colors for the cell (default black) */
borderColor?: string | Array<string> | {
top?: ColorValue;
right?: ColorValue;
bottom?: ColorValue;
left?: ColorValue;
};
borderColor?: PartialSides<ColorValue>;
/** Set the background color of the cell */
backgroundColor?: ColorValue;
/** The padding for the cell (default 0.25em) */
padding?: Sides<Wideness>;
/** The alignment of the cell text (default {x: 'left', y: 'top'}) */
align?: "center" | ExpandedAlign;
/** Sets any text options you wish to provide (such as rotation) */
textOptions?: TextOptions;
/** Whether to show the debug lines for the cell (default false) */
debug?: boolean;
}

interface TableOptions {
Expand All @@ -423,9 +464,13 @@ declare namespace PDFKit.Mixins {
/** The maximum width the table can expand to (defaults to the remaining content width (offset from the tables position)) */
maxWidth?: number;
/** Column definitions of the table. (default auto) */
columnStyles?: number | Array<number | string> | CellStyle | ((row: number) => number | CellStyle | undefined);
columnStyles?:
| number
| Array<number | string>
| ColumnStyle
| ((row: number) => number | ColumnStyle | undefined);
/** Row definitions of the table. (default *) */
rowStyles?: number | Array<number | string> | CellStyle | ((row: number) => number | CellStyle | undefined);
rowStyles?: number | Array<number | string> | RowStyle | ((row: number) => number | RowStyle | undefined);
/** Defaults to apply to every cell */
defaultStyle?:
& (number | Array<number | string> | CellStyle | ((row: number) => number | CellStyle | undefined))
Expand All @@ -451,27 +496,13 @@ declare namespace PDFKit.Mixins {
rowSpan?: number;
/** How many columns this cell covers, follows the same logic as HTML colspan */
colSpan?: number;
/** The padding for the cell (default 0.25em) */
padding?: string;
/** Font options for the cell */
font?: any;
/** The alignment of the cell text (default {x: 'left', y: 'top'}) */
align?: "center" | ExpandedAlign;
/** The text stroke (default 0) */
textStroke?: number | boolean;
/** Sets the text stroke color of the cells text (default black) */
textStrokeColor?: ColorValue;
/** Sets the text color of the cells text (default black) */
textColor?: ColorValue;
font?: { src?: PDFFontSource; family?: string; size?: number };
/** Sets the cell type (for accessibility) (default TD) */
type?: string;
/** Sets any text options you wish to provide (such as rotation) */
textOptions?: TextOptions;
/** Whether to show the debug lines for the cell (default false) */
debug?: boolean;
type?: "TD" | "TH";
}

interface ColumnOptions extends CellOptions {
interface ColumnStyle extends CellStyle {
/** The width of the column (default *) */
width?: string | number;
/** The minimum width of the column (default 0) */
Expand All @@ -480,7 +511,7 @@ declare namespace PDFKit.Mixins {
maxWidth?: string | number;
}

interface RowOptions extends CellOptions {
interface RowBase {
/** The height of the row (default auto) */
height?: string | number;
/** The minimum height of the row (default 0) */
Expand All @@ -489,6 +520,10 @@ declare namespace PDFKit.Mixins {
maxHeight?: string | number;
}

interface RowStyle extends CellStyle, RowBase {}

interface RowOptions extends CellOptions, RowBase {}

interface PDFTableObject {
/** Add a row of data (null and undefined are not rendered) */
row(data: Array<string | undefined | null | RowOptions>): this;
Expand Down Expand Up @@ -803,8 +838,8 @@ declare namespace PDFKit {
pdfVersion?: "1.3" | "1.4" | "1.5" | "1.6" | "1.7" | "1.7ext3" | undefined;
autoFirstPage?: boolean | undefined;
size?: number[] | string | undefined;
margin?: number | undefined;
margins?: { top: number; left: number; bottom: number; right: number } | undefined;
margin?: PDFKit.Mixins.Size | undefined;
margins?: PDFKit.Mixins.ExpandedSides<PDFKit.Mixins.Size> | undefined;
layout?: "portrait" | "landscape" | undefined;
font?: string | undefined;

Expand Down Expand Up @@ -925,7 +960,7 @@ declare namespace PDFKit {
interface PDFPage {
size: string;
layout: string;
margins: { top: number; left: number; bottom: number; right: number };
margins: PDFKit.Mixins.ExpandedSides<number>;
width: number;
height: number;
document: PDFDocument;
Expand Down
6 changes: 6 additions & 0 deletions types/pdfkit/pdfkit-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -560,6 +560,12 @@ doc.table({
],
});

doc.table({
data: [["col 1", "col 2", "col 3"]],
rowStyles: { minHeight: 20 },
columnStyles: { maxWidth: 50 },
});

doc.text("Scale", { align: "justify" });

doc.text("Baseline - string literal", { baseline: "alphabetic" });
Expand Down