Client to interact with the Diskio Server API

Diskio Client

An API client for diskio-server exposed with OpenAPI.

📦 Packages

📦 CommonJS

1const { DiskioAPIClient } = require('diskio-api');

📦 ESM

1import { DiskioAPIClient } from 'diskio-api';

📦 TypeScript

1import { DiskioAPIClient } from 'diskio-api';

Instance

1const client = new DiskioAPIClient('http://localhost:8080');

Health Check

Get information about the server

1const response = await client.healthCheck();
2console.log(response.data.response.diskio.size); // 10737418240

Upload

1const file: File = new File(['Hello world!'], 'hello.txt');
2const { response } = await client.upload([ file ]);
3const path = response[0];

Download

1const file = await client.download(path, type: 'arrayBuffer' | 'stream') // default download is 'arrayBuffer'
2// Work with the file
3console.log(typeof file) // 'arraybuffer' | 'stream'

Delete

1await client.delete('/path/to/file');

📝 License

This project is licensed under the GNU AFFERO GENERAL PUBLIC LICENSE - see the LICENSE file for details