xen-orchestra/@vates/nbd-client
2024-02-02 12:52:11 +01:00
..
tests test(nbd-client): add test for unaligned export size 2023-12-19 15:28:32 +01:00
.npmignore feat(nbd-client): first implementation (#6444) 2022-10-12 14:46:16 +02:00
.USAGE.md feat(nbd-client): first implementation (#6444) 2022-10-12 14:46:16 +02:00
constants.mjs chore(nbd-client): convert to ESM 2023-07-19 10:46:05 +02:00
index.mjs fix(nbd-client): better handling of multiple disconnection 2023-12-19 15:28:32 +01:00
multi.mjs chore: format with Prettier 2024-01-11 09:57:28 +01:00
package.json chore: update to tap@18 2024-02-02 12:52:11 +01:00
README.md docs: uniformize code blocks 2023-02-06 11:25:12 +01:00

@vates/nbd-client

Package Version License PackagePhobia Node compatibility

Install

Installation of the npm package:

npm install --save @vates/nbd-client

Usage

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

create a new nbd client

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 you've encountered;
  • fork and create a pull request.

License

ISC © Vates SAS