Skip to content

Commit

Permalink
docs: Update README (#380)
Browse files Browse the repository at this point in the history
  • Loading branch information
rrr523 authored Oct 20, 2023
1 parent 3912667 commit 91ca102
Showing 1 changed file with 40 additions and 1 deletion.
41 changes: 40 additions & 1 deletion packages/file-handle/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,43 @@

WASM module that handle file, such as `checksums` method.

* [ ] Nodejs `checksums` need support pass Buffer
## Usage on Nodejs

```javascript
const fs = require('fs')
const { getCheckSums } = require('@bnb-chain/greenfiled-file-handle');
const fileBuffer = fs.readFileSync('./CHANGELOG.md');

(async () => {
const { contentLength, expectCheckSums } = await getCheckSums(fileBuffer);
})()
```

Full Code: https://github.com/bnb-chain/greenfield-js-sdk/blob/main/examples/nodejs/storage.js

## Usage on Browser

load wasm:

```html
<script src="https://unpkg.com/@bnb-chain/[email protected]/dist/browser/umd/index.js"></script>
<script
window.__PUBLIC_FILE_HANDLE_WASM_PATH__ = 'https://unpkg.com/@bnb-chain/[email protected]/dist/node/file-handle.wasm'`,
}}
></script>
```

execute wasm:

```javascript
(async () => {
// file is from input element
const fileBytes = await file.arrayBuffer();
const hashResult = await (window as any).FileHandle.getCheckSums(
new Uint8Array(fileBytes),
);
const { contentLength, expectCheckSums } = hashResult;
})()
```

Full Code: https://github.com/bnb-chain/greenfield-js-sdk/blob/main/examples/nextjs/src/components/object/create/index.tsx#L63

0 comments on commit 91ca102

Please sign in to comment.