@helia/mfs 0.0.0

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.
Files changed (15) hide show
  1. package/LICENSE +4 -0
  2. package/README.md +59 -0
  3. package/dist/index.min.js +3 -0
  4. package/dist/src/index.d.ts +225 -0
  5. package/dist/src/index.d.ts.map +1 -0
  6. package/dist/src/index.js +312 -0
  7. package/dist/src/index.js.map +1 -0
  8. package/dist/src/utils/basename.d.ts +2 -0
  9. package/dist/src/utils/basename.d.ts.map +1 -0
  10. package/dist/src/utils/basename.js +4 -0
  11. package/dist/src/utils/basename.js.map +1 -0
  12. package/dist/typedoc-urls.json +9 -0
  13. package/package.json +167 -0
  14. package/src/index.ts +600 -0
  15. package/src/utils/basename.ts +3 -0
package/LICENSE ADDED
@@ -0,0 +1,4 @@
1
+ This project is dual licensed under MIT and Apache-2.0.
2
+
3
+ MIT: https://www.opensource.org/licenses/mit
4
+ Apache-2.0: https://www.apache.org/licenses/license-2.0
package/README.md ADDED
@@ -0,0 +1,59 @@
1
+ <p align="center">
2
+ <a href="https://github.com/ipfs/helia" title="Helia">
3
+ <img src="https://raw.githubusercontent.com/ipfs/helia/main/assets/helia.png" alt="Helia logo" width="300" />
4
+ </a>
5
+ </p>
6
+
7
+ # @helia/mfs <!-- omit in toc -->
8
+
9
+ [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
10
+ [![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
11
+ [![codecov](https://img.shields.io/codecov/c/github/ipfs/helia-mfs.svg?style=flat-square)](https://codecov.io/gh/ipfs/helia-mfs)
12
+ [![CI](https://img.shields.io/github/actions/workflow/status/ipfs/helia-mfs/js-test-and-release.yml?branch=main\&style=flat-square)](https://github.com/ipfs/helia-mfs/actions/workflows/js-test-and-release.yml?query=branch%3Amain)
13
+
14
+ > A mutable filesystem powered by Helia
15
+
16
+ ## Table of contents <!-- omit in toc -->
17
+
18
+ - [Install](#install)
19
+ - [Browser `<script>` tag](#browser-script-tag)
20
+ - [API Docs](#api-docs)
21
+ - [License](#license)
22
+ - [Contribute](#contribute)
23
+
24
+ ## Install
25
+
26
+ ```console
27
+ $ npm i @helia/mfs
28
+ ```
29
+
30
+ ### Browser `<script>` tag
31
+
32
+ Loading this module through a script tag will make it's exports available as `HeliaMfs` in the global namespace.
33
+
34
+ ```html
35
+ <script src="https://unpkg.com/@helia/mfs/dist/index.min.js"></script>
36
+ ```
37
+
38
+ ## API Docs
39
+
40
+ - <https://ipfs.github.io/helia-mfs/modules.html>
41
+
42
+ ## License
43
+
44
+ Licensed under either of
45
+
46
+ - Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
47
+ - MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
48
+
49
+ ## Contribute
50
+
51
+ Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia-mfs/issues).
52
+
53
+ 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.
54
+
55
+ Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
56
+
57
+ Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
58
+
59
+ [![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)