# @delta-storage/sdk

> Official SDK for [Delta Storage App](https://app.delta.storage/)

Latest version **0.2.27** (published 2024-09-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @delta-storage/sdk
pnpm add @delta-storage/sdk
yarn add @delta-storage/sdk
bun add @delta-storage/sdk
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.27 |
| Published | 2024-09-21 |
| First published | 2023-09-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=18 |
| Dependencies | 3 |
| Unpacked size | 699.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Delta Storage |
| Maintainers | yell66w, glendell03, frnzgs, valsamonte, alvinreyes |

## Links

- npm: https://www.npmjs.com/package/@delta-storage/sdk
- Repository: https://github.com/delta-storage/sdk
- Homepage: https://github.com/delta-storage/sdk#readme
- Issues: https://github.com/delta-storage/sdk/issues
- npm.io page: https://npm.io/package/@delta-storage/sdk

## Dependencies (3)

- [axios](https://npm.io/package/axios.md) ^1.5.0
- [utf-8-validate](https://npm.io/package/utf-8-validate.md) ^6.0.3
- [socket.io-client](https://npm.io/package/socket.io-client.md) ^4.7.2

## Recent versions

- 0.2.27 (latest) — 2024-09-21
- 0.2.0-beta.0.2.0 (beta) — 2024-02-05
- 0.2.26 — 2024-08-11
- 0.2.25 — 2024-08-06
- 0.2.24 — 2024-07-31
- 0.2.23 — 2024-07-30
- 0.2.22 — 2024-07-16
- 0.2.21 — 2024-07-15
- 0.2.2 — 2024-06-29
- 0.1.2 — 2023-12-04
- 0.1.1-beta.3 — 2023-12-04
- 0.2.0 — 2023-12-04
- 0.2.0-beta.1 — 2023-12-04
- 0.1.1-beta.2 — 2023-11-30
- 0.1.1-beta.1 — 2023-11-24
- … 40 more at https://npm.io/package/@delta-storage/sdk/versions

## README

# Delta Storage SDK

Official SDK for [Delta Storage App](https://app.delta.storage/)

![deltaui](https://github.com/delta-storage/sdk/assets/71435340/557ee2c4-c0ca-4d25-8792-8e9b6002cffc)

## Introduction

This [Documentation](https://delta-storage.readme.io/reference/quick-start) provides detailed information on how to use delta storage developer tools to interact with directories and files in your application.

## Installation

You can install the Delta Storage SDK using your preferred package manager:

```
npm install --save @delta-storage/sdk
```

```
yarn add --save @delta-storage/sdk
```

## Getting Started

To start using the Delta Storage SDK, you need to acquire your API_KEY from your [app.delta.storage](https://app.delta.storage/) account. Once you have your API_KEY, Here's how you can get started:

```typescript
import DeltaStorageSDK from '@delta-storage/sdk'

const deltaStorage = new DeltaStorageSDK({
  apiKey: 'YOUR API KEY'
})
```

## Usage

Once you've set up your instance, using the Delta Storage SDK is easy as follows:

- Drives Management
  - [createDrive](https://delta-storage.readme.io/reference/createdirectory)
  - [listAllDrives](https://delta-storage.readme.io/reference/createdrive)
  - [readDriveSize](https://delta-storage.readme.io/reference/readdrivesize)
  - [viewDriveContents](https://delta-storage.readme.io/reference/viewdrivecontents)
  - [downloadDriveAsZip](https://delta-storage.readme.io/reference/downloaddriveaszip)
  - [renameDrive](https://delta-storage.readme.io/reference/renamedrive)
  - [moveToDrive](https://delta-storage.readme.io/reference/movetodrive)
  - [deleteDrive](https://delta-storage.readme.io/reference/deletedrive)
- Directory Management
  - [createDirectory](https://delta-storage.readme.io/reference/createdirectory)
  - [readDirectory](https://delta-storage.readme.io/reference/readdirectory)
  - [readDirectorySize](https://delta-storage.readme.io/reference/readdirectorysize)
  - [readDirectoryBySegment](https://delta-storage.readme.io/reference/readdirectorybysegment)
  - [getDirectoryAsZip](https://delta-storage.readme.io/reference/getdirectoryaszip)
  - [downloadDirectoryAsZip](https://delta-storage.readme.io/reference/downloaddirectoryaszip)
  - [move](https://delta-storage.readme.io/reference/move)
  - [renameDirectory](https://delta-storage.readme.io/reference/renamedirectory)
  - [deleteDirectory](https://delta-storage.readme.io/reference/deletedirectory)
- File Management
  - [uploadFile](https://delta-storage.readme.io/reference/uploadfile)
  - [uploadMultipleFiles](https://delta-storage.readme.io/reference/uploadfiles)
  - [readFile](https://delta-storage.readme.io/reference/readfile)
  - [renameFile](https://delta-storage.readme.io/reference/renamefile)
  - [updateFile](https://delta-storage.readme.io/reference/updatefile)
  - [deleteFile](https://delta-storage.readme.io/reference/deletefile)
  - [getFileReplications](https://delta-storage.readme.io/reference/getfilereplications)
  - [getIPFSFileMetadata](https://delta-storage.readme.io/reference/getipfsfilemetadata)
  - [getSiaFileMetadata](https://delta-storage.readme.io/reference/getsiafilemetadata)
  - [getDataURI](https://delta-storage.readme.io/reference/getdatauri)
  - [addFileAccess](https://delta-storage.readme.io/reference/addfileaccess)
  - [readFileAccess](https://delta-storage.readme.io/reference/readfileaccess)
  - [verifyFileAccessPassword](https://delta-storage.readme.io/reference/verifyfileaccesspassword)
  - [updateFileAccess](https://delta-storage.readme.io/reference/updatefileaccess)
  - [deleteFileAccess](https://delta-storage.readme.io/reference/deletefileaccess)
- Account
  - [getTotalSize](https://delta-storage.readme.io/reference/gettotalsize) (Storage Used)
  - [readStorage](https://delta-storage.readme.io/reference/readstorage) (Storage Capacity)
  - [readSettings](https://delta-storage.readme.io/reference/readsettings)
  - [updateSettings](https://delta-storage.readme.io/reference/updatesettings)

## Troubleshooting

Problem: Unauthorized error when performing an operation. <br/>
Solution: Ensure that your API key has the necessary permissions for the operation you're trying to perform.

## License

[MIT](https://github.com/delta-storage/sdk/blob/main/LICENSE)

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