1
1
IPFS Blocks JavaScript Implementation
2
2
=====================================
3
3
4
- [ ![ ] ( https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square )] ( http://ipn.io )
4
+ [ ![ ] ( https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square )] ( http://ipn.io )
5
5
[ ![ ] ( https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square )] ( http://ipfs.io/ )
6
6
[ ![ ] ( https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square )] ( http://webchat.freenode.net/?channels=%23ipfs )
7
7
[ ![ Travis CI] ( https://travis-ci.org/ipfs/js-ipfs-blocks.svg?branch=master )] ( https://travis-ci.org/ipfs/js-ipfs-blocks )
@@ -40,8 +40,8 @@ A Block is a data structure available on this module.
40
40
41
41
## Use in Node.js
42
42
43
- ``` JavaScript
44
- var ipfsBlocks = require (' ipfs-blocks' )
43
+ ``` js
44
+ const ipfsBlocks = require (' ipfs-blocks' )
45
45
```
46
46
47
47
## Use in a browser with browserify, webpack or any other bundler
@@ -65,7 +65,7 @@ Loading this module through a script tag will make the `Unixfs` obj available in
65
65
# Usage
66
66
67
67
68
- ``` javascript
68
+ ``` js
69
69
// then, to access each of the components
70
70
ipfsBlocks .BlockService
71
71
ipfsBlocks .Block
@@ -75,45 +75,54 @@ ipfsBlocks.Block
75
75
76
76
Create a new block
77
77
78
- ``` JavaScript
79
- var block = new blocks.Block (' some data' )
80
- console .log (block .data )
78
+ ``` js
79
+ const block = new blocks.Block (' some data' )
80
+ console .log (block .data )
81
81
// It will print 'some data'
82
+
82
83
console .log (block .key )
83
84
// It will print the sha256 multihash of 'some data'
84
85
```
85
86
87
+ A block can also have it's own extension, which by default is ` data ` .
88
+
89
+ ``` js
90
+ const block = new blocks.Block (' data' , ' ipld' )
91
+ console .log (block .extension )
92
+ // => ipld
93
+ ```
94
+
86
95
#### BlockService
87
96
88
97
Create a new block service
89
98
90
- ``` JavaScript
91
- var bs = new ipfsBlocks.BlockService (< IPFS REPO instance> [, < IPFS Exchange> ])
99
+ ``` js
100
+ const bs = new ipfsBlocks.BlockService (< IPFS REPO instance> [, < IPFS Exchange> ])
92
101
```
93
102
94
- ##### addBlock
103
+ ##### ` addBlock `
95
104
96
- ``` JavaScript
105
+ ``` js
97
106
bs .addBlock (block, function (err ) {
98
107
if (! err) {
99
108
// block successfuly added
100
109
}
101
110
})
102
111
```
103
112
104
- ##### addBlocks
113
+ ##### ` addBlocks `
105
114
106
- ``` JavaScript
115
+ ``` js
107
116
bs .addBlocks (blockArray, function (err ) {
108
117
if (! err) {
109
118
// blocks successfuly added
110
119
}
111
120
})
112
121
```
113
122
114
- ##### getBlock
123
+ ##### ` getBlock `
115
124
116
- ``` JavaScript
125
+ ``` js
117
126
bs .getBlock (multihash, function (err , block ) {
118
127
if (! err) {
119
128
// block successfuly retrieved
@@ -122,29 +131,29 @@ bs.getBlock(multihash, function (err, block) {
122
131
```
123
132
124
133
125
- ##### getBlocks
134
+ ##### ` getBlocks `
126
135
127
- ``` JavaScript
136
+ ``` js
128
137
bs .getBlocks (multihashArray, function (err , block ) {
129
138
if (! err) {
130
139
// block successfuly retrieved
131
140
}
132
141
})
133
142
```
134
143
135
- ##### deleteBlock
144
+ ##### ` deleteBlock `
136
145
137
- ``` JavaScript
146
+ ``` js
138
147
bs .deleteBlock (multihash, function (err ) {
139
148
if (! err) {
140
149
// block successfuly deleted
141
150
}
142
151
})
143
152
```
144
153
145
- ##### deleteBlocks
154
+ ##### ` deleteBlocks `
146
155
147
- ``` JavaScript
156
+ ``` js
148
157
bs .deleteBlocks (multihashArray, function (err ) {
149
158
if (! err) {
150
159
// blocks successfuly deleted
0 commit comments