{"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"dist":{"shasum":"df3130e1eb11d9ce5704f6a3e187055438152fc5","tarball":"https://registry.npmjs.org/ipfs-client/-/ipfs-client-0.9.2-789ee585.tgz","fileCount":7,"integrity":"sha512-b4rlsfOempQ+iJiqMblXEeWSZXm4+LCxOwEy3+iZVw7LSRm+CN3yB+GQEJ7PHV/dkJ1CUK4y93AHVk0VT+nilQ==","signatures":[{"sig":"MEUCIBUVGsdWGu21bKlSeJ46CQdqCWg6AQL3FOJ9pGlRdk6+AiEAlFQpC8htQXIOO/8TV7MYudRar9G7sRrwyihqN0Os+P0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":275033,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjvuyBACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmohXg/+L+TO0O+1npHdSBzEREGsHIcfSAUSdIKZWcw6Ik6TCjIr6GOi\r\nYECHN2UFWmul4KgNKWspBdSoE3xFOP/L4RIrVh8AGEC2KbMI2NQlOJbBDHNh\r\nm2oZ9DXXf+12gUeHFJ/jyx0DS2BXnr2+Jv428Cg6IOwO6aAVtcD7i88+5MYI\r\n3K9Qzmb+MWHX6KIewHQ6F7sPqqIj6hNKMK03pYNtIn9kaYa3rWID+InFyVHH\r\n99nvjQoMVlqiiWtu0ysc5CjwnTXT8aQ7l7WnqyW6NfuPOxV0pUaMHOWLmNUP\r\ncw0mlqSe9YAhCfUd16HJByLx1flOt6FqSBl2z5ba7j/jB7jctw9mkEP7wPfn\r\nGQPpJeNSoA2L2chFspb/Cnx2NYDvuzZu7X7ppo7BANObYnnP48ltLlmlsQyT\r\nkdBZRO+u0OZnjmNG3OhVb9cXrkaN73d52XxvhwN1h6B5TccULWL8gaXs0Ta8\r\nbk9H1oZdQU7SgnsBzYgryPvVtPEVXXpOgStdn5zHGG20vkaB3FzzXSHcaib9\r\nNEAYmgUh0tC+8lkBINy5o3BQftH5gIfkLtByY2IuWxVMcRai93P+3qeFRfLj\r\n9EMpMGjJGpSbaioWMiCrWYVbjwVpFs61AzkGsI7IprgGVFk4+LCnH0zo3Og+\r\no8VSb8T1sJ3dFBiMgBolFPBV9w8XbkH8ODs=\r\n=I36I\r\n-----END PGP SIGNATURE-----\r\n"},"name":"ipfs-client","type":"module","types":"./dist/src/index.d.ts","readme":"# ipfs-client <!-- omit in toc -->\n\n[![ipfs.io](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io)\n[![IRC](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![Discord](https://img.shields.io/discord/806902334369824788?style=flat-square)](https://discord.gg/ipfs)\n[![codecov](https://img.shields.io/codecov/c/github/ipfs/js-ipfs.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs)\n[![CI](https://img.shields.io/github/workflow/status/ipfs/js-ipfs/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs/js-ipfs/actions/workflows/js-test-and-release.yml)\n\n> A client library to talk to local IPFS daemons\n\n## Table of contents <!-- omit in toc -->\n\n- [Install](#install)\n- [API](#api)\n  - [`create([options])`](#createoptions)\n  - [Parameters](#parameters)\n  - [Options](#options)\n  - [Returns](#returns)\n  - [Example](#example)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-client\n```\n\nThis module combines the [ipfs-grpc-client][] and [ipfs-http-client][] modules to give you a client that is capable of bidirectional streaming in the browser as well as node.\n\n## API\n\nThe client object created by the `createClient` function supports the [IPFS Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api), see the docs for more.\n\n### `create([options])`\n\n### Parameters\n\nNone\n\n### Options\n\nAn optional object which may have the following keys:\n\n| Name  | Type                                                                 | Default     | Description                                                       |\n| ----- | -------------------------------------------------------------------- | ----------- | ----------------------------------------------------------------- |\n| grpc  | `Multiaddr` or `string` or `URL`                                     | `undefined` | The address of a [ipfs-grpc-server][] to connect to               |\n| http  | `Multiaddr` or `string` or `URL`                                     | `undefined` | The address of a [ipfs-http-server][] to connect to               |\n| agent | [http.Agent](https://nodejs.org/api/http.html#http_class_http_agent) | `undefined` | A http.Agent used to control HTTP client behaviour (node.js only) |\n\n### Returns\n\n| Type     | Description               |\n| -------- | ------------------------- |\n| `object` | An instance of the client |\n\n### Example\n\n```js\nimport { create } from 'ipfs-client'\n\nconst client = create({\n  grpc: '/ipv4/127.0.0.1/tcp/5003/ws',\n  http: '/ipv4/127.0.0.1/tcp/5002/http'\n})\n\nconst id = await client.id()\n```\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)\n- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)\n\n## Contribute\n\nContributions welcome! Please check out [the issues](https://github.com/ipfs/js-ipfs/issues).\n\nAlso 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.\n\nPlease 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).\n\nUnless 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.\n\n[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)\n\n[ipfs]: https://www.npmjs.com/package/ipfs\n\n[ipfs-grpc-client]: https://www.npmjs.com/package/ipfs-grpc-client\n\n[ipfs-http-client]: https://www.npmjs.com/package/ipfs-http-client\n\n[ipfs-grpc-server]: https://www.npmjs.com/package/ipfs-grpc-server\n\n[ipfs-http-server]: https://www.npmjs.com/package/ipfs-http-server\n","engines":{"npm":">=7.0.0","node":">=16.0.0"},"exports":{".":{"types":"./dist/src/index.d.ts","import":"./src/index.js"}},"gitHead":"789ee58556083ef71a4ef44e3358f86c5be101fb","license":"Apache-2.0 OR MIT","scripts":{"lint":"aegir lint","build":"aegir build","clean":"aegir clean","dep-check":"aegir dep-check -i aegir"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-client#readme","keywords":["ipfs"],"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details","repository":{"url":"git+https://github.com/ipfs/js-ipfs.git","type":"git"},"_npmVersion":"8.19.3","description":"A client library to talk to local IPFS daemons","directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"}],"_nodeVersion":"18.12.1","dependencies":{"merge-options":"^3.0.4","ipfs-grpc-client":"0.12.0-789ee585","ipfs-http-client":"59.0.0-789ee585"},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"typesVersions":{"*":{"*":["*","dist/*","dist/src/*","dist/src/*/index"],"src/*":["*","dist/*","dist/src/*","dist/src/*/index"]}},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"aegir":"^37.11.0"},"_npmOperationalInternal":{"tmp":"tmp/ipfs-client_0.9.2-789ee585_1673456769337_0.376096604222826","host":"s3://npm-registry-packages"},"_id":"ipfs-client@0.9.2-789ee585","version":"0.9.2-789ee585"}