{"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"dist":{"shasum":"accba610844a9d83053b1c8cb7f4ccbe72795c5f","tarball":"https://registry.npmjs.org/ipfs-client/-/ipfs-client-0.0.1-e85e5b6e.0.tgz","fileCount":7,"integrity":"sha512-H2cW5RvCJATjjzTnuKX3hWQd+eQoASLIf6qFqu13lsSrNo9ZcVskTYTVpjIAbC5JopZoK7Y8c/wP9oEgVvi+cg==","signatures":[{"sig":"MEUCIQDme+CDcSixYWGzbrK8v3t65gX2tNCYYjhYKYoaWkeAgAIgGdLAeZ99wX5lFgS+zwpG9ubYTfGxU7+Tp7oOOkcz6JM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":297225,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjvGf3ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoTahAAkkHqgHn1Us4zG+dklKI16BHutfyUG5xEyEpm7B46VAjOc6vJ\r\n2yDW27CM/3HAhQCKR3dNMaLlj29lRZdOe3YGu6KjYeZe5RNE8IrmQ3RFu7Og\r\nMqpoRv93HRp+vbMOwHKHNh9uY0jyyBqf55Zy44qX5vxg3qqIJUu00guGg6yH\r\n8czHB1fwzbaygGo53Y3dYKj/zDSzRF9Plucn2sm30FvEKBpKAdGc9IvnJ5UA\r\nLvnz0N/M3/sv1nICln/IyTK0RBfI9+ESh8fsVXIEDBxCDRde/lH7YZFM7CuA\r\nfSk3ZoWPdKXJ4X8pn7BPfdzZm1AYWpqHwjx20ozsv2WnBjc3LKN1bzuC4Eg5\r\nIapSPXfEQhzvYFZtKbUhwmQcrTY/Ez/4pzdlz3y/5FnIZMWb/Q9AvWztm+Ep\r\nr1A2s/vQJrSZMqwOXe0jJYUj5WRkIw3Xa5IEC3cPFm0Y0uB6iD7kVNFmwrA2\r\nex+L+4e/ZsELt9BpG3EgSUmQSqtYQsIUvR59LJm/iTYn8l2JvVXVCureF717\r\nxnbFZkaFLaJrZbEyx+ubR6Qzf4nW6N9/Q+bi2MenblpvB991WHex0pHbLtKN\r\n059DAMhW3LqERiZK9qG4wm4pWKVeKk1/pmTM60tLExEkHUFMJxsPf7txxojo\r\nSQxULi5TYAZbdPGsq31snb7QJuWLhs4onx8=\r\n=JPqW\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":"5d268429a92d15e22b1cbf7fafadca662b131420","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":"lerna/6.4.0/node@v18.12.1+x64 (linux)","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.0.1-e85e5b6e.0","ipfs-http-client":"^0.0.1-e85e5b6e.0"},"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.9.0"},"_npmOperationalInternal":{"tmp":"tmp/ipfs-client_0.0.1-e85e5b6e.0_1673291766842_0.2594271528780103","host":"s3://npm-registry-packages"},"_id":"ipfs-client@0.0.1-e85e5b6e.0","version":"0.0.1-e85e5b6e.0"}