{"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"dist":{"shasum":"94476165b422855c159239f9164a1293cef6d9a7","tarball":"https://registry.npmjs.org/ipfs-client/-/ipfs-client-0.6.7-rc.1.tgz","fileCount":6,"integrity":"sha512-nVmBvLyK4oG+CZwS/U9ZWQAu8lZ+YrctrMzbvD8MoAomJ1iKWLOg7S5xcQwroC5is/HCQ8p486L+vxrwK2thew==","signatures":[{"sig":"MEUCIQDXqvkUPJsaksfF8kMnOlP/iVkdp7A1Lm75AByTIxQ7YQIgH4IdwfwTClPwrb9Dfk1ilFCar8kuFjhBeGtTBktRMR0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":272411},"main":"src/index.js","name":"ipfs-client","types":"dist/src/index.d.ts","readme":"# ipfs-client\n\n> A client for [ipfs][] daemons\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## Install\n\n```console\n$ npm install ipfs-client\n```\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\nconst { create } = require('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[ipfs]: https://www.npmjs.com/package/ipfs\n[ipfs-grpc-client]: https://www.npmjs.com/package/ipfs-grpc-client\n[ipfs-http-client]: https://www.npmjs.com/package/ipfs-http-client\n[ipfs-grpc-server]: https://www.npmjs.com/package/ipfs-grpc-server\n[ipfs-http-server]: https://www.npmjs.com/package/ipfs-http-server\n","gitHead":"4126a5a38bd7b42e96171b67e9cbcbf4efb94476","license":"(Apache-2.0 OR MIT)","scripts":{"lint":"aegir ts -p check && aegir lint","build":"aegir build","clean":"rimraf ./dist","dep-check":"aegir dep-check -i aegir -i rimraf"},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@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/4.0.0/node@v16.9.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"}],"_nodeVersion":"16.9.1","dependencies":{"merge-options":"^3.0.4","ipfs-grpc-client":"^0.6.6-rc.1+4126a5a3","ipfs-http-client":"^52.0.6-rc.1+4126a5a3"},"eslintConfig":{"extends":"ipfs"},"_hasShrinkwrap":false,"leadMaintainer":"Alex Potsides <alex@achingbrain.net>","readmeFilename":"README.md","devDependencies":{"aegir":"^35.0.3","rimraf":"^3.0.2"},"_npmOperationalInternal":{"tmp":"tmp/ipfs-client_0.6.7-rc.1_1632240653051_0.707227175351709","host":"s3://npm-registry-packages"},"_id":"ipfs-client@0.6.7-rc.1","version":"0.6.7-rc.1"}