Skip to content
Merged
Show file tree
Hide file tree
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
39 changes: 39 additions & 0 deletions index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
declare module "potpack" {
export interface PotpackBox {
w: number;
h: number;
/**
* X coordinate in the resulting container.
*/
x?: number;
/**
* Y coordinate in the resulting container.
*/
y?: number;
}

interface PotpackStats {
/**
* Width of the resulting container.
*/
w: number;
/**
* Height of the resulting container.
*/
h: number;
/**
* The space utilization value (0 to 1). Higher is better.
*/
fill: number;
}

/**
* Packs 2D rectangles into a near-square container.
*
* Mutates the {@link boxes} array: it's sorted by height,
* and box objects are augmented with `x`, `y` coordinates.
*/
const potpack: (boxes: PotpackBox[]) => PotpackStats;

export default potpack;
}
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"module": "index.mjs",
"unpkg": "index.js",
"jsdelivr": "index.js",
"types": "index.d.ts",
"files": [
"index.mjs",
"index.js"
Expand Down