# @meeco/file-storage-browser

> Browser module for uploading and downloading encrypted files

Latest version **5.0.3** (published 2022-11-22) · ISC license · 0 weekly downloads

## Install

```sh
npm install @meeco/file-storage-browser
pnpm add @meeco/file-storage-browser
yarn add @meeco/file-storage-browser
bun add @meeco/file-storage-browser
```

## Health

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

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

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.0.3 |
| Published | 2022-11-22 |
| First published | 2020-09-11 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 8 |
| Unpacked size | 38.7 KB |
| Known vulnerabilities | 0 (+24 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | janvereecken-meeco, dmunneke-meeco, linasisganaitis-meeco, meeco-ci |

## Links

- npm: https://www.npmjs.com/package/@meeco/file-storage-browser
- npm.io page: https://npm.io/package/@meeco/file-storage-browser

## Dependencies (8)

- [axios](https://npm.io/package/axios.md) ^0.27.2
- [process](https://npm.io/package/process.md) ^0.11.10
- [@meeco/cryppo](https://npm.io/package/@meeco/cryppo.md) 2.0.2
- [@meeco/style-kit](https://npm.io/package/@meeco/style-kit.md) ^2.0.1
- [crypto-browserify](https://npm.io/package/crypto-browserify.md) ^3.12.0
- [stream-browserify](https://npm.io/package/stream-browserify.md) ^3.0.0
- [@meeco/vault-api-sdk](https://npm.io/package/@meeco/vault-api-sdk.md) 37.6.1-develop.20221113172557.1b02443a9
- [@meeco/file-storage-common](https://npm.io/package/@meeco/file-storage-common.md) ^5.0.3

## Recent versions

- 5.0.3 (latest) — 2022-11-22
- 5.0.4-beta (beta) — 2023-03-13
- 5.0.1 — 2021-07-30
- 5.0.1-beta — 2021-07-29
- 5.0.0 — 2021-07-21
- 5.0.0-beta — 2021-05-28
- 3.2.1 — 2021-03-08
- 3.2.1-beta — 2021-03-08
- 3.2.0-beta.1 — 2021-03-03
- 3.2.0-beta — 2021-03-02
- 3.1.1 — 2021-02-16
- 3.1.0 — 2021-02-16
- 3.0.3-beta — 2021-02-15
- 3.1.0-beta — 2021-01-18
- 3.0.2-beta — 2020-11-27
- … 18 more at https://npm.io/package/@meeco/file-storage-browser/versions

## README

# @meeco/file-storage-browser

This file storage code has been seperated out of the main `@meeco/sdk` to keep it smaller.

## Installation

```sh
npm install -S @meeco/file-storage-browser
```

## Basic Usage

### File Upload

```ts
const { attachment, dek } = await fileUploadBrowser({
  file: file,
  vaultUrl: vaultUrl,
  vaultAccessToken: vaultAccessToken,
  subscriptionKey: subscriptionKey,
  videoCodec: videoCodec,
  progressUpdateFunc: (chunkBuffer: ArrayBuffer | null, percentageComplete: number) => {
    // do something with chunkBuffer or percentageComplete
  },
});
```

### File Download

```ts
const downloadedFile = await fileDownloadBrowser({
  attachmentId: attachmentSlot?.attachment_id,
  dek: attachmentSlot?.value,
  vaultUrl,
  vaultAccessToken,
  subscriptionKey,
  progressUpdateFunc: (
    chunkBuffer: ArrayBuffer | null,
    percentageComplete: number,
    videoCodec?: string
  ) => {
    // do something with chunkBuffer, percentageComplete, or videoCodec (e.g. can be used for video streaming)
  },
});
const fileUrl = URL.createObjectURL(downloadedFile);
```

### More detailed usage

Please see the detailed usage in the `demo` project in this repository (specifically `demo/index.ts`)

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