{"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"dist":{"shasum":"1bc2a88bc222536af99a92072ea4d93ba6deee53","tarball":"https://registry.npmjs.org/ipfs-grpc-client/-/ipfs-grpc-client-0.4.2-rc.1.tgz","fileCount":48,"integrity":"sha512-vOfMe9yNuXu47enWiCOzq+9KHoZoSo1rQB5f5t/rVW83dgMTCxLV+sy3mmjh+ID50O7WCRcIC+SkvG9mlngS6Q==","signatures":[{"sig":"MEUCIHIYyBx8acsIqiN2PwQOpEN9qUFNsBoox4mUxGR4j3OfAiEAqmuNtx2m0Khy3So3o7Cb9RR46QkvcYw8RgQ66vOtNGk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":281426,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhBEuUCRA9TVsSAnZWagAAolMP/2UaCcvQ+GFPC4bWsniB\npOvkRwYAOgcdYHE4idEhrAKWc4xD6JxcSj2xJHCe5WqHeEhMELYUb+GOnI2M\nhnJ4qrUY0jhqztm9sql3Thlr9RoAA2gMjPNL5lTCWDi4KLfrLihYYlIAlIPC\nGgo0zRSMt+ZC9nl/bspCt3coLrQP9Gjq4aNk043CjwnbifmLvjO2ScrkQPgM\nkvv5ldGnyHMUk35Nbi2V/r9s0BleiRhKD0kSfezhd0VsTrCzxjDcoDejFJ/S\n5+5M4Ux/pqklZrOssm0tXEMSkWkItf7kJzXgrFNeLxBPcL4A63kWOl+VwmlZ\ncX//Zw9hUVQPJV8Yax2SQBL8YhC1oNOvcw9/+6Dll5iz+kA5hhwaDsujTeqT\no/kiwV+WqF3VfXPY3gfrgZvk3rSler+xbQzRSMOmZJeeAC9VK9gBIxkKTFyv\n/eAvb8tDO23fB+s4O0XjPeuzU/3luRNjSftb63gRHqnxvqkhzSUvZWuf2Jie\n9rgPU5iPuMguhe95nA5hS4IZgwEFFZWYmRUAzEthcLO5iDzp+TcbJowQE2BS\nFh8yuNJRonPohRsd5vv3igJb7Y4XC/s3b5IXgHL02u+cGTWflvcIWHIXbi1g\nmnROxC/YDnm561ss3Nzw1oMUf2RDr8dFmdPYSSDYlJ55TgaVyfy6pS7IJuWP\n4X0/\r\n=SBBz\r\n-----END PGP SIGNATURE-----\r\n"},"main":"src/index.js","name":"ipfs-grpc-client","types":"dist/src/index.d.ts","readme":"# ipfs-grpc-client\n\n> A client for the [ipfs-grpc-server][] module\n\nThis module implements part of the [IPFS Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) using      gRPC over websockets to achieve the bidirectional streaming necessary to have full duplex streams running in the browser.\n\nIt's not recommended you use this directly, instead use the [ipfs-client](https://www.npmjs.com/package/ipfs-client) to combine this with the [ipfs-http-client](https://www.npmjs.com/package/ipfs-http-client) in order to have HTTP fallback for the missing parts of the API.\n\n## Why?\n\nThe [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) and [XHR](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest) APIs do not allow for full-duplex streaming, that is, allowing the client to receive bytes from the response while also adding more bytes to the outgoing request.\n\nThis limits what we can do in browsers in terms of the API, for example streaming arbitrarily sized payloads or exposing libp2p duplex streams.\n\ngPRC over websockets has no such limitations so allows us to harness the full power of a remote IPFS node in the browser without the need to work around browser behaviour.\n\n## Install\n\n```console\n$ npm install ipfs-grpc-client\n```\n\n## API\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| url | `Multiaddr` or `string` or `URL` | `undefined` | The address of a [ipfs-grpc-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-gprc-client')\n\nconst client = create({\n  url: '/ipv4/127.0.0.1/tcp/1234/ws'\n})\n\nconst id = await client.id()\n```\n\n[ipfs-grpc-server]: https://www.npmjs.com/package/ipfs-grpc-server\n","browser":{"./src/grpc/transport.js":"./src/grpc/transport.browser.js"},"gitHead":"48f655ad4a2ec96f84c4f73082919a753523408b","license":"(Apache-2.0 OR MIT)","scripts":{"lint":"aegir lint","test":"aegir test","build":"aegir build","clean":"rimraf ./dist","coverage":"npx nyc -r html npm run test:node -- --bail","dep-check":"aegir dep-check -i aegir -i rimraf -i ipfs-grpc-protocol -i ipfs-core-types"},"_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-grpc-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/3.22.1/node@v14.17.4+x64 (linux)","description":"A client library for the IPFS gRPC API","directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_nodeVersion":"14.17.4","dependencies":{"ws":"^7.3.1","debug":"^4.1.1","err-code":"^3.0.1","it-first":"^1.0.4","multiaddr":"^10.0.0","protobufjs":"^6.10.2","wherearewe":"1.0.0","change-case":"^4.1.1","ipfs-unixfs":"^5.0.0","it-pushable":"^1.4.2","multiformats":"^9.4.1","ipfs-core-types":"^0.6.2-rc.1+48f655ad","ipfs-core-utils":"^0.9.2-rc.1+48f655ad","ipfs-grpc-protocol":"^0.3.1-rc.54+48f655ad","@improbable-eng/grpc-web":"^0.14.0"},"eslintConfig":{"extends":"ipfs"},"_hasShrinkwrap":false,"leadMaintainer":"Alex Potsides <alex@achingbrain.net>","readmeFilename":"README.md","devDependencies":{"aegir":"^34.0.2","sinon":"^11.1.1","it-all":"^1.0.4","rimraf":"^3.0.2"},"_npmOperationalInternal":{"tmp":"tmp/ipfs-grpc-client_0.4.2-rc.1_1627671443944_0.1924231175899751","host":"s3://npm-registry-packages"},"_id":"ipfs-grpc-client@0.4.2-rc.1","version":"0.4.2-rc.1"}