Skip to content

Commit bf723ab

Browse files
committed
docs(generate): with meta data
1 parent 796edb0 commit bf723ab

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

packages/generate/README.md

+28-1
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,35 @@ const generaterANSI = createGeneraterANSI(new Uint8Array(file.buffer), {
5252
})
5353

5454
// display QR Code in terminal
55-
for (const blockQRCode of generaterANSI()) {
55+
for (const blockQRCode of generaterANSI.fountain()) {
5656
console.log(blockQRCode)
5757
}
5858

5959
```
60+
61+
### With meta data
62+
63+
If you want to transfer the metadata of the file:
64+
65+
```javascript
66+
import {
67+
appendFileHeaderMetaToBuffer,
68+
readFileHeaderMetaFromBuffer,
69+
} from '@qifi/generate'
70+
71+
const data = new Uint8Array(file.buffer)
72+
const meta = {
73+
filename: file.name,
74+
contentType: file.type,
75+
}
76+
const merged = appendFileHeaderMetaToBuffer(data, meta)
77+
const generater = createGeneraterUnicode(merged)
78+
79+
// Send blocks to the receiver
80+
for (const block of generater.fountain()) {
81+
// display QR Code in terminal
82+
console.log(blockQRCode)
83+
}
84+
```
85+
86+
and you can use `appendMetaToBuffer` and `readMetaFromBuffer` to add and read custom metadata.

0 commit comments

Comments
 (0)