# path2d

> Path2D API for node. Can be used for server-side rendering with canvas

Latest version **0.3.5** (published 2026-11-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install path2d
pnpm add path2d
yarn add path2d
bun add path2d
```

## Health

**Score 65/100 (B)** — status: active.

Positive: esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads; no types; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.3.5 |
| Published | 2026-11-16 |
| First published | 2024-03-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=6 |
| Dependencies | 0 |
| Unpacked size | 117.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 32 |
| Author | nilzona |
| Maintainers | nilzona_user |
| Keywords | Path2D, polyfill, canvas, roundRect |

## Links

- npm: https://www.npmjs.com/package/path2d
- Repository: https://github.com/nilzona/path2d-polyfill
- Homepage: https://github.com/nilzona/path2d-polyfill#readme
- Issues: https://github.com/nilzona/path2d-polyfill/issues
- npm.io page: https://npm.io/package/path2d

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 0.3.5 (latest) — 2026-11-16
- 0.3.4 — 2026-08-20
- 0.3.3 — 2026-06-16
- 0.3.1 — 2025-06-24
- 0.3.0 — 2025-06-24
- 0.2.2 — 2024-11-07
- 0.2.1 — 2024-06-29
- 0.2.0 — 2024-04-04
- 0.1.2 — 2024-03-17
- 0.1.1 — 2024-03-16
- 0.0.1 — 2024-03-16

## README

# path2d

[![CI](https://github.com/nilzona/path2d-polyfill/actions/workflows/ci.yml/badge.svg)](https://github.com/nilzona/path2d-polyfill/actions/workflows/ci.yml)

Implements `Path2D` api and `roundRect` for CanvasRenderingContext2D

## Usage

```shell
npm install --save path2d
```

## Use in a node environment

The package exports a few functions that can be used in a node environment:

- `Path2D` - class to create Path2D objects used by the polyfill methods
- `parsePath` - function for parsing an SVG path string into canvas commands
- `roundRect` - implementation of roundRect using canvas commands
- `applyPath2DToCanvasRenderingContext` - Adds Path2D functions (if needed) to a CanvasRenderingContext and augments the fill, stroke and clip command
- `applyRoundRectToCanvasRenderingContext2D` - Adds roundRect function (if needed) to a CanvasRenderingContext

```js
import { Path2D } from "path2d";
```

### usage with node-canvas

To get Path2D features with the [node-canvas library](https://github.com/Automattic/node-canvas) use the following pattern:

```js
const { createCanvas, CanvasRenderingContext2D } = require("canvas");
const { applyPath2DToCanvasRenderingContext, Path2D } = require("path2d");

applyPath2DToCanvasRenderingContext(CanvasRenderingContext2D);
// Path2D features has now been added to CanvasRenderingContext2D

const canvas = createCanvas(200, 200);
const ctx = canvas.getContext("2d");

const p = new Path2D("M10 10 l 20 0 l 0 20 Z");
ctx.fillStyle = "green";
ctx.fill(p);
```

A working example of a node express server that serves an image drawn with canvas [can be seen here](https://gist.github.com/nilzona/e611c99336d8ea1f645bd391a459c24f)

## Support table

| Method               | Supported |
| -------------------- | :-------: |
| constructor(SVGPath) |    Yes    |
| addPath()            |    Yes    |
| closePath()          |    Yes    |
| moveTo()             |    Yes    |
| lineTo()             |    Yes    |
| bezierCurveTo()      |    Yes    |
| quadraticCurveTo()   |    Yes    |
| arc()                |    Yes    |
| ellipse()            |    Yes    |
| rect()               |    Yes    |
| roundRect()          |    Yes    |

## See it in action

Clone [path2d-polyfill](https://github.com/nilzona/path2d-polyfill)

```shell
pnpm install
pnpm dev
```

open <http://localhost:5173/> to see the example page.

## Contributing

Recommended to use vscode with the prettier extension to keep formatting intact.

---
_Source: https://npm.io/package/path2d · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
