@helia/unixfs 1.4.3 → 2.0.0-3f4c6bf
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 +13 -21
- package/dist/index.min.js +1 -1
- package/dist/src/index.d.ts +4 -4
- package/dist/src/index.js +4 -4
- package/package.json +21 -17
- package/src/index.ts +4 -4
- package/dist/typedoc-urls.json +0 -54
package/README.md
CHANGED
|
@@ -4,12 +4,12 @@
|
|
|
4
4
|
</a>
|
|
5
5
|
</p>
|
|
6
6
|
|
|
7
|
-
# @helia/unixfs
|
|
7
|
+
# @helia/unixfs
|
|
8
8
|
|
|
9
9
|
[](https://ipfs.tech)
|
|
10
10
|
[](https://discuss.ipfs.tech)
|
|
11
|
-
[](https://codecov.io/gh/ipfs/helia)
|
|
12
|
+
[](https://github.com/ipfs/helia/actions/workflows/main.yml?query=branch%3Amain)
|
|
13
13
|
|
|
14
14
|
> A Helia-compatible wrapper for UnixFS
|
|
15
15
|
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
|
|
20
20
|
See the interface for all available operations.
|
|
21
21
|
|
|
22
|
-
## Example
|
|
22
|
+
## Example - Creating files and directories
|
|
23
23
|
|
|
24
24
|
```typescript
|
|
25
25
|
import { createHelia } from 'helia'
|
|
@@ -44,9 +44,9 @@ for await (const entry of fs.addAll([{
|
|
|
44
44
|
}
|
|
45
45
|
```
|
|
46
46
|
|
|
47
|
-
## Example
|
|
47
|
+
## Example - Recursively adding a directory
|
|
48
48
|
|
|
49
|
-
|
|
49
|
+
Node.js-compatibly environments only:
|
|
50
50
|
|
|
51
51
|
```typescript
|
|
52
52
|
import { globSource } from '@helia/unixfs'
|
|
@@ -56,21 +56,13 @@ for await (const entry of fs.addAll(globSource('path/to/containing/dir', 'glob-p
|
|
|
56
56
|
}
|
|
57
57
|
```
|
|
58
58
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
- [Install](#install)
|
|
62
|
-
- [Browser `<script>` tag](#browser-script-tag)
|
|
63
|
-
- [API Docs](#api-docs)
|
|
64
|
-
- [License](#license)
|
|
65
|
-
- [Contribute](#contribute)
|
|
66
|
-
|
|
67
|
-
## Install
|
|
59
|
+
# Install
|
|
68
60
|
|
|
69
61
|
```console
|
|
70
62
|
$ npm i @helia/unixfs
|
|
71
63
|
```
|
|
72
64
|
|
|
73
|
-
|
|
65
|
+
## Browser `<script>` tag
|
|
74
66
|
|
|
75
67
|
Loading this module through a script tag will make it's exports available as `HeliaUnixfs` in the global namespace.
|
|
76
68
|
|
|
@@ -78,20 +70,20 @@ Loading this module through a script tag will make it's exports available as `He
|
|
|
78
70
|
<script src="https://unpkg.com/@helia/unixfs/dist/index.min.js"></script>
|
|
79
71
|
```
|
|
80
72
|
|
|
81
|
-
|
|
73
|
+
# API Docs
|
|
82
74
|
|
|
83
|
-
- <https://ipfs.github.io/helia
|
|
75
|
+
- <https://ipfs.github.io/helia/modules/_helia_unixfs.html>
|
|
84
76
|
|
|
85
|
-
|
|
77
|
+
# License
|
|
86
78
|
|
|
87
79
|
Licensed under either of
|
|
88
80
|
|
|
89
81
|
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
|
|
90
82
|
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
|
|
91
83
|
|
|
92
|
-
|
|
84
|
+
# Contribute
|
|
93
85
|
|
|
94
|
-
Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia
|
|
86
|
+
Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia/issues).
|
|
95
87
|
|
|
96
88
|
Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.
|
|
97
89
|
|