Files

Julien Fontanet 2a70ebf667 docs: uniformize code blocks

- add missing syntaxes
- don't put prompt if no command outputs to ease copy/paste and use `sh` syntax
- always use `$` as prompt and use `console` syntax

2023-02-06 11:25:12 +01:00

1.4 KiB

Raw Blame History

@vates/nbd-client

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.

1.4 KiB Raw Blame History