{"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"dist":{"shasum":"eb8301452214f829bb7faa9fbae8b708ae390cae","tarball":"https://registry.npmjs.org/ipfs-client/-/ipfs-client-0.10.0-b64d4af0.tgz","fileCount":7,"integrity":"sha512-SnWC0CW1quBx3rAm2mldx6V2104d5C1fWCnG+izvredV8StAAKoO3x8YP1xYhtdzDiuqoU+9wyL7OdU7rwt77g==","signatures":[{"sig":"MEQCIHN8YDlTfaJ6SXvtxE+GcsoQyCaA8Vem714K10MQKeWtAiAFs/fWagYWSHPznFWBZqKoLzuD3BgBB8Sx2wX7MFk/ng==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":276575,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJj2kwQACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrQaBAAgsI1QuyN9KNejLHcXnWCk/vi/2emWygsALZJFJ5MwZfzhNXj\r\n9Bbx4xp4ltxjJGxS2TxRHIt6QwZAL9vDCfG3UcQfQ3MjnzO9/pJf1+YZ1XPq\r\nxNQW+EZkXqiA+KjouEj7uIWaToLJIZRczaw7mU0+WvBJYiXG3dqlvLVVv27e\r\n7aanbvqgw+4SV/5DktiuyL13A3hPcr4YQiHjrTPSY6PdlVyBrTW0AY4kh/Ki\r\nla4Niz2GfcLZzmsJJREbeyoBS+45ZKMqdKrI6/37LvTWLhns9VKWumlFUHPl\r\n6IZQV4awfSfui94tnMC80aH/HV8tpaXrg6rOhJIK5HMXIVvgOQsFzc1K54EO\r\neqk9C9cp0dmxH+M8fAbwRtlL1Cfsr78h5OglJFwLSdS2Ja+81UGfwFBBFxDH\r\nYFIQUgrDxMHBnqjGPmhBvrb6mDMjkBLCB2Z5FI21DBBUCGuU6CV4fxG1FdKg\r\nzQpHMx3XeqVTYJJwmti7ExzfeNrJDiWMR+nhdnQqSXCz2zzkzJzlEwXMA44h\r\n02xoa3hPt7rzNQRT8QK4V89Y3QTQLxUczF6LVwEbCDNCX3Qn5wgrGyV3nsuq\r\nNWelA8Imr3fyWnVJQ4B7kPuvC4ugq/X41QTDbC1MqEfyqW4UlCLGenOFp5n0\r\nGq06WCReFvOHjHdnVj+CdGVmqkoV1f5ZFVE=\r\n=zC78\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.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)\n[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)\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/actions/workflow/status/ipfs/js-ipfs/test.yml?branch=master\\&style=flat-square)](https://github.com/ipfs/js-ipfs/actions/workflows/test.yml?query=branch%3Amaster)\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":"b64d4af034f27aa7204e57e6a79f95461095502c","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.13.0","dependencies":{"merge-options":"^3.0.4","ipfs-grpc-client":"0.13.0-b64d4af0","ipfs-http-client":"60.0.0-b64d4af0"},"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.10.0-b64d4af0_1675250703738_0.12791161304556353","host":"s3://npm-registry-packages"},"_id":"ipfs-client@0.10.0-b64d4af0","version":"0.10.0-b64d4af0"}