Merge remote-tracking branch 'origin/main' into fix/update-libp2p-deps

Author: achingbrain

README.md

@@ -1,3 +1,4 @@
+<<<<<<< HEAD
 # kubo-rpc-client
 
 [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
@@ -55,6 +56,8 @@ Loading this module through a script tag will make its exports available as `Kub
 - [License](#license)
 - [Contribute](#contribute)
 
+=======
+>>>>>>> origin/main
 ## Kubo RPC Client
 
 <h3 align="center">JavaScript client library for the Kubo RPC API</h3>
@@ -78,22 +81,34 @@ Loading this module through a script tag will make its exports available as `Kub
   <br>
 </p>
 
-## Getting Started
+# kubo-rpc-client
 
-We've come a long way, but this project is still in Alpha, lots of development is happening, APIs might change, beware of 🐉..
+[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
+[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
+[![codecov](https://img.shields.io/codecov/c/github/ipfs/js-kubo-rpc-client.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-kubo-rpc-client)
+[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-kubo-rpc-client/js-test-and-release.yml?branch=main\&style=flat-square)](https://github.com/ipfs/js-kubo-rpc-client/actions/workflows/js-test-and-release.yml?query=branch%3Amain)
 
-```bash
-npm install --save kubo-rpc-client
+> A client library for the Kubo RPC API
+
+# Install
+
+```console
+$ npm i kubo-rpc-client
+```
+
+## Browser `<script>` tag
+
+Loading this module through a script tag will make its exports available as `KuboRpcClient` in the global namespace.
+
+```html
+<script src="https://unpkg.com/kubo-rpc-client/dist/index.min.js"></script>
 ```
 
 Both the Current and Active LTS versions of Node.js are supported. Please see [nodejs.org](https://nodejs.org/) for what these currently are.
 
 ### Next Steps
 
-<!-- TODO: currently useless
 - Read the [docs](https://ipfs.github.io/js-kubo-rpc-client)
--->
-
 - Look into the [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an RPC client or a full IPFS node in Node.js and in the Browser
 - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node
 - Check out <https://docs.ipfs.tech> for tips, how-tos and more

src/lib/http.ts

@@ -143,7 +143,7 @@ export class HTTP {
       log.trace('outgoing headers', opts.headers)
       log.trace('%s %s', opts.method, url)
 
-      // @ts-expect-error extra properties are added later
+      // @ts-expect-error extra fields are added later
       const response: ExtendedResponse = await fetch(url.toString(), {
         ...opts,
         signal: opts.signal,
@@ -239,7 +239,7 @@ const ndjson = async function * (source: AsyncIterable<Uint8Array>): AsyncIterab
  * @param {ReadableStream<TChunk> | NodeReadableStream | null} source
  * @returns {AsyncIterable<TChunk>}
  */
-const fromStream = <TChunk> (source?: any | null): AsyncIterable<TChunk> => {
+const fromStream = <TChunk> (source: any | null): AsyncIterable<TChunk> => {
   if (isAsyncIterable<TChunk>(source)) {
     return source
   }

test/interface-tests/src/pin/utils.ts

@@ -23,11 +23,11 @@ export const pinTypes: Record<string, PinType> = {
 export const fixtures = Object.freeze({
   // NOTE: files under 'directory' need to be different than standalone ones in 'files'
   directory: Object.freeze({
-    cid: CID.parse('QmSjnCov8q2oU54bGE4n9B3BoaBv8ALVZUUkzLjqAN9Roj'),
+    cid: CID.parse('QmVfR81gGg1a5pLFybBF1dvFY8fVcvdan2oT9WT4Git6XH'),
     files: Object.freeze([Object.freeze({
       path: 'test-folder/ipfs-add.js',
       data: loadFixture('test/interface-tests/fixtures/test-folder/ipfs-add.js'),
-      cid: CID.parse('QmdWJndBCczwPQeiKiSBzef8TyWigApDqY3q8p7jg9CiQK')
+      cid: CID.parse('QmabGLRzzSFDwsh7rfLfib2U2Xk2x4XiCgpWwZfcUx4dtq')
     }), Object.freeze({
       path: 'test-folder/files/ipfs.txt',
       data: loadFixture('test/interface-tests/fixtures/test-folder/files/ipfs.txt'),

test/lib.error-handler.spec.ts

@@ -1,7 +1,6 @@
 /* eslint-env mocha */
 
 import { expect } from 'aegir/chai'
-import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
 import { errorHandler, HTTPError } from '../src/lib/core.js'
 import { throwsAsync } from './utils/throws-async.js'
 
@@ -18,7 +17,7 @@ describe('lib/error-handler', function () {
         Code: 0,
         Type: 'error'
       }),
-      bytes: async () => uint8ArrayFromString('boom'),
+      bytes: async () => Promise.reject(new Error('boom')),
       status: 500,
       redirected: false,
       url: '',
@@ -49,7 +48,7 @@ describe('lib/error-handler', function () {
         'Content-Type': 'application/json'
       }),
       json: async () => 'boom', // not valid json!
-      bytes: async () => uint8ArrayFromString('boom'),
+      bytes: async () => Promise.reject(new Error('boom')),
       status: 500,
       redirected: false,
       url: '',
@@ -77,7 +76,7 @@ describe('lib/error-handler', function () {
       text: async () => Promise.reject(new Error('boom')),
       status: 500,
       json: async () => 'boom', // not valid json!
-      bytes: async () => uint8ArrayFromString('boom'),
+      bytes: async () => Promise.reject(new Error('boom')),
       redirected: false,
       url: '',
       type: 'basic',