feat: data helpers usage (#46)

* feat: data helpers usage

* chore: change wording

Co-authored-by: Attila Gazso <[email protected]>

Author: AuHau

docs/user-documentation/pss.md

@@ -124,7 +124,7 @@ As a recipient, you have two ways how to receive the message. If you are expecti
 ```ts
 const message = await bee.pssReceive('topic')
 
-console.log(new TextDecoder("utf-8").decode(message)) // prints the received message
+console.log(message.text()) // prints the received message
 ```
 
   </TabItem>
@@ -133,7 +133,7 @@ console.log(new TextDecoder("utf-8").decode(message)) // prints the received mes
 ```js
 const message = await bee.pssReceive('topic')
 
-console.log(new TextDecoder("utf-8").decode(message)) // prints the received message
+console.log(message.text()) // prints the received message
 ```
 
   </TabItem>
@@ -153,7 +153,7 @@ If you want to subscribe to multiple messagees, use the `pssSubscribe` method.
 
 ```ts
 const handler = {
-  onMessage: (message: Uint8Array) => {console.log(new TextDecoder("utf-8").decode(message))},
+  onMessage: (message: Data) => {console.log(message.text())},
   onError: (error: BeeError) => {console.log(error)}
 }
 
@@ -169,7 +169,7 @@ subscription.cancel()
 
 ```js
 const handler = {
-  onMessage: (message: Uint8Array) => {console.log(new TextDecoder("utf-8").decode(message))},
+  onMessage: (message: Data) => {console.log(message.text())},
   onError: (error: BeeError) => {console.log(error)}
 }
 

docs/user-documentation/upload-download.md

@@ -16,6 +16,13 @@ Uploading your data to Swarm is easy with `bee-js`. Based on your needs you can
 ### Data
 
 You can upload and retrieve any `string` or `Uint8Array` data with [`uploadData`](./api/classes/bee#uploaddata) and [`downloadData`](./api/classes/bee#downloaddata) functions.
+
+When you download data the return type is [`Data`](./api/types/data) interface which extends `Uint8Array` with convenience functions like:
+
+ - `text()` that converts the bytes into UTF-8 encoded string
+ - `hex()` that converts the bytes into **non-prefixed** hex string
+ - `json()` that converts the bytes into JSON object
+
 <Tabs
   groupId="lang_preferrence"
   defaultValue="ts"
@@ -34,7 +41,7 @@ console.log(hash)
 
 const retrievedData = await bee.downloadData(hash)
 
-console.log(new TextDecoder("utf-8").decode(retrievedData)) // prints 'Bee is awesome!'
+console.log(retrievedData.text()) // prints 'Bee is awesome!'
 ```
 
   </TabItem>
@@ -49,7 +56,7 @@ console.log(hash)
 
 const retrievedData = await bee.downloadData(hash)
 
-console.log(new TextDecoder("utf-8").decode(retrievedData)) // prints 'Bee is awesome!'
+console.log(retrievedData.text()) // prints 'Bee is awesome!'
 ```
 
   </TabItem>
@@ -78,7 +85,7 @@ const retrievedFile = await bee.downloadFile(hash)
 
 console.log(retrievedFile.name) // prints 'textfile.txt'
 console.log(retrievedFile.contentType) // prints 'application/octet-stream'
-console.log(new TextDecoder("utf-8").decode(retrievedFile.data)) // prints 'Bee is awesome!'
+console.log(retrievedFile.data.text()) // prints 'Bee is awesome!'
 ```
 
   </TabItem>
@@ -90,7 +97,7 @@ const retrievedFile = await bee.downloadFile(hash)
 
 console.log(retrievedFile.name) // prints 'textfile.txt'
 console.log(retrievedFile.contentType) // prints 'application/octet-stream'
-console.log(new TextDecoder("utf-8").decode(retrievedFile.data)) // prints 'Bee is awesome!'
+console.log(retrievedFile.data.text()) // prints 'Bee is awesome!'
 ```
 
   </TabItem>
@@ -115,7 +122,7 @@ const retrievedFile = await bee.downloadFile(hash)
 
 console.log(retrievedFile.name) // prints 'foo.txt'
 console.log(retrievedFile.contentType) // prints 'text/plain'
-console.log(new TextDecoder("utf-8").decode(retrievedFile.data)) // prints 'foo'
+console.log(retrievedFile.data.text()) // prints 'foo'
 ```
 
   </TabItem>
@@ -129,7 +136,7 @@ const retrievedFile = await bee.downloadFile(hash)
 
 console.log(retrievedFile.name) // prints 'foo.txt'
 console.log(retrievedFile.contentType) // prints 'text/plain'
-console.log(new TextDecoder("utf-8").decode(retrievedFile.data)) // prints 'foo'
+console.log(retrievedFile.data.text()) // prints 'foo'
 ```
 
   </TabItem>
@@ -157,8 +164,8 @@ const hash = await bee.uploadFiles([ foo, bar ]) // upload
 const rFoo = await bee.downloadFileFromCollection(hash, './foo.txt') // download foo
 const rBar = await bee.downloadFileFromCollection(hash, './bar.txt') // download bar
 
-console.log(new TextDecoder("utf-8").decode(rFoo.data)) // prints 'foo'
-console.log(new TextDecoder("utf-8").decode(rBar.data)) // prints 'bar'
+console.log(rFoo.data.text()) // prints 'foo'
+console.log(rBar.data.text()) // prints 'bar'
 ```
 
   </TabItem>
@@ -173,8 +180,8 @@ const hash = await bee.uploadFiles([ foo, bar ]) // upload
 const rFoo = await bee.downloadFileFromCollection(hash, './foo.txt') // download foo
 const rBar = await bee.downloadFileFromCollection(hash, './bar.txt') // download bar
 
-console.log(new TextDecoder("utf-8").decode(rFoo.data)) // prints 'foo'
-console.log(new TextDecoder("utf-8").decode(rBar.data)) // prints 'bar'
+console.log(rFoo.data.text()) // prints 'foo'
+console.log(rBar.data.text()) // prints 'bar'
 ```
 
   </TabItem>
@@ -204,8 +211,8 @@ const hash = await bee.uploadFilesFromDirectory('./', true) // upload recursivel
 const rFoo = await bee.downloadFileFromCollection(hash, './foo.txt') // download foo
 const rBar = await bee.downloadFileFromCollection(hash, './dir/bar.txt') // download bar
 
-console.log(new TextDecoder("utf-8").decode(rFoo.data)) // prints 'foo'
-console.log(new TextDecoder("utf-8").decode(rBar.data)) // prints 'bar'
+console.log(rFoo.data.text()) // prints 'foo'
+console.log(rBar.data.text()) // prints 'bar'
 ```
 
   </TabItem>
@@ -217,8 +224,8 @@ const hash = await bee.uploadFilesFromDirectory('./', true) // upload recursivel
 const rFoo = await bee.downloadFileFromCollection(hash, './foo.txt') // download foo
 const rBar = await bee.downloadFileFromCollection(hash, './dir/bar.txt') // download bar
 
-console.log(new TextDecoder("utf-8").decode(rFoo.data)) // prints 'foo'
-console.log(new TextDecoder("utf-8").decode(rBar.data)) // prints 'bar'
+console.log(rFoo.data.text()) // prints 'foo'
+console.log(rBar.data.text()) // prints 'bar'
 ```
 
   </TabItem>