# @vates/nbd-client

Latest version **3.5.1** (published 2026-08-28) · ISC license · 0 weekly downloads

## Install

```sh
npm install @vates/nbd-client
pnpm add @vates/nbd-client
yarn add @vates/nbd-client
bun add @vates/nbd-client
```

## Health

**Score 55/100 (C)** — status: active.

Positive: no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 3.5.1 |
| Published | 2026-08-28 |
| First published | 2022-10-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=14.0 |
| Dependencies | 7 |
| Unpacked size | 27.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 985 |
| Author | Vates SAS |
| Maintainers | florent.beauchamp, mathieura, julien-f, marsaud, pdonias, tgoettelmann, enishowk, b-nollet, mlssfrncjrg, arnogues, joris-k, elise-f, nathanael-h, olivier.f, pierre.brunet289 |

## Links

- npm: https://www.npmjs.com/package/@vates/nbd-client
- Repository: https://github.com/vatesfr/xen-orchestra
- Homepage: https://github.com/vatesfr/xen-orchestra/tree/master/@vates/nbd-client
- Issues: https://github.com/vatesfr/xen-orchestra/issues
- npm.io page: https://npm.io/package/@vates/nbd-client

## Dependencies (7)

- [xen-api](https://npm.io/package/xen-api.md) ^4.9.0
- [promise-toolbox](https://npm.io/package/promise-toolbox.md) ^0.21.0
- [@vates/async-each](https://npm.io/package/@vates/async-each.md) ^1.0.3
- [@vates/read-chunk](https://npm.io/package/@vates/read-chunk.md) ^1.2.1
- [@xen-orchestra/log](https://npm.io/package/@xen-orchestra/log.md) ^0.7.2
- [@xen-orchestra/async-map](https://npm.io/package/@xen-orchestra/async-map.md) ^0.1.4
- [@xen-orchestra/disk-transform](https://npm.io/package/@xen-orchestra/disk-transform.md) ^1.3.3

## Recent versions

- 3.5.1 (latest) — 2026-08-28
- 3.5.0 — 2026-08-04
- 3.4.0 — 2026-04-24
- 3.3.0 — 2026-03-27
- 3.2.3 — 2026-01-29
- 3.2.2 — 2025-11-27
- 3.2.1 — 2025-08-28
- 3.2.0 — 2025-08-27
- 3.1.4 — 2025-07-03
- 3.1.3 — 2025-05-23
- 3.1.2 — 2024-11-07
- 3.1.1 — 2024-10-28
- 3.1.0 — 2024-07-25
- 3.0.2 — 2024-05-30
- 3.0.1 — 2024-03-27
- … 8 more at https://npm.io/package/@vates/nbd-client/versions

## README

<!-- DO NOT EDIT MANUALLY, THIS FILE HAS BEEN GENERATED -->

# @vates/nbd-client

[![Package Version](https://badgen.net/npm/v/@vates/nbd-client)](https://npmjs.org/package/@vates/nbd-client) ![License](https://badgen.net/npm/license/@vates/nbd-client) [![PackagePhobia](https://badgen.net/bundlephobia/minzip/@vates/nbd-client)](https://bundlephobia.com/result?p=@vates/nbd-client) [![Node compatibility](https://badgen.net/npm/node/@vates/nbd-client)](https://npmjs.org/package/@vates/nbd-client)

## Install

Installation of the [npm package](https://npmjs.org/package/@vates/nbd-client):

```sh
npm install --save @vates/nbd-client
```

## Usage

### `new NdbClient({address, exportname, secure = true, port = 10809})`

create a new nbd client

```js
import NbdClient from '@vates/nbd-client'
const client = new NbdClient({
  address: 'MY_NBD_HOST',
  exportname: 'MY_SECRET_EXPORT',
  cert: 'Server certificate', // optional, will use encrypted link if provided
})

await client.connect()
const block = await client.readBlock(blockIndex, BlockSize)
await client.disconnect()
```

## Contributions

Contributions are _very_ welcomed, either on the documentation or on
the code.

You may:

- report any [issue](https://github.com/vatesfr/xen-orchestra/issues)
  you've encountered;
- fork and create a pull request.

## License

[ISC](https://spdx.org/licenses/ISC) © [Vates SAS](https://vates.fr)

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