helia 3.0.0 → 3.0.1-ece384a
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -7
- package/dist/index.min.js +118 -64
- package/dist/src/helia.d.ts.map +1 -1
- package/dist/src/helia.js +1 -2
- package/dist/src/helia.js.map +1 -1
- package/dist/src/index.d.ts +3 -0
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/index.js +2 -0
- package/dist/src/index.js.map +1 -1
- package/dist/src/utils/libp2p-defaults.browser.d.ts +1 -1
- package/dist/src/utils/libp2p-defaults.browser.d.ts.map +1 -1
- package/dist/src/utils/libp2p-defaults.browser.js +1 -1
- package/dist/src/utils/libp2p-defaults.browser.js.map +1 -1
- package/dist/src/utils/libp2p-defaults.d.ts +1 -1
- package/dist/src/utils/libp2p-defaults.d.ts.map +1 -1
- package/dist/src/utils/libp2p-defaults.js +1 -1
- package/dist/src/utils/libp2p-defaults.js.map +1 -1
- package/dist/src/version.d.ts +1 -1
- package/dist/src/version.d.ts.map +1 -1
- package/dist/src/version.js +1 -1
- package/dist/src/version.js.map +1 -1
- package/package.json +15 -44
- package/src/helia.ts +1 -2
- package/src/index.ts +4 -0
- package/src/utils/libp2p-defaults.browser.ts +1 -1
- package/src/utils/libp2p-defaults.ts +1 -1
- package/src/version.ts +1 -1
- package/dist/src/block-brokers/bitswap.d.ts +0 -19
- package/dist/src/block-brokers/bitswap.d.ts.map +0 -1
- package/dist/src/block-brokers/bitswap.js +0 -48
- package/dist/src/block-brokers/bitswap.js.map +0 -1
- package/dist/src/block-brokers/index.d.ts +0 -3
- package/dist/src/block-brokers/index.d.ts.map +0 -1
- package/dist/src/block-brokers/index.js +0 -3
- package/dist/src/block-brokers/index.js.map +0 -1
- package/dist/src/block-brokers/trustless-gateway/broker.d.ts +0 -15
- package/dist/src/block-brokers/trustless-gateway/broker.d.ts.map +0 -1
- package/dist/src/block-brokers/trustless-gateway/broker.js +0 -55
- package/dist/src/block-brokers/trustless-gateway/broker.js.map +0 -1
- package/dist/src/block-brokers/trustless-gateway/index.d.ts +0 -13
- package/dist/src/block-brokers/trustless-gateway/index.d.ts.map +0 -1
- package/dist/src/block-brokers/trustless-gateway/index.js +0 -15
- package/dist/src/block-brokers/trustless-gateway/index.js.map +0 -1
- package/dist/src/block-brokers/trustless-gateway/trustless-gateway.d.ts +0 -31
- package/dist/src/block-brokers/trustless-gateway/trustless-gateway.d.ts.map +0 -1
- package/dist/src/block-brokers/trustless-gateway/trustless-gateway.js +0 -114
- package/dist/src/block-brokers/trustless-gateway/trustless-gateway.js.map +0 -1
- package/dist/src/utils/networked-storage.d.ts +0 -69
- package/dist/src/utils/networked-storage.d.ts.map +0 -1
- package/dist/src/utils/networked-storage.js +0 -207
- package/dist/src/utils/networked-storage.js.map +0 -1
- package/dist/typedoc-urls.json +0 -12
- package/src/block-brokers/bitswap.ts +0 -77
- package/src/block-brokers/index.ts +0 -2
- package/src/block-brokers/trustless-gateway/broker.ts +0 -65
- package/src/block-brokers/trustless-gateway/index.ts +0 -33
- package/src/block-brokers/trustless-gateway/trustless-gateway.ts +0 -126
- package/src/utils/networked-storage.ts +0 -266
package/README.md
CHANGED
|
@@ -11,13 +11,13 @@
|
|
|
11
11
|
|
|
12
12
|
> An implementation of IPFS in JavaScript
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
# About
|
|
15
15
|
|
|
16
16
|
Exports a `createHelia` function that returns an object that implements the Helia API.
|
|
17
17
|
|
|
18
18
|
Pass it to other modules like @helia/unixfs to make files available on the distributed web.
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
## Example
|
|
21
21
|
|
|
22
22
|
```typescript
|
|
23
23
|
import { createHelia } from 'helia'
|
|
@@ -30,13 +30,13 @@ const fs = unixfs(helia)
|
|
|
30
30
|
fs.cat(CID.parse('bafyFoo'))
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
|
|
33
|
+
# Install
|
|
34
34
|
|
|
35
35
|
```console
|
|
36
36
|
$ npm i helia
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
-
|
|
39
|
+
## Browser `<script>` tag
|
|
40
40
|
|
|
41
41
|
Loading this module through a script tag will make it's exports available as `Helia` in the global namespace.
|
|
42
42
|
|
|
@@ -44,18 +44,18 @@ Loading this module through a script tag will make it's exports available as `He
|
|
|
44
44
|
<script src="https://unpkg.com/helia/dist/index.min.js"></script>
|
|
45
45
|
```
|
|
46
46
|
|
|
47
|
-
|
|
47
|
+
# API Docs
|
|
48
48
|
|
|
49
49
|
- <https://ipfs.github.io/helia/modules/helia.html>
|
|
50
50
|
|
|
51
|
-
|
|
51
|
+
# License
|
|
52
52
|
|
|
53
53
|
Licensed under either of
|
|
54
54
|
|
|
55
55
|
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
|
|
56
56
|
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
|
|
57
57
|
|
|
58
|
-
|
|
58
|
+
# Contribute
|
|
59
59
|
|
|
60
60
|
Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia/issues).
|
|
61
61
|
|