@libp2p/http-utils 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 (30) hide show
  1. package/README.md +56 -0
  2. package/dist/index.min.js +50 -0
  3. package/dist/index.min.js.map +7 -0
  4. package/dist/src/constants.d.ts +9 -0
  5. package/dist/src/constants.d.ts.map +1 -0
  6. package/dist/src/constants.js +78 -0
  7. package/dist/src/constants.js.map +1 -0
  8. package/dist/src/index.d.ts +102 -0
  9. package/dist/src/index.d.ts.map +1 -0
  10. package/dist/src/index.js +411 -0
  11. package/dist/src/index.js.map +1 -0
  12. package/dist/src/request.d.ts +16 -0
  13. package/dist/src/request.d.ts.map +1 -0
  14. package/dist/src/request.js +41 -0
  15. package/dist/src/request.js.map +1 -0
  16. package/dist/src/response.d.ts +14 -0
  17. package/dist/src/response.d.ts.map +1 -0
  18. package/dist/src/response.js +37 -0
  19. package/dist/src/response.js.map +1 -0
  20. package/dist/src/stream-to-socket.d.ts +4 -0
  21. package/dist/src/stream-to-socket.d.ts.map +1 -0
  22. package/dist/src/stream-to-socket.js +155 -0
  23. package/dist/src/stream-to-socket.js.map +1 -0
  24. package/dist/typedoc-urls.json +57 -0
  25. package/package.json +163 -0
  26. package/src/constants.ts +77 -0
  27. package/src/index.ts +561 -0
  28. package/src/request.ts +44 -0
  29. package/src/response.ts +40 -0
  30. package/src/stream-to-socket.ts +200 -0
package/README.md ADDED
@@ -0,0 +1,56 @@
1
+ # @libp2p/http-utils
2
+
3
+ [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
4
+ [![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
5
+ [![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-http.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-http)
6
+ [![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-http/js-test-and-release.yml?branch=main\&style=flat-square)](https://github.com/libp2p/js-libp2p-http/actions/workflows/js-test-and-release.yml?query=branch%3Amain)
7
+
8
+ > Shared utils and common code for HTTP modules
9
+
10
+ # About
11
+
12
+ <!--
13
+
14
+ !IMPORTANT!
15
+
16
+ Everything in this README between "# About" and "# Install" is automatically
17
+ generated and will be overwritten the next time the doc generator is run.
18
+
19
+ To make changes to this section, please update the @packageDocumentation section
20
+ of src/index.js or src/index.ts
21
+
22
+ To experiment with formatting, please run "npm run docs" from the root of this
23
+ repo and examine the changes made.
24
+
25
+ -->
26
+
27
+ Contains shared code and utilities used by `@libp2p/http-*` modules.
28
+
29
+ # Install
30
+
31
+ ```console
32
+ $ npm i @libp2p/http-utils
33
+ ```
34
+
35
+ ## Browser `<script>` tag
36
+
37
+ Loading this module through a script tag will make its exports available as `Libp2pHttpUtils` in the global namespace.
38
+
39
+ ```html
40
+ <script src="https://unpkg.com/@libp2p/http-utils/dist/index.min.js"></script>
41
+ ```
42
+
43
+ # API Docs
44
+
45
+ - <https://libp2p.github.io/js-libp2p-http/modules/_libp2p_http_utils.html>
46
+
47
+ # License
48
+
49
+ Licensed under either of
50
+
51
+ - Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p-http/blob/main/packages/http-utils/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
52
+ - MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p-http/blob/main/packages/http-utils/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
53
+
54
+ # Contribution
55
+
56
+ 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.