{"bugs":{"url":"https://github.com/ipfs/js-ipfs-http-response/issues"},"dist":{"shasum":"54ddc3899bad07e7628350dc7426cbd6a1bbac3f","tarball":"https://registry.npmjs.org/ipfs-http-response/-/ipfs-http-response-1.0.3-rc.2.tgz","fileCount":30,"integrity":"sha512-Y1XBOWWygbKcqLw9bueYhpcWUlKLwdPc0wPwEMwKjBnoMtv697uymdbl6hJeDm7JkYqvSF7XF6Cc+xd0RDBZZg==","signatures":[{"sig":"MEUCIQC2fSvdF404oeSA2t+ArpumZsV1r3Y2vLx3zpZRKm//7QIgNPPxdPLQa+0aPmDiQjMzqU7w8RBp6R+vxzt9HT5oVeI=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":375956},"main":"./cjs/src/index.js","name":"ipfs-http-response","types":"types/src/index.d.ts","author":{"name":"Vasco Santos","email":"vasco.santos@moxy.studio"},"readme":"# js-ipfs-http-response\n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://protocol.ai)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![standard-readme](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)\n\n> Creates an HTTP response from an IPFS Hash\n\n## Lead Maintainer\n\n[Vasco Santos](https://github.com/vasco-santos).\n\n### Installation\n\n> npm install ipfs-http-response\n\n## Usage\n\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\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","browser":{".":"./cjs/src/index.js"},"exports":{".":{"import":"./esm/src/index.js","browser":"./esm/src/index.js","require":"./cjs/src/index.js"}},"gitHead":"b09a18cd98883662353d116a8ff25a3ddaa48fc2","license":"MIT","scripts":{"lint":"aegir ts -p check && aegir lint","test":"aegir test -t node","build":"aegir build --no-bundle","clean":"rimraf ./dist","pretest":"aegir build --esm-tests","dep-check":"aegir dep-check -i rimraf -i global","test:node":"aegir test -t node"},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"homepage":"https://github.com/ipfs/js-ipfs-http-response#readme","keywords":["ipfs","http","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-http-response.git","type":"git"},"_npmVersion":"lerna/4.0.0/node@v16.10.0+x64 (linux)","description":"Creates an HTTP response from an IPFS Hash","directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"vascosantos","email":"vasco.santos@moxy.studio"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_nodeVersion":"16.10.0","contributors":[{"name":"Vasco Santos","email":"vasco.santos@moxy.studio"},{"name":"Alex Potsides","email":"alex@achingbrain.net"},{"name":"Hector Sanjuan","email":"code@hector.link"},{"name":"Marcin Rataj","email":"lidel@lidel.org"},{"name":"André Cruz","email":"andremiguelcruz@msn.com"},{"name":"Irakli Gozalishvili","email":"rfobic@gmail.com"},{"name":"Alan Shaw","email":"alan.shaw@protocol.ai"},{"name":"Pedro Santos","email":"pedro.santos@moxy.studio"}],"dependencies":{"ejs":"^3.1.6","debug":"^4.3.1","filesize":"^8.0.0","file-type":"^16.0.0","it-buffer":"^0.1.1","it-concat":"^2.0.0","it-reader":"^3.0.0","mime-types":"^2.1.30","p-try-each":"^1.0.1","it-to-stream":"^1.0.0"},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"publishConfig":{"directory":"dist"},"typesVersions":{"*":{"*":["types/*","types/src/*"],"types/*":["types/*","types/src/*"]}},"_hasShrinkwrap":false,"leadMaintainer":"Vasco Santos <vasco.santos@moxy.studio>","readmeFilename":"README.md","devDependencies":{"aegir":"^35.1.1","global":"^4.4.0","it-all":"^1.0.4","rimraf":"^3.0.2","ipfs-core":"^0.11.2-rc.2+b09a18cd","ipfsd-ctl":"^10.0.4","@types/ejs":"^3.1.0","get-stream":"^6.0.0","uint8arrays":"^3.0.0"},"_npmOperationalInternal":{"tmp":"tmp/ipfs-http-response_1.0.3-rc.2_1633023545898_0.1810821457708307","host":"s3://npm-registry-packages"},"_id":"ipfs-http-response@1.0.3-rc.2","version":"1.0.3-rc.2"}