# What changed in node-pty

> 18 changes in node-pty 1 from its official release notes, upgrade guides and advisories: 3 breaking, 3 new APIs and options. Each one cited. Sources checked 2026-10-29. HTML: https://unstale.sh/npm/node-pty/

To see which of these apply to a repository, run `npx @unstale/cli init` in it.

## node-pty 1

### Breaking changes

- The deprecated on API was removed. (1.0.0) — [release notes](https://github.com/microsoft/node-pty/releases/tag/1.0.0)
- The supported Node.js version was updated. (1.0.0) — [release notes](https://github.com/microsoft/node-pty/releases/tag/1.0.0)
- Values of 0 for uid and gid are no longer treated as undefined. (1.0.0) — [release notes](https://github.com/microsoft/node-pty/releases/tag/1.0.0)

### New APIs and options

- An opt-in experimental option enables shipping and using conpty.dll and OpenConsole.exe with the module. (1.1.0) — [release notes](https://github.com/microsoft/node-pty/releases/tag/v1.1.0)
- An accessor named ptsName was added. (1.0.0) — [release notes](https://github.com/microsoft/node-pty/releases/tag/1.0.0)
- An accessor named pty was added. (1.0.0) — [release notes](https://github.com/microsoft/node-pty/releases/tag/1.0.0)

### Behavior and default changes

- The conpty named pipe buffer size is changed to 128KiB. (1.1.0) — [release notes](https://github.com/microsoft/node-pty/releases/tag/v1.1.0)
- Writes to non-blocking ptys are handled directly instead of being wrapped through Node's tty API. (1.1.0) — [release notes](https://github.com/microsoft/node-pty/releases/tag/v1.1.0)
- The write API supports Buffer input. (1.1.0) — [release notes](https://github.com/microsoft/node-pty/releases/tag/v1.1.0)

### Tooling

- Prebuilds are included in the published package. (1.1.0) — [release notes](https://github.com/microsoft/node-pty/releases/tag/v1.1.0)

### Fixes and other changes

- Partial writes are handled when a non-blocking write returns EAGAIN. (1.1.0) — [release notes](https://github.com/microsoft/node-pty/releases/tag/v1.1.0)
- The PtyClear implementation is restored when using conpty.dll. (1.1.0) — [release notes](https://github.com/microsoft/node-pty/releases/tag/v1.1.0)
- The program name is now ensured to be part of child process arguments. (1.0.0) — [release notes](https://github.com/microsoft/node-pty/releases/tag/1.0.0)
- Parsing of the closeFDs option was corrected. (1.0.0) — [release notes](https://github.com/microsoft/node-pty/releases/tag/1.0.0)
- A fix was made for controlling the terminal on macOS. (1.0.0) — [release notes](https://github.com/microsoft/node-pty/releases/tag/1.0.0)
- IO handles are disconnected during PtyKill. (1.0.0) — [release notes](https://github.com/microsoft/node-pty/releases/tag/1.0.0)
- A fix was made for retrieving the process name on macOS. (1.0.0) — [release notes](https://github.com/microsoft/node-pty/releases/tag/1.0.0)
- The winpty conin pipe is explicitly opened in write-only mode. (1.0.0) — [release notes](https://github.com/microsoft/node-pty/releases/tag/1.0.0)
