{"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"dist":{"shasum":"a5a4f34ba821614eeed151eeccc31a7038063e1a","tarball":"https://registry.npmjs.org/ipfs-http-response/-/ipfs-http-response-5.0.0-5f73ecad.tgz","fileCount":21,"integrity":"sha512-+YVDBovdX4wHRqRNMmmhczDlCWwQGEKJnydZ2ooQLL8szKS3flwHptnp72xuj/c8+c6arzpGkZXO9I1K+eTnbw==","signatures":[{"sig":"MEUCIQCQNLwSx8TL4o7S/zJH4ilywzSd2HV52XVvb9/SX1NIvQIgNkZSUBTlSQbjSbvt8yxBK/JF+egS4VSVweJdfStYFps=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":226824,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjvZ0SACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqgcRAAgJJV7zBRUYC4R6O8EPxCRk6Y8pNYgCzi+L54i/uRCWT7xjjR\r\nVeT3UexVeQ/BTxskUJ5b7eQejNdUetgjKAAUj8rx2RWhsd4xIo9fciEOTkiX\r\nesQZqKDUlN85S2cWuaBtBW+c8EXwt6FYd1qihuOCdLrquOw8/jFT+1AS9lFr\r\nEBbekBdFNDSuU9CuqXZi2Ga/kah839G5zdfn1uxNcDAtdgZmuSmroa6R5VGX\r\nz662f6rLUm8M97rKl9Qhj2mYwMYqUVc6UBY2etgotjn0ujkoaJQ75xC2C1Jk\r\npzk47SOP/LC4uzf8W04N90jlS/KtYQhVcKPyfZKyWae2wHQaSGTziFyL8jNt\r\nO0DorYyxnJQH5/DffcRuOi/Dm23o2zaw0uY9pW7UabYdhPVMGa2Au17AtG2h\r\nl/Ji5rXeUemeJbVnEI/ORnShX+RC7hT0wf1M377wM1DcxowHWOYZ5dg9uzH1\r\npRPenWFwyEzIHj0udGrcwx5Egj4MV9muXyK6AWAhqjJNyucO0TUsz9f2251c\r\npU/hSUrIZVcFMAQVvfzUrumC0VYqx0bCf4X2dJIRq9iZUeNiajtyHW/M2P4e\r\nqCnt+6CA5mwf+qrIUj6TtMspZOyhdB+pk1yvzfjuzjBf9hhTc7r2V5d23NhM\r\nZKW4seJZ3WssxFJcFePrUdm5EJiov4k9Efk=\r\n=K+EZ\r\n-----END PGP SIGNATURE-----\r\n"},"name":"ipfs-http-response","type":"module","types":"./dist/src/index.d.ts","author":{"name":"Vasco Santos","email":"vasco.santos@moxy.studio"},"readme":"# ipfs-http-response <!-- 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> Creates an HTTP response from an IPFS Hash\n\n## Table of contents <!-- omit in toc -->\n\n- [Install](#install)\n- [Usage](#usage)\n  - [Creating HTTP Response](#creating-http-response)\n  - [Using protocol-agnostic resolver](#using-protocol-agnostic-resolver)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-http-response\n```\n\n## Usage\n\n### Creating HTTP Response\n\nThis project creates a HTTP response for an IPFS Path. This response can be a file, a HTML with directory listing or the entry point of a web page.\n\n```js\nimport { getResponse } from 'ipfs-http-response'\n\nconst result = await getResponse(ipfsNode, ipfsPath)\nconsole.log(result)\n```\n\n### Using protocol-agnostic resolver\n\nThis module also exports the used ipfs `resolver`, which should be used when the response needs to be customized or non-HTTP transport is used:\n\n```js\nimport { resolver } from 'ipfs-http-response'\n\nconst result = await resolver.cid(ipfsNode, ipfsPath)\nconsole.log(result)\n```\n\nIf `ipfsPath` points at a directory, `resolver.cid` will throw Error `This dag node is a directory` with a `cid` attribute that can be passed to `resolver.directory`:\n\n```js\nimport { resolver } from 'ipfs-http-response'\n\nconst result = await resolver.directory(ipfsNode, ipfsPath, cid)\nconsole.log(result)\n```\n\n`result` will be either a `string` with HTML directory listing or an array with CIDs of `index` pages present in inspected directory.\n\n![ipfs-http-response usage](docs/ipfs-http-response.png \"ipfs-http-response usage\")\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","browser":{"fs":false,"file-type":"file-type/browser"},"engines":{"npm":">=7.0.0","node":">=16.0.0"},"exports":{".":{"types":"./dist/src/index.d.ts","import":"./src/index.js"}},"gitHead":"5f73ecadd7d397029be8dd9bc0dcd82469f07359","license":"Apache-2.0 OR MIT","scripts":{"lint":"aegir lint","test":"aegir test -t node","build":"aegir build --no-bundle","clean":"aegir clean","dep-check":"aegir dep-check -i global","test:node":"aegir test -t node --cov"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-http-response#readme","keywords":["http","ipfs","response"],"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":"Creates an HTTP response from an IPFS Hash","directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"vascosantos","email":"santos.vasco10@gmail.com"},{"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":{"ejs":"^3.1.6","it-map":"^2.0.0","filesize":"^10.0.5","file-type":"^18.0.0","it-reader":"^6.0.1","mime-types":"^2.1.30","p-try-each":"^1.0.1","it-to-stream":"^1.0.0","@libp2p/logger":"^2.0.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.11.0","it-all":"^2.0.0","ipfs-core":"0.17.0-5f73ecad","ipfsd-ctl":"^12.0.3","@types/ejs":"^3.1.0","get-stream":"^6.0.0","uint8arrays":"^4.0.2","@types/mime-types":"^2.1.1"},"_npmOperationalInternal":{"tmp":"tmp/ipfs-http-response_5.0.0-5f73ecad_1673370898025_0.6408307032052591","host":"s3://npm-registry-packages"},"_id":"ipfs-http-response@5.0.0-5f73ecad","version":"5.0.0-5f73ecad"}