{"_id":"ipfs-core-types","_rev":"231-d241d64336167fea43b9204daf0e70e9","name":"ipfs-core-types","dist-tags":{"latest":"0.14.1","next":"0.14.0-7b79c1b8"},"versions":{"0.0.0":{"name":"ipfs-core-types","version":"0.0.0","description":"","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"author":"","license":"ISC","_id":"ipfs-core-types@0.0.0","_nodeVersion":"14.8.0","_npmVersion":"6.14.7","dist":{"integrity":"sha512-v7DjD0AsaqjSpsHUSa9kAF8DtKY2mhmZpZIgL1QTUmLHZF0D0JMBXRQ/JhLvOwaCt4W3keTJpZbpUALU/NdlUA==","shasum":"b67deecd4806c61defcfa719cd8db31fbdd3e7e4","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.0.0.tgz","fileCount":1,"unpackedSize":211,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf2ko8CRA9TVsSAnZWagAA8WkP/1KOd+qTYLEh1JoT5OIH\n2nolPO1LNkRsxcFS6C30GWQ/awVCgYVKw4HVJ6V/RKEiJHd0J2BVF+IM+x2u\n33R501plrgIuNp7gOPAO5fqlrQdrEzF6idUHSyeiwl6WwWZy21LF4HWGBm01\nJ/ZfChR3bjlEAjXyNZEjFcQT7takdwChAyvgwj0ltltiJWDobq4e686ulzWy\nGEeUs+VMZ50h05X/tqDwKWB+M1VueWxHxQW/Lw9gjPclu3IOjzdQO7syGhbX\nEbN+wFRGnuWgcY2ho7A1HBdRU+HjQvYf9psRP5m8htFXsEn1s17ifYTgDhEs\nTGk8iv6b6Bw4SOmv0OJNJwZHUhdAm/UMm7asQ/8lpKAmdhR7ONgHxZBKE6ub\nEsc1CqDIMIaS5AT2semE3oYV/QUMnTTOXUstoveRB2SFT9J6oDQTiuOoruWZ\nxpbWLCknBOHbuAPN153T51nvUhEP/YD5Z4dhyEcmucxJ+AlqB9zFJejavexW\ngagMDBJ7Oc4TweJ3DsbbwWvb/KzZWr6hDe0eMn1bgTUw8KqunIvfi2NAoTlu\n9otY5XJQ14P5hWxBJoqojxkgLyyYtS1nu7vMwrouPTEYxr2LB7HEXvi7iL2Q\nwlttVYVpG1pDPnCdtfvpF7Efx0D28K6uQ7u3VeMUIqtPvQ5BPuRMEflmkQlO\nQu6o\r\n=koHw\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEIDsNDbB3Y6fiofcNo8gLJZcyHg4sG8FK5QoQ3ksHz/AiEA5vYyDy8on5kBW8ePPBf3kKCrFEusRBb7qgeNtqYZV9U="}]},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.0.0_1608141372050_0.1218048482642875"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.1.1-rc.5956":{"name":"ipfs-core-types","version":"0.1.1-rc.5956","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.0.0","multiaddr":"^8.0.0","peer-id":"^0.14.1"},"devDependencies":{"aegir":"^29.2.2","typescript":"4.0.x"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"2745b2587d75c31539df315c31c6eb4c13f79711","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility.\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective HTTP client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers set of typescript interface definitions that implementations can claim compatibility with and use typescript to validate those claims.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').RootAPI}\n */\nclass Root {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport { RootAPI } from 'ipfs-core-types'\nclass Root implements RootAPI {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.1.1-rc.5956","_nodeVersion":"14.15.3","_npmVersion":"lerna/3.22.1/node@v14.15.3+x64 (linux)","dist":{"integrity":"sha512-axYMLdwKfneRUwO68zaSS0L7MYAPx5Gd64+sZCZ6U1ou9WyuQdRc0UgzNuk8zcxa70u6WHcU/lK/hrC6wxmnhg==","shasum":"07f15a17249c4a9f025e8069a746f44dabfb7a90","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.1.1-rc.5956.tgz","fileCount":15,"unpackedSize":25197,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf3NWiCRA9TVsSAnZWagAAWqUQAIsHTGUSU6aHet1lotWk\nHZDW7pNFkRHSR5wpbH7XHEmvJHUASfcwbzXHC7/zbY/HTKBu16HAUlyupNXA\nq0YTJFitNDaxFN7nISho+A9L9TfNxTr/e6IyZi3neVjnbxuiYfw35OgjyMyy\nDAmaiGy8SgWk5mQvvQTRXwHcCCq3l8QPwOtVVb4AQSCfLOQWK1UcG1Gxz6SN\nCHBHJzz5XDyyeAcfQUmb1FQ0Vpjdrruc8krJU4NR5XL8QlFO4oKzTBwqIx0L\nQjra8wMITvKa1ryn/6XOmQJIk3J39z2TkknQ36FOvdZXijas77N7YW+efjwo\nWgLhjAR95EbLG9iX237l1HEYhn07fhD/kSug96ok69VTRtUfZvDBajheC3ld\nuPTqVjPP5m+aoTVITaAZbuw6K1xFaRg49rSfS3eZDJ0G+jE9+u1Ym3RotrGC\nUh+I+k/qDTeEgxWBU1RxUsoRAEwJa/8E3RzjpUEqNw6QryX/DYJEAptLvmi/\n1qnavQg6uTRRbe0miJdOezFZX0BYSofFoqaMyhEZlx1J3S9hOfGewUNGFW3v\nCPjLZ8wTg8agjux4gPT01dTZV8X+63p77gpD3PHsS/AF6vpjOW3BimxzQePU\nsSb55K0H3UXwVVQmZDEoVws31FH1r2OLLxRMd1Ee3PclNUG+MrvEUJ7BOqXF\nRH+h\r\n=zjw0\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDniwqDrmuMsVjQ5zOPyNa2I7JRbNWKEwvUZdRC8TZInAiEAxsoNj2tgt6LK0wLkhTT5bViWD8/nQ3vXOEIhHWhxQP4="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.1.1-rc.5956_1608308129979_0.291029859452673"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.1.1-rc.5957":{"name":"ipfs-core-types","version":"0.1.1-rc.5957","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.0.0","multiaddr":"^8.0.0","peer-id":"^0.14.1"},"devDependencies":{"aegir":"^29.2.2","typescript":"4.0.x"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"ae4971113534c8f988aa14314e43a00fc3df854b","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility.\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective HTTP client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers set of typescript interface definitions that implementations can claim compatibility with and use typescript to validate those claims.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').RootAPI}\n */\nclass Root {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport { RootAPI } from 'ipfs-core-types'\nclass Root implements RootAPI {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.1.1-rc.5957","_nodeVersion":"14.15.3","_npmVersion":"lerna/3.22.1/node@v14.15.3+x64 (linux)","dist":{"integrity":"sha512-vXF+zcGnssU/gXNLy2HjmLU1sfIfIEPnvBEi/YM1R/7yi31LPg2kSqsVVbMijABmbz0M2VlAuiFo9bRb9uPhpw==","shasum":"bbf154fc9d09b84c8ffbdb6678173c7ae4a04473","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.1.1-rc.5957.tgz","fileCount":15,"unpackedSize":25197,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf3OsBCRA9TVsSAnZWagAAbh4P/RgtPTBLj7Qe0iQwqa16\nnLicVcYyam2zKOpSf50/6Ioliz+LvT8cSyjCoTECSUHT0D/t4yeqoVuVxl8t\n7ioa28/Ggqo+8g5TB+VSemz5AJdMVNJp22FssELrtkfN56guruviPvnz5qJo\n/k+Ak9dOA2FAAmG1mMJrJxLo2EGXOz7dBdtpeeOz8+E6HNYCAENulx1vMdym\nB7VrvyCTS3dHoBewaEB5M4FdEKDDx6nkWiSbFLg0AvTDNASjUHPmNHiouMEz\nhmB0fSdk1jQLRnGUCNcJuLZBHmYTTyissfzMPEN58J+YoHwFMB+34le7rvgg\neAF6mb8Pq3uyVBR9xejCEbwyJrSHaBci7/Cs7wblqH6HL9ACseNz+ZIid+B7\nZav3b7lcNNv5Jm5suitwi5SI2ql7lghoKKDa6AOavxCSlqikQSBATvr1AiDM\nLgge63PoE4rDzx6HgBKSaDDZK+hxk/qF8ooPXmIU5uLv2vqT079+wFWhbbI7\nnLmv25iFAAdrAgq4lzy5NK44QDXSoncrjHzF0tAbIlIUWBvZXlJIQGU+wFyf\nnQijUUqvRUW6pEE43q0l4thbqN8kncV3DW6W8oq227Uz2mjFDztRd8Qjiqxe\ncAMk2BdAnJLZXaqXUQ0fxZ4nCulnqTQR4SUDd/bNEDFB5c/klTJeoYibffBY\nU/uE\r\n=PbSO\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDp1h0sp6Yrr2wNlcFISU/XJ3ftq+uPVco9AWefcUxPfAiEAyQSmkZx34gvqSHKF1zBNIFY5Dwem9UzQXjZEdkjTjpI="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.1.1-rc.5957_1608313601262_0.329566909500262"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.1.1-rc.5958":{"name":"ipfs-core-types","version":"0.1.1-rc.5958","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.0.0","multiaddr":"^8.0.0","peer-id":"^0.14.1"},"devDependencies":{"aegir":"^29.2.2","typescript":"4.0.x"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"fad9b7402e67a459e9967a1319870da165ba722a","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility.\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective HTTP client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers set of typescript interface definitions that implementations can claim compatibility with and use typescript to validate those claims.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').RootAPI}\n */\nclass Root {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport { RootAPI } from 'ipfs-core-types'\nclass Root implements RootAPI {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.1.1-rc.5958","_nodeVersion":"14.15.4","_npmVersion":"lerna/3.22.1/node@v14.15.4+x64 (linux)","dist":{"integrity":"sha512-iu+fx75BkGYl4y77jL97qx7BWFMV6Ezo0CLV2BF1pUC83I0lPYSP0MiQkpbnUq5XHSdgA3LhMxCJwxPrR29MPQ==","shasum":"0540900ab0c657c88b5a03c2fcbb2e049bacb658","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.1.1-rc.5958.tgz","fileCount":15,"unpackedSize":25197,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf/ubaCRA9TVsSAnZWagAA8R4P/0XGcsEIXBpG1+Y9QoJ1\nNfhIdn4z9x3XoZxLFz2sgOqXWwcG5X9/1NRwLx5KU/JFDfC/5ZXoMLYA6oM4\nRkOUP6QOiKkjjKY6dN+irCcz2yJeXZj+Fq+4kaJLpgeE6KG3Zqofz4/2x5Qr\nEEyJz8n+TXBCl/XZLAL7LkMZSb2Wyw+3cCiz4a+gTDDX7ENhJAKNm5YdPLOu\nV3l5J8IPFAzte0vCGY3H8YEP1TAQufClDwY8JKFkyXvTL82yiIxxUx8vZY+y\nJFBUoeYcIsNANV6PAxkVy7JVEsCjf878coSCOaNAfESr0VyYWjYpEv+qEKgR\naS+nYVATSYo3c6Ejb9F/WLU1hTJNVhPltqQnsT1ptqKeBzrHjqQx8YX9syqL\nxI29PUoVexNLveGu64Y6UoLq/0/XIM6oP/zyaYXROYEOu9mGE3/5UwdSu9qG\npagpBXSMID4j8uqunJXZLIfU8u9Rs5f2KMCCxqV4+UTYE3YcGaO3VHwwOgtQ\njIwOMwiFkeam/K/Xdwe+b3CwUJ2OaaWoDCF3EbZQlk+mcebpM55D78NZp3a0\nbjvsiUAK6+FsKzKmtxCWdHQNDXtq4pj4mdBFqIGsf71VlYlsDfmoRDuChrI9\nOi526x0zuKmWhjSftUB/cRObrHTHeF3odU1kMQt/l4jPgZGyDjqGbmh+yaj/\nADLG\r\n=5rpG\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDu4bW/2t+XYOyDGq0QS38RKaEM7VAybDljRYVqYutqnAiEA9vRiRX8DoC7dbcVmaSnnpZhCGkZl2aF9PgXGKtciSXQ="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.1.1-rc.5958_1610540762179_0.11845207757862797"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.1.1-rc.5959":{"name":"ipfs-core-types","version":"0.1.1-rc.5959","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.5","multiaddr":"^8.0.0","peer-id":"^0.14.1"},"devDependencies":{"aegir":"^29.2.2","typescript":"4.0.x"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"b90a495bd07cc81ac7a9dcad75c5625b59dc3dd9","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility.\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective HTTP client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers set of typescript interface definitions that implementations can claim compatibility with and use typescript to validate those claims.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').RootAPI}\n */\nclass Root {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport { RootAPI } from 'ipfs-core-types'\nclass Root implements RootAPI {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.1.1-rc.5959","_nodeVersion":"14.15.4","_npmVersion":"lerna/3.22.1/node@v14.15.4+x64 (linux)","dist":{"integrity":"sha512-FqDabPdJARxXiyE0y62MhiBlCjPJNSjj9ndJ4HEaX5UmXGY6xCxe5AF7Q5F+yg3I2dwzJo0z6/z7k5RwmKK89g==","shasum":"450943b2c46a1f720618f5f9fa4a011859292d20","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.1.1-rc.5959.tgz","fileCount":15,"unpackedSize":25197,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgAVd7CRA9TVsSAnZWagAAOt4QAJd2K2k4RxYYWUqrTBAR\n/Q/LDwhF/k2sogIiAGV29+qoM1iQsXXMAYCrpvDmD03Fbft5HNGJjY9WX66z\n5FHTKZGFdaKFbTcl0gkXra7e0NLFtgkv6xKgK9lIo1O1OkequVUguUX1yThS\nEWFNWGhxdJgKCZeMViEChWBj3oHMJEaUeKFFgENAfIvYxewX1lDUUlTB86Rf\nPGOm7WQSCfpJflNT3z19IQbomWF0NEJ1DcCXZx8Qiv7Lc1yg+3L26L6oIsbz\nl0xRbpLYf2MwcgpUb0OrCmazZ8U/ryk2iIuuzoHiE1xyjYxxIaSX87N14b5M\n1dgBclJUUt/2lc+mSriP9QakQqqF+02Q5WRJnaSV5nHnuemPa8UmvseXi+Pl\nsQpj5xS31kjuCcudr6nn41D2h2A0OKiNx6HiuZwW1dS15xS8yWNW2XDh7IJf\nv2NjXacbDFvXbe/f3BqwuBgFKlW+YEbzfrHmx9gO6IsGrMYTOSBJ5GzuYM5g\np6S5IEjFBcbGaKaIMVyw5BNt0nORo3X4w0Vd8wQnS+OPMDR2iwAaXGwqX5m4\n7yG6chAmsImrndsycKsbh1dCuSWJ+nzXB8X+tE4dJrIV3gyCB+Cc8+Cv05j0\nDnJBKbofnZ6Cpay5BmsIxXBlU/UHhJZdkG3gWGTQpHm5EyIIKuIs8Q50FaEd\nfpy1\r\n=gic0\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCj/95dO2V0ATTvtsuUreOPm9D9sfNo4Q94rDl//3incAIgct2hqYg712PSwBuMhEj5iA/46NI6iiiiItK0pbquvkg="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.1.1-rc.5959_1610700667470_0.9424498612392462"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.2.0":{"name":"ipfs-core-types","version":"0.2.0","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.5","multiaddr":"^8.0.0","peer-id":"^0.14.1"},"devDependencies":{"aegir":"^29.2.2","typescript":"4.0.x"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"09f6f0cc98e2b8b2f1dacc69c9491555b507da28","_id":"ipfs-core-types@0.2.0","_nodeVersion":"12.16.1","_npmVersion":"lerna/3.22.1/node@v12.16.1+x64 (darwin)","dist":{"integrity":"sha512-Cen7q8rEhXBRrhM5VWOtIVNsTw7dQvs7E6guXTKFpWAqzTeV39KOO5rC69HY2Boiom9pqVMZRxeqq2UKVvCACw==","shasum":"7985c89aa0e8004ccbc4cf18a14a2e4483541258","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.2.0.tgz","fileCount":16,"unpackedSize":25641,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgAX+rCRA9TVsSAnZWagAAZUsQAJjOR8idsQ7TT6LwCMuz\np0eQkaK90fW4f4Y5Gm0SYeuhd+4WhgRs6lUC8oGXlfFFg/ojQswkRkt+xEiJ\nHiPM2cX6bp4nwcdaSF1SU4UDNxRnO1spjclaLW5bL1x7Qf+8pOR190wsPLae\nVF/Uqq0EkfMXWkQHlFTUcCpndf8Xd2YpXIghJmZ70dg129QZSnYeGco7G1K1\nY0KDuehZ49xcMbkUSmg+krmFAUjMRIGHpHIdemgjV71BVfBIaJsSBCnhrUfD\nUaSafpRJUcKvnW+ccYeLK5H8oaQdnt0SWDcmlJTsOwvjLHlAYT+8Jc3PpSgs\naRJqfuCqXpm4xzDH8O3nSLbnXPFh01HWp+Uw+x2ivrhKAul6hhxcoYvaS+jb\nIxCnXPD0/aiDW+mXgEcVniiLd4Szs/I57nHPt4CiDXOiWZazzd0bvyH10mf7\nurgwIqSr6u6ZF0/KY2ymIc4laKbCeWXgqdlzqO6WGP96Z0eVxAQrSLHih959\nmlinBtbme6mqz2ihBMYWLd2rtqlbBeI5mIDrxGUxg+Krct8YlaRQmDsZl+u5\n9EiYVB9TXgeIMa6rR/2jT6rJMMynyLb3hDCX6GpWLWkM/+gpI9ub38G+0y3U\nMbWIye8mynR2FqU317DidN54+nk2BC1TlWDE1EHb15DFUVvbMZJHmFot4Rpf\nSMSL\r\n=h7w2\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCTDK/w9/W7vRtJri0kDhiPMPsiHW2SlWQ6eXA1zYAvZgIgLllfRnTnDkgZvMW+U/8CFz0Xhl+nJYYDWkgLMMG5D4A="}]},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.2.0_1610710954882_0.6267347106896948"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.2.1":{"name":"ipfs-core-types","version":"0.2.1","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.5","multiaddr":"^8.0.0","peer-id":"^0.14.1"},"devDependencies":{"aegir":"^29.2.2","typescript":"4.0.x"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"2f526025a3603026553b320e050e57e2ee564562","_id":"ipfs-core-types@0.2.1","_nodeVersion":"12.16.1","_npmVersion":"lerna/3.22.1/node@v12.16.1+x64 (darwin)","dist":{"integrity":"sha512-q93+93qSybku6woZaajE9mCrHeVoMzNtZ7S5m/zx0+xHRhnoLlg8QNnGGsb5/+uFQt/RiBArsIw/Q61K9Jwkzw==","shasum":"460bf2116477ce621995468c962c685dbdc4ac6f","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.2.1.tgz","fileCount":16,"unpackedSize":26243,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgCr8zCRA9TVsSAnZWagAAYXYP/igeL7ToOM8D4byNlJdy\n14pQVs4nKKxh0WHGhjOOX/Rv237LKMGCIq0bytgA19VyNVwgCBpGf523K9Su\nWlSNim3ZBiN4FMCO+xFVHoHLQLsvU12+3nZIW5OxKnULsEFAQYmr3Cb1lF2T\nkkM/YKI0sh1SU7g9Qxg3bPs6YvX6r/tAG+wQR+r5goSqq3hBk7mSXuZhYxy0\n4RVqrhtPhH1fe2J0p6j35bt0aAD7KPAnUpOfMg6xaudjt/EpGW0CDHSpiki1\ndtJcpVRVNx2hXYN4QLIxU91JabYDtgA4zVMBhgnGSyym0A+Yeozd2PPVnbVz\n77GZ3A2qgDdhBRW1be/ubmIa0ckHIYvMaTc6scecOUUTLjXGWThNGpD2uHXR\nRY+tXIYgG+ySHXL+k3IzduMLJPE+NlufKPN0THUJmnha3Xv1o/IvM+9NOPrp\nV5kR+thXlsO+vYiYUOXNZFiPsuCueJoAwOjGJcMfXoqf0vHiRx++dKJTcLHk\nMUW4pOSP5D2Df4v83ocKetABIZT7nLzuojSDl+IUFNX5Gmlc0XIALqOS8tTr\nUECNrUqgZA88vLVmgOdWCG1rSFmLTmfNi7+pqmxYRbXy6mx6gshnNBSmZvZK\nrCjJqni+ogCizuxoRICCJIP1BkKMZFOTntqa1aDIOlKHt0QCXvqX4YMTZu/T\nJsSV\r\n=enqd\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIE3sg3999p94LJexWMXPe+sz28C4j+FuSVAvmCdCnun/AiEA3UtawGG3u5/IEVdyZ7jDgFIs3aBLwuI/CGKwlS4NBOM="}]},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.2.1_1611317043183_0.8680309321974549"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.2.2-rc.3":{"name":"ipfs-core-types","version":"0.2.2-rc.3","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.5","multiaddr":"^8.0.0","peer-id":"^0.14.1"},"devDependencies":{"aegir":"^29.2.2","typescript":"4.0.x"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"6ae31055d21fbb0243bbb17cc697ebe18d84acff","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility.\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective HTTP client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers set of typescript interface definitions that implementations can claim compatibility with and use typescript to validate those claims.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').RootAPI}\n */\nclass Root {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport { RootAPI } from 'ipfs-core-types'\nclass Root implements RootAPI {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.2.2-rc.3","_nodeVersion":"14.15.4","_npmVersion":"lerna/3.22.1/node@v14.15.4+x64 (linux)","dist":{"integrity":"sha512-dU6gLsnomLyyiqg7IIsWomQjqUHHb9t6T20uM3kqPCjs20h6XrjUjR1n7cC7RQc8+VMvN2yd+jLgKBjs4tCdXw==","shasum":"5ef2ad60443de6bc7fd66b0ae4cb5af5ae29ad24","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.2.2-rc.3.tgz","fileCount":16,"unpackedSize":26257,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgFRQaCRA9TVsSAnZWagAA7QwP/3O8xTabeebNXDvaGnIE\nZLLGPj+gTl9ScUcD3ka/fnKzUwySFRxMxbyc4UOWibkhjhNNkdmsjHzI3nAl\nib8utTJu/8JG7xFSQP7xQp/utigOcXjXqJgyKYj/O3mDvsWInqcbIKe3ivVJ\nQ7VUxrkQtPxRiykmk2LFfqBYspQSrzY2psq7Q2mzYI7hNb6MKyNVBbUb0W9i\nUoAZU5WsQ+54rNkfvIO4bSd6GwPFkn3cck2JCi67J1Vhv1B6EcJ+3/J1MJie\nFmFvH5lHt1BwZPUxvNMsuRku7zi7Uo3UXbyzSonnX3OkhFZTUArrZhToTg0j\nsebmxeM+Y75PpkU8wh2Sgt/maMIb5LEp3HfIx2YXaQ5OQshyxnC97vwPy38v\n8vTW1gWkbzDBZY9b7hVgpexlHfAJNrBrEuvAYbh9LMdnfLWsSv+6GD0PcDXh\n+h7l80Eg+Vm6qsdCbMqWJWijNHeYLlDCwcHurgSuhNrxO93obUL+z/Fnqt96\nILc2OSFa/MTipf/TOMFe/0b4KsBLFe/AxeHFZ4TO7ZRhP+m+P16t7HtcbcWi\nsrFic/Lk+0qFs2x7yIL/ZnjVtPNsRpw0fBHGuaFCbqh3TR3uLkI4AFg9eRnK\nCGpBHpfeacH/RA/9tNpeB44RbImwV5VvSO+QZRT9cn+qbPtLXFvmVfS4lsfx\n2A6n\r\n=5qS7\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCJUOQIFi5vwaC1gUKo5ModWKhsqwpMFhJEP0FgVD7Q1QIgOpV4pi2GFE3vvU7YHEhwZ/xfO82j8hntlZynRc0z5rk="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.2.2-rc.3_1611994137874_0.7021400150658923"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.3.0":{"name":"ipfs-core-types","version":"0.3.0","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.5","multiaddr":"^8.0.0","peer-id":"^0.14.1"},"devDependencies":{"aegir":"^30.3.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"91df29245562d5e9ff653e09b54cd2390538e64a","_id":"ipfs-core-types@0.3.0","_nodeVersion":"14.15.4","_npmVersion":"lerna/3.22.1/node@v14.15.4+x64 (darwin)","dist":{"integrity":"sha512-vsPS2uxEvIKSbslmC02CDoniaKAzjOtj4e4LK8KNHEPCCa2T1vSFlgNLeqX7G2dCcH8LYPVPO3G8TVYytWgioA==","shasum":"244ce1db49ba60b88f505de6cc8e2565d4c534ab","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.3.0.tgz","fileCount":18,"unpackedSize":31066,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgF+fCCRA9TVsSAnZWagAAuREP/16vdcJS+ktL4/q6Zuyr\nkDbiiczWT5lBrLgOa9mGX7BbpkdwS6XoJU5pDCBLfiwH3px+eiAyAo7hHtuS\nIeypKd+0Cz/JMV0YGv1JCn8uOElbNd9ls0jt2cc+p+lP+mC+g5ANlAY61Dft\nQqIS+JJ6ByTbYjigFMCF72S68rLuWjHwDNn/OdSg0iRUu7HA8OaIMWm38OJP\ncoNDrbt2hyYwrVO+1vzzEhboeTKfHbKm/uaHwBJqKKN/P4mX+qdTl0XizkFV\nv5/cOOCHmUrAFuEjgUhtXRsUQqRuMIoW9PzMyyXyYMNpnjtvWc9wd8fX/tn5\nsOIMZnhFEZ6kOZ90rPMj2MHlF0/J/bYix7/P6pS0Q9qeO/urWzzqD+cQqt1v\nOiA26fkikxkCyYIbZXRlM/dK2gTxsOHkc29jlh1ReA10PMiSUaz0DRZKTVKS\nu0GSoWNNqb88YNH10nJdi+1SvFKJOTEX13UGUjCDR8TQqJxO1D5ADRsjtSbY\nfz300v561ffDcnSopcs8SjK9CgCDoQGVRovaK3Vz0/HyD0fFy0r/f/qqsAAE\nhXGoxJMKgYfgVPFj3HBGp6gLd7+UGN2+2TI6FJuprbE/J4N5RhkSt1+TdgmY\nEracXXZFU3p3OyARLEMpnEqJ5hwK94P4f6YbDql9+1oVxpTg2gis3PSpzFcG\nZWF7\r\n=yx/5\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEQ+Fy/TD1Eiwk1JgIIje/RXbQDxnRLrrZ04LAACCCbhAiEAtcdAewzGI1zXWK0C30lsfNvnZ/Z95Z/u5wduR50kCqc="}]},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.3.0_1612179393756_0.9883207454732403"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.3.1-rc.13":{"name":"ipfs-core-types","version":"0.3.1-rc.13","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.5","multiaddr":"^8.0.0","peer-id":"^0.14.1"},"devDependencies":{"aegir":"^30.3.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"be0c613c0e413077bfccfde0345b1ff2471193c1","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility.\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective HTTP client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers set of typescript interface definitions that implementations can claim compatibility with and use typescript to validate those claims.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').RootAPI}\n */\nclass Root {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport { RootAPI } from 'ipfs-core-types'\nclass Root implements RootAPI {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.3.1-rc.13","_nodeVersion":"14.15.5","_npmVersion":"lerna/3.22.1/node@v14.15.5+x64 (linux)","dist":{"integrity":"sha512-3EGiOsBaCMXDgGrv3mQjV3FtdVDQ/EXV16tq9tyXsHHuNtXLkskwCw5oKgj4vrFJl6xUSqfTsrWzB7rqgPtXQA==","shasum":"6a813709e442480486463f3d7cf5a6f35f1401e3","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.3.1-rc.13.tgz","fileCount":18,"unpackedSize":31081,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgMiTPCRA9TVsSAnZWagAA0A4P/2DBXPIqPhxC5Q7l6cwR\nRxQXXZZqg9BLzAWkJA77xXxjLaU9IIOd+sQgR/gD65BijiWkRTgaAPBnxu0k\nbvTr3wmu9AbrV9c9Wvf3Oqy+Dzw+UnMawP84ZLFEjsoMV32/yNqu/loYRvIj\nOsupQBy5+/xIdpqAO3KZqSueb1yqkb7qmGgO4pMjnc3oO6VnjeSiIVVRJWy1\nB4JIP72YRqxe/h8FRwhwelO8vajXMYYOPwMEQNm0Yps+I6qJWE9iiA84ev0z\nxaxw5/8vvWB3y7d2upE4Edmc8Wj7TEEfOMX4AAlrzRg7Vk1q/a2cs52vxInF\nQtumXbnq0NV90bgwADkCRR+uPJjPKZs87Mx11g2T3N2UiKOO5T2hSAyYSy2A\n+PcrDDWfhWtjK/TzI+dwWPYDKsHEdGuSBH8y9GxmE8s8ywLjnGJ9HsLeX2dm\naOtwVr4Gx/wxsK//mXwfyCsVDLy/lzDPr0OSaqcCgstiPdeYW7s5l5jGszTN\nzvzS4xsPdOabp/M+bNMpfq2OwZoXRbXVLVMWjgktm/R/X/pC2ERiPANcwkXv\nfJ41+ucnliGuQ93ULYDOxHvsXGNwXXujr2W95jtZBhrf+IQfT0KjD3x6StXU\nAwlEobNWInYzGltaKS2UGplj9fEaKr0IdfV5VeTm4m8TbqLOqCGGTHivjF8f\nfuje\r\n=kHn1\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBR8jwrahsmd6soZe/ryz0BA/Tk9IYPdTvVamwDTZG2bAiEAk0JjLyvmtHTft7+xifEiY5wnDyyrNOpfzYwjy1jCPsA="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.3.1-rc.13_1613898958531_0.9479481178251579"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.3.1-rc.14":{"name":"ipfs-core-types","version":"0.3.1-rc.14","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.5","multiaddr":"^8.0.0","peer-id":"^0.14.1"},"devDependencies":{"aegir":"^30.3.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"b7659d4544fbf335eb5dcd3b71fc1b81f436088c","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility.\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective HTTP client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers set of typescript interface definitions that implementations can claim compatibility with and use typescript to validate those claims.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').RootAPI}\n */\nclass Root {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport { RootAPI } from 'ipfs-core-types'\nclass Root implements RootAPI {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.3.1-rc.14","_nodeVersion":"14.15.5","_npmVersion":"lerna/3.22.1/node@v14.15.5+x64 (linux)","dist":{"integrity":"sha512-7c6Z3K5kkqvssvxMHYE8jmbnVUJXEUTSytYS5iSfNId24fpKk/kneEqIlqUBryz/Z203d5yx6KiN7tMABqHoag==","shasum":"36bd6df57e87de250e36be2e7ee9b4be221cb36e","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.3.1-rc.14.tgz","fileCount":18,"unpackedSize":31081,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgM97BCRA9TVsSAnZWagAAYyUP+wTPeHlLCgwoyqMXGqvv\nu6AoA0/tXAqbqtOWyxvz0IVb4qGCdTGBz/NckE3YAzcErP9msVdzf5vPDeKU\nbdVFGxH+wVEcfw2MBG8ktxb0YtkrxvtXYLhIfIlN5CkMUWy7f7OTINwnfIxR\nfKe1PqtrD1E4Fhgrr9YLbcU34HU/s94d+gcjqkdRzBuaZ64XNtQHo6wsqBm+\nPbL+i8BXtHJ2LDfBZWMKrs2NDbsOLRuUNcK27FwbGYvAzVc61ACkwZ7woNOk\nV8PCKQn0MuD4m5beQiU+LSQEPku+LGNmM+H1/82HQPT8fx/DnffzME7I4rpn\nWoFCGA9j7tAF9xjK3gRUFVKMJMsTBQHt1/xzmMgYFCqVNprz1xOL+vvFODjD\ndgWGR6o9v6lcJSKFxfC2w6hhO/d3+iZlePzEGoWElPS15Y98lvYAWkx01aU8\nEYMMtd974f02oAHVo/CN5ToPXeWgIdEKeHwzHiv6Z39YtgQigDsNhaVp4JtG\nvizM2Lt+x3rqNxaV14cizdYqfjSKvyhnrwybIecfGBWfzEuAI8Gv1btGuOuW\nw7MVBegZl0w9TFFIUR/uqtxyt3HCda/qc5qHwtNd9CJQilO9br8am+DVriga\nQBVkKHkrTJrtxlvnosXqkELAEpKnUr+Pb6TVhiVVM9l5BX15r9IXA1Od8VTx\n2HIP\r\n=8S2o\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHuEhgUa8a64PpaPDNutvYcgaE64/j6Z7LijaWSpHtUjAiAvCpVD+f4mIFHtduRxjiQc5uAuQ8GQmCFH6Dj29ioB9w=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.3.1-rc.14_1614012097157_0.6037198634682088"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.3.1":{"name":"ipfs-core-types","version":"0.3.1","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.5","multiaddr":"^8.0.0","peer-id":"^0.14.1"},"devDependencies":{"aegir":"^31.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"0af3b76115fce61d64f0f8be90cf13263d2a12fc","_id":"ipfs-core-types@0.3.1","_nodeVersion":"15.11.0","_npmVersion":"lerna/3.22.1/node@v15.11.0+x64 (darwin)","dist":{"integrity":"sha512-xPBsowS951RsuskMo86AWz9y4ReaBot1YsjOhZvKl8ORd8taxIBTT72LnEPwIZ2G24U854Zjxvd/qUMqO14ivg==","shasum":"5dab234428d031d0657d1708f7bb040281d6ab5f","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.3.1.tgz","fileCount":19,"unpackedSize":32207,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgR1I3CRA9TVsSAnZWagAA3a8P/2r7aVcb5uqgtcn7rYzs\nDLp43JJyLjXivvNIc8LwUYrzCgNBsmkVUcZHz6fx//RNzP0gOZyC3DB0rYxb\nwwl8RP8gV9a80iP+JZDpJuVpBdb+QDdiQom7mxl269jlgwsAYJ0RKhWr2EJc\nRz2lxgA4ClC39Z+ft/RMipd+OCnuzSZrUUss4cvFey+LMNk/4750P2grtotZ\n78XLEpuEMkeM0ZJVAWFw1epxTffZ/mgF4hZI6DnONi1ptVW9OQ82PG0vfOf5\n4fq4AJAuKYgpnypOXbWgttb2siES93661bMhTnpe0JTZkYXf7QalSUzwxoj1\n7HpHybaHmAaLmErDqg9MkI1s4gaR2l0ufP+S+Gee7IbpxV/NTUuktk15G3wP\n9yCSBKP+Q7OZXT+T+nqAUxKVX0f1KqD4ycFOmIJlSfjfq4q6vAt8lcQi95QV\n12NdV5sQLAg8E6Yw2lXnxUJH2mwVne1FMtPN7Zb+kFbxGIIHH/f3Cqp2s25F\nxOWjy3mpPC5XIbp8C9xIe/xtEKf+vPbXdCDVxGtUK2nvxUakbwlxhJhrMwJu\nzAtcRTSBuftMEa3BgkTQF6THuhF9GyxSd/O3SswQuaKiyYgchvmMdv0x76lH\n4VVbRwe33TOleCNdouuGmQV4o0eOCdO9Enz1ZfDM91ozIYGKrdI1MxLeGVEa\ngrNY\r\n=9ALs\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIC2Rsg1gpIrqO3IH34WpORngo2Y/vdaEktokXFsNB4abAiEAun4QdKYATZZYnr3Qg+yjzLElIGLRVRmVG6a37fN/y3M="}]},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.3.1_1615286838481_0.8096598925039722"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.3.2-rc.6":{"name":"ipfs-core-types","version":"0.3.2-rc.6","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.5","multiaddr":"^8.0.0","multibase":"^4.0.2"},"devDependencies":{"aegir":"^32.1.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"1823375a17ee2562f06accdd605eeefebf7a3922","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.3.2-rc.6","_nodeVersion":"14.16.0","_npmVersion":"lerna/3.22.1/node@v14.16.0+x64 (linux)","dist":{"integrity":"sha512-DF2XC5e4mrmcYlLCfozmluYCpfNZvBi90QPTmA1Tknj99rB/0bdvCsVU+pTnnJeDBMRGVtzokywrcUx0dKgegg==","shasum":"31352080ce303168c35a46e80e919ce8478b6ed9","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.3.2-rc.6.tgz","fileCount":29,"unpackedSize":73991,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgZJI0CRA9TVsSAnZWagAAyCIP/3U9rYg4rY7yX2jwqblr\nkBYUBdqRJTgXfaH8v16DgoLIpKMGWTV3ztEEmC5SU2WIIspkMXP9NIp1z62t\nspL0Dt7y1O3+q8tBwZSsZF0d5TO0itAwD7+TAHwAJhE1nuTFgZoIRcaU0vY/\nil+Gl2x0vNj++zrafSmagRYo8F/lrIDnKLMSg/t5THRkT/Msx3IoYn8I2E/g\nWoSN3tbrjdQa81OmkwQ3JCNCUeyky0VsxTLNM9e7VwmspncXEOUmyEvNW4eo\nacqujMhFmm67vd4srK/l3fhaQuj4xMRMD9p9NG8KuDlfq0XcDK/MrrsNpWg/\nkZESoK8D5sZY63nUsG36R+igD73+TVQdppL6bCvprQLalqWwChBeH9Bvhef3\nyY87cazoPgAuoDhVia9c7H6HNo+nfrW9/ZvX1Efrqam5c41F5TfsD94czXr9\nio5oLEz+E/JhaGleX96ieQQRhuSEtDq/Im0cTYH8BjY+jSXUL9YPI426K5Gk\nuJj04Ww76bvMCzdZUZ/wW6hh/wRIpL/cXPlewHh9qP9zRg7ZwzN8PxZjFBKr\njLxJdtkc3IykGGFLqbfsjNk76w7mLa4Lh0ddrfgxAkAHsiIv/FKCUQWfKfQf\n26g7vJHBWdT1SyAt3MpjFZn/jtdVQ/clz363lkiSSi+JhGo4/UXJFItwgFeI\nQOve\r\n=jEfJ\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDg+PLjbc4KwPsn2nNaTDFB5uCXycCBPoKGA6hRITw64AIhANvePAKmf0YAigqb0pIrSwZU3MocrpQSXdmWAEQNiW8f"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.3.2-rc.6_1617203763456_0.9588267907408552"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.3.2-rc.14":{"name":"ipfs-core-types","version":"0.3.2-rc.14","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","ipld":"^0.30.0","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"e7de593c9fb74bbb82731c9ed41ec5204b18b1f4","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.3.2-rc.14","_nodeVersion":"14.16.1","_npmVersion":"lerna/3.22.1/node@v14.16.1+x64 (linux)","dist":{"integrity":"sha512-FizL30C1M5hpwKaKCL3pGg+nLCAnxsPTVnlk6oZ9KsUSUyPANZ0nj5g0JHzOV5gHQacylbf6qvxHXO0iHmlRMQ==","shasum":"82133b8294fedc2cdee683858967c3da8756973a","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.3.2-rc.14.tgz","fileCount":29,"unpackedSize":75504,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgiVIPCRA9TVsSAnZWagAAv7MP/iJJeRdh3PDErW8XyMoI\nKgSBInybwTItUaTjmLYHE7WToBgHJCGrze1Xpe1dSxfGT3VB9QHmdMPfLmLo\nsXcLT4rOWQvhUnA/Gv3QhO/sBHtWX4HfQVu96XM9I3GNWy1ispwIBFFzQaIv\nwHQ7ctiOmpcqijrob0qeP0c4PTnFpTNYddULIsdLomGVaNw3gF1HMYtlQagA\nd6oMJDjwIkJeLvuJp1QgGFvz5kw9Ihm6RzozjNtFeNSVrc/IY935sLJNL4bZ\nPCX2E/H5s1O1FLDb6C0+DzAL0/2xCgVO1TDxmCIHmBrJKQ0Py9tQWUqk08sh\nKDtCYiS3d/ICnIh1ZH17yMcFL5fuW5LdQ7DpJ+4vn9gpV1+IMEB4u5CY3MAS\nnKgofnegJUse2urMQO1+XZhNb5P7dhxI7X4y2sRhJL5F/fAY0YNJlLjiQc/P\nvwcAClVG++rns/uwitbr1n9/8FRzmrjEjnTutY29xHdahxJgUnfXsNHTJtN2\ncJ9H7TDWHn82MMULjfmw2RSMGFAnZpJ8DIqfunoWwtlADvhBspHbSKIR0xlU\nPUIJgqqnr38yrwkvax36qNkW+UtxPclUaMOfBeWKew5boZkItLqvh3I0Icvn\nnu8bHs7cZrCrG7YTP8LgSyZY5kiPrSCE/itSWbrVH+oG5n1ULSwuW5EN1e1v\nfDQi\r\n=CMpf\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC5z/iIAbtH3ej5AqiwQy3hFiG68rPSP1l4yrlr36+CHQIhANwLSc5w+zB4XXvtPsOrnUhU3rhD1qM5DhrguW8LH2bC"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.3.2-rc.14_1619612174358_0.6477241791668904"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.3.2-rc.17":{"name":"ipfs-core-types","version":"0.3.2-rc.17","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","ipld":"^0.30.0","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"12915f708057c54a08ed0b1f6c417eee8d65ad44","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.3.2-rc.17","_nodeVersion":"14.16.1","_npmVersion":"lerna/3.22.1/node@v14.16.1+x64 (linux)","dist":{"integrity":"sha512-8kdbh3DaeWeg4XPuI/6IuJIS2C3IBVc7YEF3YuXbOYKqhwMATmr9UyTxQUcOWSNaO33O/HRaix6RTYb5Kohr1w==","shasum":"b388d76d8ab712037fe14c283d0aa41a1415f2e7","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.3.2-rc.17.tgz","fileCount":29,"unpackedSize":75504,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgiZeTCRA9TVsSAnZWagAAyNQP/RYTa7rxXLc+AgjuyGPJ\nlqyr7lX+LhagsL7azfdPfPy9fyZxUxciIMkKLzju9N84MOXhDaogT3fVWBCr\n0csDaoko+ki/wb6S1ld9IkXe4wm1ApqtFNQpCR95e6CEJEkxzRAj0SFRqxXc\nyPAIqiTedXPvnVpBNMMh/ifHdfnq8hPRzudK3HieANKv/umgnL030igWPLDJ\nl8FW6hypHNPsn0yWNVscuuyohAGMunB83j1rY1e4UzGBWvB5CVWOU5DoWpQY\nZxD15MK1nCfSjpfUPmyo8q8hM1EI9f+RExDLl+Loe9vn30Tt4Ib1rOxIs7G/\n/Z4K37O1OGfvxg1txOrCOz1cm11gY4uU85NhXYlwwarUIISHD6vDfc8hzgFu\ng93Hs638eYrtn4Kst7A9TEyo0mWY/uosBqUX3Vgr+cWVIaafJz3HZ6Y7O7OI\nSjdHk7Ep4Wiu3+964gPYCz5yjbhOQxLF/C+199iDjEpFVxMLmjOOK+V4mPpk\nhD6qF+KfllJc8sSE+R15JGd0kBBZktRLJiUcYmAUy6u6QuhhRmh+skPIBPqI\nv7HahRug0EfoAaJtLfGOPMNTHk/YoVo63AQUZWl/7JUWCJhxLalLpD255nUr\n422yC/fOeNCqjjnObXbJFUCJRPOIbA3qOSj4dQzB+IUkZaJP0ztBj/bSMJLc\nMxfq\r\n=l1bO\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBTzvaV0rfCC249Kgr10WqAzkQ92Keckkbwu8SGeAyKtAiEA210Vnq/lG73KGNEufIFQTuA1RmKXmwI88Dtu0Zzs/fA="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.3.2-rc.17_1619629971020_0.6767420542521498"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.3.2-rc.20":{"name":"ipfs-core-types","version":"0.3.2-rc.20","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","ipld":"^0.30.0","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"99bde7a194e5918933e589d685dec222b083ac42","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.3.2-rc.20","_nodeVersion":"14.16.1","_npmVersion":"lerna/3.22.1/node@v14.16.1+x64 (linux)","dist":{"integrity":"sha512-cH2JidG02OIWdb6s5gsRuI4lulqycZmIvuNSlHpuUKJl2Jve13Kn6flGsoNPGzVXXG0FfzybseNQukTojdjx4w==","shasum":"5df36ef624dd5b3262e469ee9f242e4774b24bed","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.3.2-rc.20.tgz","fileCount":29,"unpackedSize":75504,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgiuU5CRA9TVsSAnZWagAAbjgP/2rPXI1lbSSW8gpj9rh+\naLlgF9c41beIFMeVcesDgvVkREN4N47+h8790M6eORbw0ABGXu5R3BbGEQhz\nRdtMK+ggeYkHY+FCOby2pkUFOyo8XmVwbb7iMccNUmbzYtldGXRoolU3ZRYO\nWCqcCFNHjpEjT7VzXpRQtEMoXCenOCaXFaVLzdXkFsGD4pyDg95R8kZL0/Ym\nxCyfa18uv8T6snOttokq9s2zw/dSr4Jp1Vq0zzVZrSzsYIso/4dc707+bsQQ\nbOK9j5jhLPvJlAlKDnwgaVF6yj5oqcPEfE6WgNIFbtlVjW5R8Lj+fRWgRcsp\nSS1kEAJcVE6hIYqAMToVW13rmMBgYw1HMABi5ZVJnMPR1msxdutgBDvb7Uoc\nDaTgL2MmKQf3swR/LPvk4UsdCJHweQhAKrm1kMDyDnUCfeJyI2pDmVm3JSsX\nS3aYo2OgOvb+NPUCiv/HJVXBO9TSpnYw7vic91f/ABZelOejMustPR/gHD7m\nmGdCTH/eAALs3L/M1DL4Y2ABpvZ39blGIDK98YzcqDIHT77Rsc6Waxjy1rtZ\nut7jvGNkq86ZKOcPpZjXKUUDKPhTyTfz0pzhYua5GxeaWLZNjmGaaeHKXDpB\nZHicec7Ym3c2iQE0m3XWRpofCDHCu2QBvzFMjq6AcNKTgxJGGa6bQ1na5AdB\nZe1m\r\n=pVZa\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEOy8V4bq8KenHL1PttC6FIClwnp96vRNT0PUliosckmAiBk4iYYtqRTeJxIaUEQNrEHTRAhKYFHrfGSfOPY7ymL8Q=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.3.2-rc.20_1619715385091_0.48254136732833053"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.3.2-rc.21":{"name":"ipfs-core-types","version":"0.3.2-rc.21","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","ipld":"^0.30.0","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"2ec15c083eef923096b30dd927801331e97b4f5a","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.3.2-rc.21","_nodeVersion":"14.16.1","_npmVersion":"lerna/3.22.1/node@v14.16.1+x64 (linux)","dist":{"integrity":"sha512-wmF5BIhuMRa3QEOyLsoNI7OTsfeUeGTEzwzY31kRhz/ln+9EAxsPZp5a2T5wcQzVhLxlTOCpsZfPhqY/9X6A6Q==","shasum":"a8caae40451144ba496f5875524e1b820f437cc2","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.3.2-rc.21.tgz","fileCount":29,"unpackedSize":75552,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgi8zKCRA9TVsSAnZWagAAbCoP/AyMsihDtZwXF3NFTHOa\nSA+i2NGufJ0MqfcZ52KrjRXci4kD3efl16sGY0xIpL04wRq32nxvdSe5/QBk\n+Z1mryi5TwYvC/oBISr5oJg36v5wZtyiOf539+4fk91j2rVFBsrmIM10GIro\nHOVp/HFCoDurM8BBxPn9asAoUWdRvprLsl1W0uEBMHiAqkLGxmm24ZCFj++Y\nqH6qI9hMp637ybEb5XzsafkktAFbtnfy+6GoNZfDVvRlvt4X1NGUUhUoXBR6\nwRQp9q112DL7Qr+WsCjpxL+deMvgk52iWAhTBNKBqVUXDczYxpR/70C67S+G\n6+HhiyHoAQXKDK6E8XsVx8iFceK1QtdmuvAaYN5AD691Pw09cRyHJy+EX7f4\nk+lc4IiWf4ovfcHnPNasvLsloEOnQFyxAf1ZzfA1kwBGvHaLjuPaYbqDb4p1\nDQ/+h2lLUC234fk3syMo5RtfF8meJoakou7uBRThhrN04L48VQOsfmF4OjmZ\n00N4yqcp/QBeXb4ePrseIlM0h32nKl8fTb/avWti4hHl5xhZI7HwGniMfPak\nEY4r0LlBaqdMD1NPCSgnekuqHRK5nxAG06uEVqj4V1xiUDiLKQnVOJXQ7xPS\nxoGhUUlc35rahPwrw9uq4mSnnJ98rDGe4pBvs42EqRN5NHKUXR0O4dqf3iKf\nultT\r\n=vShL\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCtvNhUvSNno4p6ZY7hv/WpwgTP3WN2qdY00SyVYTjYQQIhAJ2VCLDxrdjnBRUbqZbb6sE/24+gKq2fbmGl3UxR/Umm"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.3.2-rc.21_1619774665976_0.05538451385094434"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.3.2-rc.22":{"name":"ipfs-core-types","version":"0.3.2-rc.22","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","ipld":"^0.30.0","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"188f1f3930ce2dcea5a4fd6b6b1cf413ca04a736","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.3.2-rc.22","_nodeVersion":"14.16.1","_npmVersion":"lerna/3.22.1/node@v14.16.1+x64 (linux)","dist":{"integrity":"sha512-kqAdO4P1BweznnkYm9gJWKIlsKdKzdsoNT/T4pkdKoOOrTRNAtHsKFj2pP6raQlkTibWSDEkvn2egangJl7gHw==","shasum":"619be5c6a84a8198e777202ea865321d580dec16","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.3.2-rc.22.tgz","fileCount":29,"unpackedSize":75552,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgjDivCRA9TVsSAnZWagAAhEcP+QBmhW+ziqnZPbBHU4gV\nNHN4rYd37bdYRJl91gWU29tIdORwWkaxsDZBPPlwsxj3OqyuGoeEtJcSoUlq\nQei9TYnpbA2c52to1T3fDb0D9sikvPRTOidqeTsHl2OIBcN4Xow7DzIyyNyS\negNEV4L9PQc37/MdeHmQYGKQ864g+dQ8TQMRzUILtjIFza+SqYToZ0wREyQ5\nyf7WITGptI/78+A6b010Vdm7Es0lEeRB8agW3h04eCSScDJLdlEkepNqqVGq\nzyydE7+jKOlJFkXqlXD/C4PqgSzQwQbZPD+hvrM7NmhmCyrrtCsS6VfNf/aY\nbnUBPnA9dDuAqfiJgXB+o5BDnO0ospvcB7PlUclyiPpiWUhBv9SIFdH/HJNr\n/sJvKRA3i5FB6woxKgUxoxtPdPQ3/2ri+tWJ4GuTH6USAVZqNzKPXEoJgBVL\nvqMb5qiqQdUksfAhCwGKc5nGHZpH2wUpYFT5hmiw9y5iZGAkROjwPxabniRB\nb1PjzDjoS0YmN08+b7Hws3PHohS5Qdpa9tP9u850JA3z9lty1rZOENolLyL8\nxEI8ur/Jo9BU9GuEZ1gIzZ430N6DT4CWijZJDXWSX8Z+70IYMRvEFn1nP+Ai\n89g5eDHHEGW01PbwzkTySuTQjLrG3LxbOQKcX7IoEHORYZ7/p0+mt0iIBCJy\nAysd\r\n=MevN\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBgn0/+ptygSVWwMD6t0cb5C7lEwRNy5JGaJIwrLIzu8AiEAk5d9KQb7+Up2LfzBxkawm501utT/L4V5qkdcw3UXAgE="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.3.2-rc.22_1619802286467_0.31971856937854426"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.3.2-rc.23":{"name":"ipfs-core-types","version":"0.3.2-rc.23","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","ipld":"^0.30.0","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"1a447f893072d482d5a7ad148f9232dd43f64cad","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.3.2-rc.23","_nodeVersion":"14.16.1","_npmVersion":"lerna/3.22.1/node@v14.16.1+x64 (linux)","dist":{"integrity":"sha512-BcI4xgIVafTKIR61F769/P5PmBqDSwu0XXWuJZ+XQMRlLh5RBUq5RlO0STDVus3inODciCuUibUepUrTIZdh+A==","shasum":"1da058f0db58bd51d6094e2eb5736257e68bf985","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.3.2-rc.23.tgz","fileCount":29,"unpackedSize":75552,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgjZVvCRA9TVsSAnZWagAAvqAP/Rr3jSrwDzloIX2MrU13\n6HFlhod0H2nYjr5NL3Vz0traSgUJvbDuKSxqg60tF64Afrf1FMGp66PCWiSe\nJTSplgSQ8t+VVa1xJr6dPdgZTrTMJLdOhtHXWQd29h/+GWC6PB1rilDj+m5S\n1aO7HDjAq0xKT9VMknfZ0rNVl3kLIVeS8i80VTWTF5n1VabWBgCtiiYlIX5/\nME78H4KfyPDVv0Uqzsb0Wh+pP37FwZdZBuQ3AAXTNiPYpcARUcDvG/9CH9ZE\nu04eltUEjXMTE9ibJrrddZyEpjXuTQ9rNv5NjZJSAdXpLOstCLonhEVmHrGm\nKTlqTzkaLR/uTcT4Io6aPgPdKdynTfkZkdYTXlZLTSd9ZqhYw8dk+yOUbvHA\nepRE4QnpmSsglBUjcyxUiPSnKaTskBSvSDtrvuUkxf0yiGvQ/NPDvg2bJMW7\nvZE5C5eRUazakIQD0PM5LUo1SnWKRi/2Z0uaFQWtRDKRPzYzg5i+HUCFPQQF\np/Fh9RM2v+WSXMfF5oQrH3OUBRVRMa5FZWicw8z4+YN/CYuEscN/0yT9aWDM\nrr813nt6GJqFH6ZRFQ1B80Bifn6gqTjUeL6gDFYv6q6lCsEy9JoKveYF8vbz\n4OUyQgzUjDVROLIm3qL8Os+Bb53qClzXuCLFHg1JKjtsUIwlzRCxccDwsrgU\nS8/7\r\n=F22e\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHabn/X8um+W4DcEYE+XnRZw+4ftvffw0YcgHp1hDITQAiEAuqurFJeHe0hnjVIqFAHUqea5twatZvwCIGx9plk2v/Q="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.3.2-rc.23_1619891566719_0.030485704724742657"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.3.2-rc.24":{"name":"ipfs-core-types","version":"0.3.2-rc.24","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"21b70a1ac38d53265daa52d8c0eef12d4e3255f8","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.3.2-rc.24","_nodeVersion":"14.16.1","_npmVersion":"lerna/3.22.1/node@v14.16.1+x64 (linux)","dist":{"integrity":"sha512-Jbxz5CtUMkOlkkApgh0GcKIcsw0KJUgUnL63XL6+VbG1+UqyTKLKBwY8tCgfKbHOznKtZ/EFPQ2CeeSwg71IWw==","shasum":"cb54b3f70ab9f16db9e3e901776465eb2658e556","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.3.2-rc.24.tgz","fileCount":29,"unpackedSize":74505,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgjmorCRA9TVsSAnZWagAA3aMP/1XV8SZOAuV+SHa95nT1\nwS4ZSG9JleVALUAaf9WT1iqQv8AIryyhNWsd7g4LXPXhE7LCrqNMF2822h4P\no6eJfK/U9BvG8HRdbEYdSmR9BSwU8X5JPte6mRO3IkgDbwqrSk9iZiD8THNo\nhCSPQGu3ncBhmLlBx63YH3YoiHlfETO54iFEGg8C6/ZtCWPY9v80GkkvVSNm\n6+thRQp8lqgzFOoHzDKsjJCPl6y63syIqOobmfJNrz7DsB9C29hpAG0xGcy4\n4LdAeyFkH5ufraVGFfyKisDnIxC2EBzKvhbTj5U/ThlETk87VBRSN/IXATUM\nIjCFOB4fSEtt0pCiNIrZgDRX6upKQ9vE0/4W7D45W+euazCODmswg4XJuoCf\nHdsxoako7r/atmKMiNVX0fVsGXe3CuVfIu00t/PSRD7AF/UBPIY6IUxR+vEm\nm5Y7iXOta3puJ1Xz1fTtfOevwLZJUwRW/9+KAi8PhtvgKIfZL57ZsTO383in\nh3jR5sskdmK+WPTpBEP0goT1ZRRxiEZTzT+VSIELmNf0Lo5ORgEdeXCyZS2k\nsHPo4n3FJhTw6srWUoF33QqNkOf5BHMdEcw45tikcL+si2ZL0Lt/cxWn5KHc\nj+EJVvfpEvCkALhTxhCPVMNzRvEEHqNSEzCw0Nkoll0lERlUTd482nX5OMux\nD2Rz\r\n=2zgN\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD/WlL8tM0pr21LeTcj2C/XJIaOqA1m8cfQROCyygtjFQIhAOnpKFcZK0+TpxfdEQ0yMb4NjKWDsbHI9iAskmwQhWPW"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.3.2-rc.24_1619946027074_0.15026950816215257"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.3.2-rc.25":{"name":"ipfs-core-types","version":"0.3.2-rc.25","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"0a4fbb4fa20b17d80b75fc57be49fc8cd7c14877","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.3.2-rc.25","_nodeVersion":"14.16.1","_npmVersion":"lerna/3.22.1/node@v14.16.1+x64 (linux)","dist":{"integrity":"sha512-tpPtwaCzDjgCYVstV9AJvy5TkRwhC/e0SxpqErlK53m75Ca1lYdwAw8t1lFDsBf2FZozKPdDXpl3UALPTrhpLQ==","shasum":"69d7ee28ae42feb8ff01ac5a517476238c1ace84","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.3.2-rc.25.tgz","fileCount":29,"unpackedSize":74505,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgkPt8CRA9TVsSAnZWagAAFpsQAKEVA3xYYhOA+fpqlAHd\nvHWzHTaNKCkreHXeXsqqINlQJVDXcAP9Xj/Tokq/EYBwT9qlpKSSWuroEcBT\nL9klRtL8Atp8KENPNFLjePPhWln4lHrVomYJ/rsT8smmLDQhJfV6t+xAB6Jg\nGZyvP2zdL2fajyUkAnzbfCHdaz5z0vONmlzJnwxuE8D+1fvQxgYSnBhl0KNw\nlZvDXIh4ADxsJJPQ7vYUk324guuExq9sxhql3phTgC1Emx0fZ1k7nV4A5Jhy\nKALgEJ7MjEkFff5IUt7bkKLf0VQ/XF0AfLWm/ccAgbXytkgaK6sV9n9wVp93\nRXhWqhTuvstExlW+dgp/47LFdZvu781g/oTJpyW3vVq36/SpDED6V3U5SvAH\nqyfpPJT1R88C+Ct9seOAl+4uorfKmZ7C6O7xVVMwbfg78Q/GkQ07gDAwxGck\n+9j82TdCeLmF1suAi6v4Q3aNZqffqo/WtHrRhY5731dW7VKitelpkZgdSt2H\n/kL9IusnwUsjDPPdenJFVZb2Etzi2HIhMvRVRjsVQzJinacta0mLmzhD8Qeu\nhqmH1Z9Zh0SOuq3DLnTteHR14uiRv3iIC7g9kHiA/K8S1EMSs7fs0xopLG2X\n28vnmcIF7R66ZJ9qQB7980nBjvNcJHtWKwkis0h1jJPX9kIHXHb6hyrvmYMm\nq5VT\r\n=Kzxl\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCjToLVSICemaDckJNqqLhErjudUBN8MtqflP7RUQa0cAIgIpQ1TzphDH8mD74xnsnA5Tc4cx6vGVjWlSPYXMu7FB4="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.3.2-rc.25_1620114300068_0.3728716922771509"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.3.2-rc.27":{"name":"ipfs-core-types","version":"0.3.2-rc.27","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"a297e8e4770f0b8e88e065a604acd5928e561419","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.3.2-rc.27","_nodeVersion":"14.16.1","_npmVersion":"lerna/3.22.1/node@v14.16.1+x64 (linux)","dist":{"integrity":"sha512-lc4FTCjaMuXcZzZTMegpsLvh9GP8WrXci0pWw5qMIeF3xiAM4Hj64xlvbIdVtoLMZ0OJaso5UNoCDhtbW2ha7Q==","shasum":"9786eee9eb015fcb2eb6850d833c877f6ea1a7a9","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.3.2-rc.27.tgz","fileCount":29,"unpackedSize":74502,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgkShyCRA9TVsSAnZWagAAJn8P/A4hxDA7tj73LlPNzDnf\n/Bc5JTaFfyeoeyEjau/R2IV2OWyOvBqKBu1nVMbS+xPWCaI0x5UWDFv1XmfO\nRiie/y9KXh0j6cN+ir8uzmHp2UuvRIhJDfisTdiFVXCIekKOfQ1C+mlCbJV4\ns8MrC5sfHLWVVTB6likNUvy9Edvk6gdxmvoSBifJqwFKB3rtywCn4HUXs/DK\nuqtFFIngQiI+IWrhJzfo6viWmvkckbn9OoljzMv2wj6p3hBq8IfbFKnhn/e3\n9H00nHXltdSl2280h+zGUQQ1UzNNKP0rlmYQgvSP41f6mYXzzQPQOAe4LSJt\ntluP1ImE8QL/wh3FWBQAxefuxSwo0S7B+x7DzzQedtw6pvD0K73rCIEd5+IN\nlM3RLvgN92NwKE1ILT2otUhdAXe22DBgHTiPdnUVfbQ4I4YUngjd2FoaI3tD\neXmGC09TyMss1ChmMolbeJJ7qoPUe4Ei+Ojmlchk7LJZN8Bh+sqELILdqoCR\nRhiC6bojRpRH5x7flyqODNbJxI3faLhOFuWytizl04bYfnRxfvKE4vgy5CCU\nbgrI+kjNuj0QELv3wwGPxNmRl04u3Xmir3/f94p5RBIg/rUyfEABq81pLkGz\nvjvqnGkqvHDUH4LGZLbRH7t27Hl6o/Wdbxx/pbqL5r/VT1I96WQPMOxsE03e\nnPTJ\r\n=4Tck\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHU0mrePCmgES65k7I0qpLcIfqzVxG9A70OP2fiV0B1hAiBjLMEqNIKvGzN2sED5dRigw7Uzj5ZWFTto6zLJs3Gibg=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.3.2-rc.27_1620125809813_0.9044191053683062"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.3.2-rc.28":{"name":"ipfs-core-types","version":"0.3.2-rc.28","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"09a65ff238770978bc9a91449c9d76896f9db8ce","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.3.2-rc.28","_nodeVersion":"14.16.1","_npmVersion":"lerna/3.22.1/node@v14.16.1+x64 (linux)","dist":{"integrity":"sha512-zBL8VkJjhdlzpDuexYg+VOG/R3aZ3Yya422OCGr4adxzSPRE7SuvLEEIBgb0ESm/VVALI76QxES+Q4vgO6i54g==","shasum":"8467acbf7e970b18ed40da208e7e33516b16afdc","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.3.2-rc.28.tgz","fileCount":29,"unpackedSize":74502,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgkS2tCRA9TVsSAnZWagAAcT4P/3jTJMpWOxV/7QRFcOWG\nrYnO6+jaGTUXv0qvLoE9x62KXaOX6PdeFhDe1rOpiqKUXxaY+FqYf2pb18aA\nwvK1gCNm1GCbVbixLAAqC66i+xu2JKyUu54LtMsb2mjTsLfiYObumDqHxfnI\nzEPsdXKmxu17Ti2FIJGiJdUvgZ946KkPdceO4fChHdL9dNHu3Q7U12EoJvSR\nMm2fa4vGivr30RStLKzHl5ub6Um7QgtdrjUEpDPLkcZlZvOLKQwHQsvw25+N\n59rp+zu3XjIRyGyW8YxaNdhaU6Q6fAfQFH2hEKOelI1indQc0LKyIekGhDDv\nn4NYQQEBm2oNQjxvIIE75osEdigDsvq6f8E6Z1DyqgeG4N1r2N/dwQ84iTUR\noJdKvLzgYUZ4zAtWEJlhJG4frJmsqrpwvKI4DgrMOtHTHvHcKugHowMlSYNG\n3TuCShrF/UmJlkCoc0eXAGfcoTy/KTQ5hkTSHeLqSw0CPrcWqUO7Cmh+3Aof\npnN3Tp8CXkCh9vRG3PpCajvOcKhhKqwIzOVQxP7I4r+J4oI+KdeBL0QDBYh4\np0ZHfVNgl2xBu8FwiROWPzf6yomYrvaPwjI01K2BtaIY8vz7b/ZwEecZOntf\nEzeNkJ7uC1/MhONiRjGudvl+vKmCVxq1xHyGenSMeD/8geHEwAUaOI+5QM5W\nGi7O\r\n=tXXU\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICsI6sSTQ2zdS7cVdsupXGtHSF5hV89hQ5NjIzCJq7QdAiEAzBCti0OCa3A8CbIw/l52zRBa8D/2417dnHOQdUFggs8="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.3.2-rc.28_1620127149156_0.7798228642009202"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.3.2-rc.29":{"name":"ipfs-core-types","version":"0.3.2-rc.29","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"1173edeb04e6497a8e4d2336c83fa8c450fc9a24","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.3.2-rc.29","_nodeVersion":"14.16.1","_npmVersion":"lerna/3.22.1/node@v14.16.1+x64 (linux)","dist":{"integrity":"sha512-ZYf1ITamsj6nHTATiH45qlapif9OvENIed7OpfK2oXTQgCrb1f29ZpzCTLqO/QxCqP7420CpMVU8j5/VpKW4CA==","shasum":"9934c367c9962ac6d8d352ef78cc46a75aab111a","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.3.2-rc.29.tgz","fileCount":29,"unpackedSize":74504,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgkVJfCRA9TVsSAnZWagAA6U8QAJoATrK1RVu7LF+s9/FK\npmWa+c1rM9SPrpkAVYZtqd0Ux1mpS3WJNq6Px4kbGgilf6ZFFBiuzVH8evVf\nxuo3dVSWxiHBLrWcgzJTT+fcFGdmEMOx6mQA2VlFzElA5RcvapCKcqlKCHZp\nbnPa74Z/9HDy9aSnFKI1Ze1Z0XWm0UKFjstCa8JeFq2aJPa76spNLTChwVYH\n+syQNFuoVDznN9LQoe93w5qrWbkXGXvMJFVVaPK/r40BhnlHfbFL9L8gxwRK\nct/is/nC5ehP9klki8aYaumulxt6hPhEmnnaMOJ0RgW44BlB77Su5ExPclvl\n7zAQtfg2ILAD7RmUnCcqyijozaKvahLvUmm7URH+VIkQm8J4H3pmaAHpcEhR\nfiKZqlAgkz66H3h9xthMLqo1V8KXW95KIM9X+c4qMtK5lMks///PiTpDzExW\n8pQnyEcQPsZJARL6dlulWvDZJhujgqtTkhIkIYh/Y0HPsGclCqLhTWEept6a\nlDFt+g+ulZdPz9K2GaJJnhg6VsBHpKO3mAJSMXNRY6O5Q43r1d7QYuDJH8+w\nNoiACpss1nzGkoUbQaSUlibY8LpZL7Sh5FL9f4M27g0DJx3dlAdciX7Ujwo4\nzd4sg/+hnBWdT2Uq+KfwAECjGFVLkKW41/urFpQgJz0GW1bH4KcWg7oCXKwF\n4tYo\r\n=WLxP\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHLQVYUtw8ijXW5l2B2NK+GxFbYFSuyHVrbG+5kJWkbRAiA1hgBK7AWtBM7M1C6NnnkCgUnDLHhSxxKMNM2HxSgYbQ=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.3.2-rc.29_1620136543103_0.3743389861662594"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.3.2-rc.30":{"name":"ipfs-core-types","version":"0.3.2-rc.30","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"3ff269385bcf0432e94aed545f74ab370d664557","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.3.2-rc.30","_nodeVersion":"14.16.1","_npmVersion":"lerna/3.22.1/node@v14.16.1+x64 (linux)","dist":{"integrity":"sha512-0UlYpKkzopgVkBSIGhpNAsKvge1LeiwEOyIgGKx/FPAtJ7zpQ7DYuWfNCWmpBhK9kr3Jm6DOYznuFo/8PIjovg==","shasum":"f0eb7c2fac61c2f57d9c5bf8e21aa7c1cbfe1936","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.3.2-rc.30.tgz","fileCount":29,"unpackedSize":74504,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgk9ZACRA9TVsSAnZWagAAydkP/iB5McKau8uuVJX98yLA\nvP7APxHnc9fpSYsg9aSrIiIAsW6Z8yWsHqSDiyiI4gnRwLfTpyCJ8qwH0835\nwBrzEbgW5sBbLlsy25/JX2/7+VTgQ+hdjvRahus+thx0wRAhfouRsubSGucS\nJjjSlBTAsANv8Gx8bPzxDbILsmx0SNpdMZhoQhFW9vYxj26JtrGB+kr0HKlU\nJ88HjuZZBZ4qcz9pYmp9wjRFGv/k84lxL1ujgL55by3s4Y5M+RyKq3e8OmCf\nfj5EbktOcikkYZk8R+ldrZJwnKGLZ2ynB9cLqDRWR9p//Tm11LL8JW+dR8Zl\ndcw0LmCkMYrgyR06aD+kt42HZ6sOHmRAQNEzdn4tbZ4qOWJXUrIISiC/iTAu\nHKe9e+SxG4Y/tpXeMA+StPPQFEm9NbUOLQZuHtFwEUzXgHNAVKChMCby2PIM\nHIPTIgNscnOfX53xVBFZ/G9ktdfQYT5KS76lRikERQiR+sH+zXvMSpM1V1rb\n/EnyG5hz8gg8LreMJth9RbtYmEPkXyF3mAJGLbq+FDvU+/QJOZY3p8vQIP9A\n+MGuaTvkEsJcNeKltabcL3ucBKrCEagC/b0dzFkc/bBT5IgD8rz2zg+yYCwb\nwk7ZG6d2UTfiT3nWaXjFki8Jcn8CYjlUSnAFzat+yv/3A1hmxQjHsaAXvHDa\nDedR\r\n=UqWJ\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAto4ENGCAG/nbU1VdL9UBt1QhlR1EhbYZM6P4EhCqLSAiAn3RNq5khKhuYMoIMIkYTSRJKFfq6+jzciFblazXDnKQ=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.3.2-rc.30_1620301376436_0.3790179369661635"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.3.2-rc.31":{"name":"ipfs-core-types","version":"0.3.2-rc.31","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"d5897854419e83a146dc8cc01de04e73b250d07f","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.3.2-rc.31","_nodeVersion":"14.16.1","_npmVersion":"lerna/3.22.1/node@v14.16.1+x64 (linux)","dist":{"integrity":"sha512-Rvh/L84ZWYgBIO9IrXYxXKLj627Y7C+SK2WWsEcS5LpgCLmsAp6j7sjH6xWBPfOztNVSoUVntmkfBOrVbsxqDw==","shasum":"a89352b68d79508434b6a2f998f4fb4692a0119f","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.3.2-rc.31.tgz","fileCount":29,"unpackedSize":74512,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgk/qLCRA9TVsSAnZWagAAuh0P/AgfIvqAmF9FSu2/QCYZ\neK4+f4YqdCigbkTUUYjURKwmQpPqcShAown8bBUvvmYHK+frazFOoJ4JRVVG\nYQ5tUkKX6JfGoM1Px6LHmYXGhPCJ3SvJ9d96C5hMDapPAO8Ic9laaOUlWGru\nrJOZPdrj0IDEX31dtViuMGX8gqAWTVnfZEbOAk+u5cWjTjYEvd6v9d3xjVVQ\nVfgDCyVGdjP/y3WvBtVTK8jGFXZs97pWs0r3tYCsSjnq0dEJUZe1KVnimhvt\nPiaX4q3offKdNKeYgTLr210zzmvHMjcuNKeE7Ne44/VqdTHCFQLuHo+Vh/i8\nX39qeiDsMVbGMTUvDtehiyQQ2BnHwAYbu3hePKAAVRLqRuUgQO11rr1vV+wn\nmwFXBF7nREAnHGY9xOqM6gbGjjhgw+/+6J/ez+kmwU3pJ4WAIa/QPOPwO3Ni\njEiOjxhbkWiFgAwpMnCO9dN0PDmZMNNU14z8CZTMMNif1q+PNXYxTqnmwoYF\nXCC+hkMqbDYQrL4TKKWoaBZXNBzUJ0IF03seMO37GepWMNaB2AMdN57Mjwgi\nSQvQICN9j3o22rW3HQ/N5Pt1G9sTNK8Oy1bmnUsi8aDUbDRPLRJ8JABJurTQ\no+aq9AgEOdxucG7sezCDlmi6UuCmYSYJH+R9+nOXiyUdPmp08VrGswwfbQWd\n1A6Y\r\n=H3Rp\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDB7TRqArUjuUG84XY0af4GGwO2Ov1Wwrm/s97F+vkRtAIgCeMNzFPjchgeOEO0M2hRhyj7Q3zObEDOXwRPZudAv4g="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.3.2-rc.31_1620310666956_0.5040805283693375"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.3.2-rc.32":{"name":"ipfs-core-types","version":"0.3.2-rc.32","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"3923133de800ffd5a5550da86b7bca254206104e","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.3.2-rc.32","_nodeVersion":"14.16.1","_npmVersion":"lerna/3.22.1/node@v14.16.1+x64 (linux)","dist":{"integrity":"sha512-X84DjpIBVOvdp6xInOpEbN56FOztagP4n8fKmYMDAc2L3DzhItZBGPWyILE0nAw2MEk5uqKESVN38lFyE0+fOQ==","shasum":"86a331915b348da359d3bb905c7b42e2740d2744","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.3.2-rc.32.tgz","fileCount":29,"unpackedSize":74512,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJglSuJCRA9TVsSAnZWagAAWA8P/i/myQYuDGuKP9l2MF0i\nBCty5of3ux84eTxR4MfxbpmoSbvdnVdaBuCUT9RiC2Zwse+03YW+iq5oOXvg\nMJm5AVJmDzXCvTCVgs53+V2u1lF9HtypQlUE2gM0uPI3hsMnzTasR9h/qNqK\nHXTzD0dYRWBimp/bLJZZg64fh4UIRtOBd7oQblxrwl6Juon7tSCMo6BQANg1\nJ+ZjwB0bb1ukMZWDYxxDsnNKxm/EmV7KRcTvabKVzwbjN+vFqBNcJ/KHe3DI\nZ4JNWm93lPNGrbMV7KOFCAEk41cScQyBq/LtqQM8oPx1p8CNS64T4Kbq9TzD\nTZNigEOmuBOcREQjR+2vr5APC7Siaoo2a9zSxj5sLcyuGx1vq3wllTLsYYjj\n7IppZeSmoGFV7ZCP6rSjUz9/KZMr/qqwOBhbLkZ/mM3wlecy3FqmTexvZ3kJ\nFXdgZUcE+F2hZZlkzw9ok4RMdZ0ZAJ0M4KOXIA6H+pTYbRCfMqTg9XLXdNso\nqtbwa2IuSQScXVNRKcPv9aLKQfamEE8byMZcZn5gMVa/wl8fc9MPMvdhJlly\nPJrQZBk0PKlSmVkFd/IZDqYpwI6zWYND3VTAmcLw68E9pNS0IZmhwUdVKkjG\n64TC7HOKW1KWnKqiX4web3h/75bhjfPEMtuqX9ZvzHAPp6wStC9GYRMkHb6B\nf+bY\r\n=49vh\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD+sDABD4ctvJezKIxI1z/ln9OhZRYqvD9R8cIlZAHA/wIgWG3pTfIQw+/w49zvAkMy7BPjvGmxaDty+R9o3M69oGc="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.3.2-rc.32_1620388745434_0.027815884091494825"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.3.2-rc.33":{"name":"ipfs-core-types","version":"0.3.2-rc.33","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"cf78a1900dca2d466b3694dcf677eabba5ea3b17","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.3.2-rc.33","_nodeVersion":"14.16.1","_npmVersion":"lerna/3.22.1/node@v14.16.1+x64 (linux)","dist":{"integrity":"sha512-Vcz+49SD4SVjbU17ZNGMiqxR7ucemZ73jOld4ZH8t79iTIFR9EzjV8jwJTAEryqtHI/RS1Y3PI/5+27qhhxBRw==","shasum":"d16879072b63c4d14e1379388c5e4098b0eba24f","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.3.2-rc.33.tgz","fileCount":29,"unpackedSize":74512,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJglUMZCRA9TVsSAnZWagAAYC4P/RvDNh3LxpKf31IuySwb\nhUHTXPHsbBCpbmOLrDxTPu5o665pCpaY7SqsQRF+ZeymZRX8JiIp5Bod8UBY\nvZXKDraYiczI5Exd47Rzi1aiR87TLJULKLd0ZW0qgsheVVlR3EfR51m4arC/\n34R3tZJYxcmOAl+Iu4V4iBN7zg3uFDpspWxuwNqYOYrRMS1hDd3mURxX8uKe\niKNzr7aRyzWv9CmgLLWfJwGhRjTADfB0x9aKpR6ibIItLhrrLgYsRQTuNZ6d\nStueVVS58YGJ/Ohym6b0gfVQ9KxEsw6A2bJwqzaEm7LnhHFuEIIgVE4htVNB\nAkJxCN+6j9hG4Iax6929GT0V3lxr7EqqBVlageViWSX2oupIA0teJFSCGMQm\n61M8hDim/e8E3eo/vgth2u/hKExHWXqEV8MDAUZV3Ao6+sREnSdYzNNcHGB2\nQmLT8tf3l/DooYji3LULALwY5JcllStxLeIBuaUJzRmHGcfeR4xXniUmcBqN\nL7HrjBlbrahvd6/XaPTMQLsRq+RIkZmuU88vRBtL9JrKlf9VqphJBDgKauOV\nbyNm5y2vU9U9vhvOS6qQE1dJQNwke0J9FNGX0hXYRxlcViG0/63wieXtKRrw\nAKpm+G8N7/X+t2715L12potMmQwNIR3dWBN0X/iSXEr8ws9oS7korJjnttx8\nMYbF\r\n=Zqqn\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCy66yCsah+1Hi/gsHQXntI6w3vy2LoMedXNE3J1sU6ywIgHQR+gWi42HpEsJWuafs45Bt0LgcoB+KXbAnFlHCUk7U="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.3.2-rc.33_1620394776747_0.8831540360009871"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.3.2-rc.34":{"name":"ipfs-core-types","version":"0.3.2-rc.34","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"fe6024ce70fe83da84bfd938d725f3e6814d0e9d","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.3.2-rc.34","_nodeVersion":"14.16.1","_npmVersion":"lerna/3.22.1/node@v14.16.1+x64 (linux)","dist":{"integrity":"sha512-rDFgEaYLkIQwnAbDAnSP0uT2myxhJ4uTN7pli260wr3r7K6ZnKJzaMuAcZW2fYFBTa2ZJNiN90DoxaoBJf2aLQ==","shasum":"98072742fee142cefee8d3468162d65e88849eae","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.3.2-rc.34.tgz","fileCount":29,"unpackedSize":74579,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgmR+xCRA9TVsSAnZWagAAi04P/2nWJJe60pPZs0UhG2UI\n73aL0fHX3ve8ZYSBY8e4xBozyDe1enPanzpme5sNr0Wh/SUUWsz8Uox0Lpgt\nDUXraSSzWlZk+i2kd9F7iPUfFfkEo6aLPfwINa5D3cDvn5an8BQO7Fu2NAJZ\nFS81e4Fw+t8xEcyIjWdkIxvZdjWM2zjjD/D4+o/ctpM75obaHSI5yJrlSbgh\n0EsiwWpqaUhcl39QWzOnXd9n13ZeJSZgljxJ7nbF1guIdMGhc170lpcEaqrD\nP7GgoDMVyElRCpE6Ze65qVgV2laPaEWo4N1rUrUEDc4awP1gY2UUaKxkpY+M\nUtTqVS3qnE2aEFILAvOxhtj/folSnWV06ddnma/0ycmu5tsbeMge5x9963YI\nqezfuoIFJl8opCWWZ4e2vIYVx65Wu/1DyHPm4gzQOisV2XL1+K3u393RvpF5\ntffPa7GrPp9PI5exZDffl0nTpptNVDm53VwvUmO0BZsZtMeyb4yX86lM5m1Q\n9kBiqdcuZZJM5A2aUoLlU6m7u9qcXVGWB/3aiVjTJYkmMkm54o44LWDKrVPF\nsSUATAIOq3CrT3fAJigRq/gtQ2OsRC7n+pIANp0mza98iB0OIXym6DYeCtEo\nD4jbkxNgp/7pr7A70L7xRfpD+j9CiTpo9SzvfU89pWqqe5xHNm8PZDxytiWK\neh+j\r\n=YsvM\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCLHpjnrBBrBVNxyuJJcUeTTn81RZx58HWfZHTyCQp5OgIhAOnTswC8YPJid4/dELXoAX2e1O5BW3LMvRns7WjZe5uV"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.3.2-rc.34_1620647857079_0.8305618078654216"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.3.2-rc.35":{"name":"ipfs-core-types","version":"0.3.2-rc.35","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"bda04d105587606ab2d7efba04b232bc89b1edc3","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.3.2-rc.35","_nodeVersion":"14.16.1","_npmVersion":"lerna/3.22.1/node@v14.16.1+x64 (linux)","dist":{"integrity":"sha512-9Smcb3C0BNyLZM+SryVKf3G0ccw5bIQeegvzww78p4JBaFBnZpuZO64jQ2AOxeRCZlpSeFXO+IrVcMkydqVbNA==","shasum":"b19eb8b8e1e169682f956563a1b4ff35388d764c","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.3.2-rc.35.tgz","fileCount":29,"unpackedSize":74579,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgmSUuCRA9TVsSAnZWagAAgAAP/RDkIeP9woSakFCKgfyl\n6wEG/jTg20FtqzBNOqGioXv+ef0kfFf1tKPG2Ml/6BxdXatA2nCHGw4MKz9W\n2lTYMS0D3NalkvvMF0L5HA5W5tJ7DHzslyBkw+RErvNGl23UbDkAo3X61NAk\nPiiwx5QFzsMtKJVvZE6DzMyuZnUyoMMXF4ifUHpJbMQSECWe0ftFR3/fU9HP\nKqy8AVhHPFrG3PNImAq4va3mwsZCXq5+gWzCfc/xhPZR5OKbXnq1h02Vh/0k\nIX5q1ab61xj2HJi/7KwSV3VNZs3IFLcbFUaJpPyDcyDRfzyItm2yOvn18vc3\nwZ2uydIpr7MK54hGS4Sq1ikuN7dOY2ROnTtHu2D5H2TYsBZWgO15lRJHUee6\nsGnjg1gr9tUpaFQLgHQqAWvVJeq2V4/XDtW5PIy4duJEgn+6zWKkOpx7zSWX\nXabp6TkS+Kw8aLMBtnkIi3+gz62SxH6t3+TNCvD2mlCFgC1+/RZMrJiv3A8c\nxVOg07qAM6CpUu1CiHGxQzo+V7QbCP/zHN8nIlBSHzC+fqE1kXf9e/kbOMM2\niWeCDtMyNyhO61tO1orthWHtdFSUKMrD3WQmVBbNSJLKjzqdypdp3spOqlLe\nQCQIlAd9Hmr5QSlHXy75Ns8cYiHkEgFnbD51JxWfL2/4Vf8MLb3vZNw1LT0Z\n1Jw1\r\n=Loen\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCDADEuZwHRuf0GYQeMYTaBSroJ77sF6MuUVfQj7iyWeAIgLUzBrYOEoRKnz0/97bVFC+pMCWSheAlj3CL1mkj6ew8="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.3.2-rc.35_1620649261549_0.24840085377779486"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.4.0":{"name":"ipfs-core-types","version":"0.4.0","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"99053f721305d1905f36a16631f036e883cb02d0","_id":"ipfs-core-types@0.4.0","_nodeVersion":"14.16.0","_npmVersion":"lerna/3.22.1/node@v14.16.0+x64 (darwin)","dist":{"integrity":"sha512-K0bodmABbqgybO0oHkFSbQoYoYlX7P4/DMdCcAZzUAPRD/ht7qF8ZcRLCdZhmkxDBeM5jgz4eGF+eLM5xMVNfw==","shasum":"ccda075b22305e096c3e74698baa9b9e7d5f7dce","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.4.0.tgz","fileCount":29,"unpackedSize":76085,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgmUi9CRA9TVsSAnZWagAAWzoP/2kkPGF36HtURDZMoVBA\nTKjTj9rNtK2w646yFKLdxrDzRkUt9960vTAER3CWsUvRmROD7zoVDWfYbLph\ni4vkb+lUFwm7W4LirZzJBey8E94L9OnvSUln7BIGHVNqFMfAzMz+jH/v9gXS\nIFkB5NYZQWQSQwgFZQuPlInA4QM1GuYRrpdxZ8kL17Y+dOgWEFq+d+/YfTgf\nfIH0IZ/Lpgw7QfC8Xs92WMnSYmGDZsAkVFTcQVOOtnyj6bUwajvbLGRLT7rG\nGNSmIRLbpRRg6Lw8eM1eb2WYyYKtBfFxIJnQEJZ4myb2JAadFambQWS1hrGt\nCoDcXsrvyRNtS8iHfA816LjJlj3fh750yNXWq0OCR6exZirIYuv2hwVoSqsG\nxiTb+8o68ssCVrPLeuBUHjJzXQu8DGnjpikcfpwrdAyJ8qEkQZqCU+C2FP7v\nTVqlWfL6lr8v5p3T/f/6U0IG3QswP8QUiuSS135CQsNcTHykz0C0SdgftsQT\nHUtvgz7/Qr9bSHETnz+IpKF4eQjukc3k3g3T1LbiqFNXLozBsed8bA0tDQrW\n2e22fj8fCF9OtTHtTL1RDt2LZqmDedQAQn5C0Kzj0S8WkTBf0x6ztgCFfVnk\nAqEBeE+BR3JYzeCxyxA6OMHjaC62xfDkCIbm7Oz9hIoIBDrKLKj37WtOGjSx\nqXHN\r\n=cZ1+\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIC1Rei0UW+EkLDeAow0+xcmUdxOn6uZPUX4RALp1cyKPAiEA1LjquISRoJXrO5sk4QGYUtGDT/gTcaRdDub5upmgGC8="}]},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.4.0_1620658365148_0.42764795914487763"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.4.1-rc.1":{"name":"ipfs-core-types","version":"0.4.1-rc.1","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"7f6faa76a8b1903242f941837e2c717cd8095d10","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.4.1-rc.1","_nodeVersion":"14.16.1","_npmVersion":"lerna/3.22.1/node@v14.16.1+x64 (linux)","dist":{"integrity":"sha512-EPid2k9jjTWiR817zITw67DijDwKV+P4b6nV3i+la5I8S7/SGy2oPIR1Og8voaKBoLE4G74vJQbQf+teFn+2IA==","shasum":"c8972e92de3d82917c994acaf53f4553d4cb4ae0","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.4.1-rc.1.tgz","fileCount":29,"unpackedSize":76099,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgmh+iCRA9TVsSAnZWagAAXwEQAIQyXXXh2wCfo/WU4Quf\ndt/1s2AKJz7L2TiMNtSTkO8gex7bA0wabc3SIWj+qEF3XsLNdwpIyHLvTbZH\nF3TP7B0qbo+QR/bY4wf6yG2D46n1pvLHvlYzkYtNxrB7YkwQ42QQigyiOHei\nHSL8LXtFIs8dWs3mEzgTMHsAXG0dF+tEVUafwfqOI21esU8mxo2txryb26ol\nQC6264BoixYJ6nPnDVD1c3SQKnDubGcUHLDkpXFsDmpzjvfA3vxXryqcZG5n\ndwOnc9SndVk49LpioiqR2HkzjTRdACO178oUkTEmW6h/CHMplfzUHmN/cq9I\nFOqiev+8LNlf5odv8v4RJLimEhp1aEpDc8gyFaaPgaRJ6+8mo9YMQWz8+W7s\nG7QKsFIYMjlZMdmryhcYRkjeFQ6YPC3B3WyED4pD9AazP3UW+fh2i94QBZRk\nHw74H65M51T7xJXRSRKuyGhW8i98J+Oxvyq/3IvO7BemijuIclcnuAEaZKy+\nrrkTngEHh3pPLVuV++MXMsVBQljJZSOo4NwYiT94y/cCqH/RJXeGVGgjAb+w\njYz4EvuxUWJTB+SIZ6OI1TRMP9iB1aGnsQkgwnc6ZivbBUGC75kU+6vjlf3G\ny23tKqOxNH1HKDyjK9F1GWO4gZF9XdtPIQPwfR/Tf0wJOAVXNQDkI8OEJVcB\ncHBa\r\n=GmM5\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC51OFwN3uN/kZmKPfhrcwBgCgw5grs1vpQ5ox/tqnkXwIhAPh+7fhLkO176fINmU8K76TQpx4ZoSZ9jG2rd4rBK1JV"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.4.1-rc.1_1620713376479_0.9701127547754944"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.4.1-rc.5":{"name":"ipfs-core-types","version":"0.4.1-rc.5","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"18faefe8bd4ee1f671919672917b848436247138","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.4.1-rc.5","_nodeVersion":"14.16.1","_npmVersion":"lerna/3.22.1/node@v14.16.1+x64 (linux)","dist":{"integrity":"sha512-FAWhtU/2GbzakC8C1Nz1jibBHurYgXYLwHpmZMTwrD8Hp/xzqsErSWw6HTZMZQoCwNdAZ4HW1LO1ilO2G9YrZw==","shasum":"a259702e8403ab3e093f8f3e1050559d1446bcb9","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.4.1-rc.5.tgz","fileCount":29,"unpackedSize":76099,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgmuifCRA9TVsSAnZWagAAIEIP/1HEXSVXJWGGjnqjryXT\nOz+drPgfMzzk+4dVpSZbGEsrHiK1BsKNtrnCp8e/qRrE4+vXWrKJCdJh4avW\nQiiuWrST24r4JKOozCPXD2fkZQl9MNJyNmGvWKRtTLJ0UHbHe9sRw4XZgAAj\n9aCYp3rk2mbRC4y7yHYcunbE6WMLzO0SqaxtUK+ocEdWOoA4Hc6CPnGfl3I5\n7eV7yGswFcO3nGOKcjRPRqcHw4R5On97dgpvprdyNbgwyAP/TE1CeHSgdbpC\nAhuR+dVIS5Tj4YAreG8gHoTwV1dK0ACSxTBgfzj+8Mf+1xScxd/Jmn1pTivX\n433HxMYaepR1MS1yfsqRt9vfaX60earwVdG1MR/1Khu6QnmLEXMkS2a5LyUd\n8dLFw0quS3l/c4EWjgNAPFQKcPCsrM18Hzeq7eCmfs2GPUxX3XfDNej5+2Ln\noMqaDBFTMq8479YpbXybxxuYxXr9P13VlDhIC5WFggmE7umSLclZO4OVYKla\nvpx3vhfl8xCVpr11RlzI/amrorMmjNWkEVHwS3tC1D6teBJmd91VJQqTDH1b\nyyPDitK9VQQNTd3nooUaHi6z+oGhSli3Md7bg/fnevSe2vMH3J4bwKDBjtG7\ngkG04sO5FhuGdSFEfzgPQUaBvP2KcVUb+HNommo2DN/s4Pc3tMwLJJ8BnZTM\ncxZh\r\n=HhrB\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDyKS97H9TD77albYsPgGFwFyIhUrs7s97Os7wL5UAS5AiAa4AxC3jsPdc88hRaCi2VpQN1TK59q6l+4I8zGyISw1w=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.4.1-rc.5_1620764831187_0.9521073673502878"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.4.1-rc.6":{"name":"ipfs-core-types","version":"0.4.1-rc.6","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"311ff504a98ca562e738eb3bb60fddbdcb5eebf2","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.4.1-rc.6","_nodeVersion":"14.17.0","_npmVersion":"lerna/3.22.1/node@v14.17.0+x64 (linux)","dist":{"integrity":"sha512-15pF7+I3Dy/JNxW8P1eM1VmHkg67fn+tg/RFN7dPSOnpJi/Ck5fwrecHCbjk+A8oiDTXOOMAVy36XPgHkJZhcg==","shasum":"1729bb5b18102a5ee10b8aec2882b84bd64f6a1c","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.4.1-rc.6.tgz","fileCount":29,"unpackedSize":76167,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgnWq1CRA9TVsSAnZWagAAIt0P/2GvXy1+fAZVMg101hpe\nD2pOBc2acnldRs2uU8Vhq0gLW58RaS0YCUCZOV0DKGhKSeTlIlVFtC/VjTRJ\nWR2VIwel+6h7TlNoOn8iZ+ZNug9iv+O7eKOP09CYnf3GYstu4oOH9P3vcjHo\nbEacEw14BVB5KIP5k2PLu9QJHDKP3xnq2R/K/z4A50EMt3yDoBKkwiWeNZdO\nJ6CP6W5vEoTKVJ4fV+PSEv+4C3qUpyzie2yymDbLggQ8oS3uqYBp8lw80Yu3\ntUaUzZ+MESTku8IDTivhYj8nZqA5lC+WPR1B8E1k2cWZkazy+Catwa2BKjuJ\n2teZGFIztpJ7OCeqkihHKZoczy5fQyerucVIlHMrITUvq6RoNHXzCgv8+cu7\nJU954cf4E5p6tl8r1A7XdsxUa3WOy32dZCXcmfsU+R+s+fYzw69MVQ3l4hs6\nLpJN0jzyUdAaRXfv8xc/BNcZyR6xsSxIW3UKai3DkCYpzlWA/eeqzwL9UWcK\nknyjK43bGDujhqngcFs8f041YnFcI+3fqvdEH3X8ttWDF/J2LnjYCw5wjgXu\nOlTU94Unew2SjItCmNB3yn0vIiQH05+Yr8kD6km1oCgQK3YUV0SDAoKc5YH8\n23ALGWsc/rZ0S1rNmlnG2zr4dAmXKP6dR/MrkQIfmZLjzgI4lbzN+kveIXpj\nUgmU\r\n=VQ8C\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDrjDxEMv6qfuHMQWsNoA1ZJDIQYXBxcgj7BuR6yDz5CgIgZgrttL1TmG/BVuj9qlc7fbeIX6XdLek4wXfWtTcn54o="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.4.1-rc.6_1620929205334_0.053355058462453586"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.4.1-rc.7":{"name":"ipfs-core-types","version":"0.4.1-rc.7","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"1926f9906bcff5bdc8d417a7212a9db52ace7e3a","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.4.1-rc.7","_nodeVersion":"14.17.0","_npmVersion":"lerna/3.22.1/node@v14.17.0+x64 (linux)","dist":{"integrity":"sha512-2tqtdYHqLCO9DYz4Z1Uh4tcs5wmQUzrPJ2+3bK7/SSfP97aWSgtzzQcFUlgC0ll61Z2tuuGhxmvK76RJaLVONA==","shasum":"7a0941154c948558c44d1b313b335a0113dea9b3","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.4.1-rc.7.tgz","fileCount":29,"unpackedSize":76167,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgrQxECRA9TVsSAnZWagAA898P/jboumZkL7MNiUhmdzdY\n/fsO5EfHVHs7lup7wtGxcSqAzjkShjgB+ZEJtxNB3U/kIBgWJcOhFTXRG4sH\nIBiJIA+6or/H/myosrpy8dnvYBZavhz2VdyRtGMnBMy0Kogd21NYFC6O0SNv\nRBfcwmDq/uziB6LOhmAL7rN2BaUm/G4oM+a7/MxzvTZEUmFp6pck+7ry4LQi\ndBmcxasjW0K0xb5XNcDIcbBIJjRABL5l0NSyml8FvOHEXlWrTIXlnbm9Un1+\nSCuI6hwI5DD/cRAjargL4toB4NtBk/IOyj8L0+AhCFETr5UXE+9V3L2yEMTQ\nZw41zcQ0Zjk1b9VKhrCvzMOEBtdNLQpCZkIX/CqHALaGwV3tFrpwyRwHkgHA\n82TG/HDz0i5x0pUdmOqVP1risepZ96SCqOxxhDiKqns1wcMBr/PN3gQ1b912\nueWD63DykA981hzsgjYprvKXXWf2S77pm4To21rjg75JaZ3vRYcA7xfAxcW2\nfpmVzlZO78F+R1YB3/wjiPeQR5dp6TzRekgmKE6MfmePb7HwgD20e07pyRc7\niHHquMmsy/7x30YjeSYMfCXJaZYoxwvtF4NNhFmQwktRzHsHmd/kwWL+u8mS\nXagHOvjN0L/7JoX0ULSxaA2r9PXHiLu4HqgKSl93DPSKrOlL2g8pFdxMUN9p\nz8t2\r\n=uaZU\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDSCbRui0C9LKASpw6K1HQDUcwNvrRWRhDn9DCLGq/CZQIhAMAh0ISTKsLU29bRrZ/uxt9uYTD21PMvQyf772+W/lWE"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.4.1-rc.7_1621953603435_0.07121941780444985"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.4.1-rc.11":{"name":"ipfs-core-types","version":"0.4.1-rc.11","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"e91a1e52b86fcc9ce5ca5881e8721863b58d5d9b","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.4.1-rc.11","_nodeVersion":"14.17.0","_npmVersion":"lerna/3.22.1/node@v14.17.0+x64 (linux)","dist":{"integrity":"sha512-kUNkB5rptURJ1546cG2iVVhOycZ2MGugeEBNk4xy98m221aXaCL0uHYiCjv793VBUOJQbrTubJCGS2iLfUkJ5g==","shasum":"28b9fc74202457d21ee1dc93850790fc0fca4eac","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.4.1-rc.11.tgz","fileCount":29,"unpackedSize":76168,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgrSB7CRA9TVsSAnZWagAABd8QAJ5K/CFzRRbOFK+sEn8x\nNnPaysURAqG/CGeXEcbcR7UBfWMnrffV3Hmf6TVZePa+TeUyBBVE2bRQXH4s\nGsMutOdbMdxcuvGppwkhaOcEAZRALiGMZ40oNG7fbN6SQowyWyAdrWF3NIqG\nfXHAE8pABkLS+7HKb1yCW8qq6xiyeAuk1uBl8yS4GxhJwAp2Wne+FanEhLHl\naj6qe//x6w0XA8qjSezn6nQsuTl4tEehmCkKCuhf2BB4IMPb+EabyUocYdqU\nvBN5u+iq4mMBA+zjbeZGNGpZebbmzf38bxqzn9HMGfVkj0JtSXV3QDoLERi5\n25lmJlGbSndrt6uj6wqYRHGH6jlDYZ68gniXfN/yQJ0Nf71/vR7xFisgawZX\n2FnVfY824zCF+0r0z+K2KGqrWlWhfSdaOVrPR5+Tahl8hCq5T37Ds1zo6bR4\nA/sqyO/wP5jqSAD8ED2xp6nKLcNXtii+00URKX+M49LJp0Q5DC0m4Or2CoL7\niuO+46x8IL9pgOljMVwLwEVZux9zhQs6mwv8NGbSiR1qEYMm6Nd89gbEFVKv\nYxctaJXJt/A0z7iYYMKWvyzmbWOVX0Puezl0X++Ujm+Us/db/yqyROWNFast\nhr1oD4gZj884mYFTposyBmu/Ex6p6dlgTGp98lPNQ5OM0OWqCkGSB+2IANu8\nfx29\r\n=8EJ+\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHLDutOfb1Msg8WTLFdVSFjWoA1HPgQIR9pcErLKuJlHAiEAiTOOB9a9DzKPJJkKDdAuNUVxxKQfOSWWR82amzjuoPQ="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.4.1-rc.11_1621958778570_0.7724450248468051"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.5.0":{"name":"ipfs-core-types","version":"0.5.0","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"c40960358550b920d3291b8030715537a63c63e4","_id":"ipfs-core-types@0.5.0","_nodeVersion":"15.11.0","_npmVersion":"lerna/3.22.1/node@v15.11.0+x64 (darwin)","dist":{"integrity":"sha512-Upd++4T3beEijnegundRgjSaKsyjqzyf9gmKZHy47rRetObC6trJZALvp5VBpiR0cQXoFEegcXpVOuC/om/4pw==","shasum":"c5775f249e586a7c2e029b5ed2d73bcc548abb2d","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.5.0.tgz","fileCount":29,"unpackedSize":76484,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgrhW/CRA9TVsSAnZWagAAl9YP/RN7cQ880erlVf9IAVof\ng2LW/Jc8SxwLLtqc2+bn0XetEf4NRwcn3HelVGTsRTwSiDJ/mSjsL3gmT4rk\nKg5mED9fyG6d74Z7Tv/+ktCUUzaC/bCRXvglIM6Gj5aMZvy8ykkpIDJ8g9SS\nNqNY68jZrqMRbvF9FObbr3b/SWAFt+Pn0QU8RtfvV/VDXIxfecYDZDWCRahq\nm3EhxBV98AMQExxIlH6gvCdg7eaQ0HzWDJL630449/jfYHwDkm0MiztmOikJ\nN3vdojrUiQ/XOlQMik6Cp8/OdleNItOwnh1vS5gPERcDrx5+aFgz2/Tm8FCx\n+CIGc8gIS5jUUHsTsn7OnLTn+5FEFi6QvTwf8TlAmbCt/1czfLBogijsNHpQ\nmCiZd7GfhgYkOgqf8z40a5mW8J/uDFB4pdkmyCJqgEXu+vwFRAJAA3iPBXI2\n/l01nkOJiqX8vHXp3aEP1R7iZRQjArrEtRz+HEkbNgAnEyht25O5xyLe6Och\nbKhiMU/Uv1j10tbMVkuRiFhc+1JFNaDQvQil2Uq/Hr9fMLWt3K0OvZbhOyuv\nlW5M08YFg6VYCIZqckVAYcE2voXIr3iY8HuZ4gPq8xCubBWP2HY+tADsR+aT\nqjrSAPawoS2TXSBblyqZxvOZGWNkRGMJ4T8mNuRxiWEx4514Y55mdGqLQLMJ\nOSKD\r\n=xM94\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDFCqn4Rd5BrZXMnf/jsep/NLxL8DwALBG2V7rgGTXXfQIgLUSRD6PQVdSjU/i9EG9FiM0ayovUIxW4kOCkZTAfES4="}]},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.5.0_1622021567381_0.4905697930422279"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.5.1-rc.1":{"name":"ipfs-core-types","version":"0.5.1-rc.1","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"48c4a9520e4ed668f4eca2fccd67f9849e967286","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.5.1-rc.1","_nodeVersion":"14.17.0","_npmVersion":"lerna/3.22.1/node@v14.17.0+x64 (linux)","dist":{"integrity":"sha512-IEgUe1Ni/gQDJ1NmnFVOf83e9pHQW/JE/o/6X5WxGIHqmvZ2VeH9wlgsLtzXo6us5VjaK3LS97svOpoPpenEog==","shasum":"477ebdacc2e62ded455ea060118a2a7991964744","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.5.1-rc.1.tgz","fileCount":29,"unpackedSize":76498,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgrj4YCRA9TVsSAnZWagAAZAkQAIjXaEteIW/tPIJsUqXi\npOm1ScDyPsFS4Rl8RijaqcST/jmcNzCzFZ/c160neVzV5YpuXGoJq/Xogqfn\n7NEt3N3c8+OhI+4+z3e3aXkeWCKq2da4PizV5J1ITvNqoSohiXWwgu+up14t\nMg5feFDiLNlVuV0bxY9k5/g2xaN087rmvlNDEWAFouJYkxkw6KYeWvMEwAmo\n2C2T9xWu2mkiyvvG01iKmvekEDQHBBwCLFcOlnp2+I50jBfpltGhUIHJDSqX\nRvZPtxed0E5UK+Rr9MVmIcHvbQUsADqX6wUbwfCPCIPo5+1CFZ13vr0QaNz4\nwmH7G3FhC8MUaC6kkzT1VFRPIUcsaRFr2cvJ/5ed5Qt646L/UPSUfZT8eZRx\nio0uWwUs4D4Zw4pk7/ObUwhhHc4hSsV9H108R9vl0bFEvlC6dsF0kF9RlXJ8\nRBRFyqGkbZFXlDdETFku/VtfpRHEEPwTqJNcKwQIV9iSsohEWJwezHFGTuZo\nnh7M8+s5wEKEU0IhVgCyKJrVdYR1LnIeBiQM8jMC1NwIDx2sCq2zG+3T2p8Y\nu9dTvodTvXOucBdtL0ZBXBjF8yJKMxvYg/BknNBALiz5HUN7hh56o+SC1p5H\nYasoiDcAvesKtfSGH2LIWEkkq5d4lWj4eC46kO58hABnndAIcaPyHmLMMaIa\nqbx9\r\n=RjJc\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDIgPf4Sv8/gbAMzm2WEWTy0r7ICUK/zL6zwPEdamffVwIgO0L+ES4bayc1DXhU/l3HnDZRT2VduUbjRXYuFTf0oJ0="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.5.1-rc.1_1622031895840_0.355006147307521"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.5.1-rc.3":{"name":"ipfs-core-types","version":"0.5.1-rc.3","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"ff56373f0606ef2c59a61916f02e42ff524f16ac","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.5.1-rc.3","_nodeVersion":"14.17.0","_npmVersion":"lerna/3.22.1/node@v14.17.0+x64 (linux)","dist":{"integrity":"sha512-x1jjLODD099t9Tc5G9C3gHiwOgTCTnzvGTM0xnWZ5qOtzPqBg9Y6JRsxuqdJr34E17mRxT+zGUc+8NfaEyPnUQ==","shasum":"5cc1ddb359a69ed4dc28fb8955119b606a2dbdad","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.5.1-rc.3.tgz","fileCount":29,"unpackedSize":76498,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgtprwCRA9TVsSAnZWagAAPs0P/0pyamExvOdpXQVa/rza\nsW11WucbG0QbmtFQTmouZtVWGxMoPwtNuRieL2CIHCaeYHAPIiZs2zbIl6n/\nFVoX7ge5tCFmtA+QcjVQkmWCmeBYUktNcNOpfOnH+kpTsKxOfgyJuuaE+Qjo\ngi4QTrhUYKLhEkfXqWefKkjx/s2hk+o5l0iE4qyJeSI6argEBOXZfg/Rs2SL\n/h89NEQfcZVkbOkZdNmx+Hfam9KukJwxGeUcCej6La/YInLbcbnyLsz5E8+8\nEyGfqr8h1MHJF8xNGt3LWDmvH4jr/83ZwXeKN/jfonEoK7rHZ4pn+HW4xcNz\nsqsmZvgxJ2c33R2SuVYHGiqv1+TXxtsVTXzirj/uMC9EbaptT7GqN0BTR88n\nmseX4QFXn1RVyWypqfoPIA9PVISS6xJVcZdG9qRUnMoUMyar+/rzSG6Wthyg\nITLNFniS0jIi7VjGMHfrnLJ+VFCwKnm8QQHYHly6zpjj0fibCkVGiTENISbN\nmDV8u/sCfl+mCoiCErSt+ApS8IKz9ljW7pQS6Ouxzah3JLZ3yRDcarhtT178\n6f3XgssMmRK/9eSR0fZ9ACpX+YhfAVixzxPFafhay6cdUHJDmJrG+wd10FWy\n+2bIoUTHlmQ1/PTq+gj+pPYR1X74iuV/Eg+WNBcT8iDhfpf8IcJ0hlimpeco\nakur\r\n=Pd1b\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD0Vgvyj5y/8glCRCxxJnaEnRTgyyPRiWH41H4+ZonmiAIhAN2nPPhatsDxv+VJ8OgDLXFvxpsZebSLCLUa0UnK063h"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.5.1-rc.3_1622579952024_0.3062531125022605"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.5.1-rc.4":{"name":"ipfs-core-types","version":"0.5.1-rc.4","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"c4a1aea5addf902506e34d3d9821285ff0423710","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.5.1-rc.4","_nodeVersion":"14.17.0","_npmVersion":"lerna/3.22.1/node@v14.17.0+x64 (linux)","dist":{"integrity":"sha512-o8I/yCEVAPfQQSmAknlHXuGyQ1sQ80o4h4xEa+nfn5tMJtljfUYWs2iSX+Idz09mC5OL+j0TdvuZSdWjUt68Mw==","shasum":"dd10cee0a4cd52da687b1b7a0cb63bbbf3ab23a2","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.5.1-rc.4.tgz","fileCount":29,"unpackedSize":76739,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJguxbsCRA9TVsSAnZWagAAZ3gP/RyTt8WijB3mP7cKfSWX\nQoejmaSNRM5m4tgsX0ZclFZWxzfsjJ7/Ao9oG9j7Jt0ec94YlTdXya7EA7BI\nWEswYTKWFms6s8mg7P5CESQgYI1qLK7EunjfVjPEl9aEe0SYTRFUSCH5r+L5\nDbDfrd/AiE+uzXmDSgxYHX4BvOLcKnDkfHzPQaQHIYr8TjtX5NZcvPxjcMe3\noQtdWdxBQPCXJ7AlxG5WxwchKrRNyHHXzyfrq329KV4YSDMq0y3VEXrqygvO\n2npjZUKlPWWGw6MfUOZfoFRzXkGstYoPAaQXu1p9h3O7xfNuKajkXSc7rdaP\nTOgWm1Ru2RX4aN839DIFBPQQ66M6XQEYrsLKYKOwdaBO5O1ZjZpaHRBVG4jb\nACGdv1mUF+yVog3rf+KJz8XyGv0u9ygVo0RD/dxAilvek1bSkCVhKC0Kspfe\nZbdPgUXA443T5hnhpo3YpnGy/NgXVwvTvpLjUo7DXGIZ7QfN0xXM2l/+3/xl\nPGkvGVcmzZaEF1aun/g0j8+w/0qutb3rtQskHkL8E3gRkXrKN5Mp7zxYAHI+\npSYFOzcyLUFPj/Oxd6KLsPoTg3Oxd4WMvm4E/ngotEJjlce8N58Y2Yx6dEFn\n9Jq5S6VDTCWNeWeDmOrlC9ZdiJRP969GhDLt8xxjv3rqbJk6tThnFhVxIcjd\nVvkv\r\n=qR9Z\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIH4cRIQ822kGJGd1PQ2jBb14mHf33129mztHisWBcODwAiEAtjEIpmw18DCAh5YxZQlwZ6UOrNkT54uDPmAjfzUQh/k="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.5.1-rc.4_1622873836714_0.4827044909656515"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.5.1":{"name":"ipfs-core-types","version":"0.5.1","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"08be8beb2168f39252affc8e840ff3e185c69a44","_id":"ipfs-core-types@0.5.1","_nodeVersion":"14.16.0","_npmVersion":"lerna/3.22.1/node@v14.16.0+x64 (darwin)","dist":{"integrity":"sha512-HE5iE4j9Qa6c/4mfaD1cYYx8mbRRkrrcWekDG1JAP7mEK2wPnMvMemmFTgFF4KN6bW9gIusJjqPpCweesORPuA==","shasum":"e6fa489aed9cd2aa989de672f04179f2496ff92f","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.5.1.tgz","fileCount":29,"unpackedSize":77107,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJguxqKCRA9TVsSAnZWagAAO9QP/jUVhZVs8vum2+u7L+CC\nesBvV8+Zk1H8c1t47wY2MZT5+Gw087ePbrwgM4y/ioDIaibOj2aoEq3VKiXS\nNZimbbEDNgFCMZcCSflzJBExnFcd8tKeFU6r5WEMR22i4u889IxxAkNYFk5+\ngyHQeQ4FV4wXAMWwEUYC/Tv7DZFvXQth8rn8oc93wIrFFLmMt7qaU/LY/9ae\nl4ADn0ZeicVQLw0LaeR4KWS8OjeaqHO8JOPJNAmaBRsMVTJeURqnHdeKu4WW\nJy0kBIhpC+vEgeDUFP5OST0HgnXf/K6VUrldgLfr4OadB0BdgucYVYaLynZZ\nlSGzt8zMFwkyftGoVS3J1cqw5tchnlY0uZU5AzzpbXPgnhcZApCoWfmlFic2\nfMKUZ28Qz0IeBkPp0eJKKd7lvBD1qQkN4IbTQ6NnwxtwZ6Vk9Zrzu9NU4kEM\n38KDO0GMdw8V5KAcPZlgfGJ4b4OlgYxOCS0i2Y/iHQTFKOwa6lnE006/09H8\nwY3hBdV+28/kOgX5F7res8nHGTuIRjWq3o3qbt/kajhoojmrsx1gBBC/DEJ2\n+GrhKsUQEIzbatW9J9qVnHzhl1oMriNMR02udWkczbD97OpGd6dwBBb+sST0\nOiOywcBu98WAFd0TdS95JJIISmJIq9yvZb+FQe4H+AaSzVOYI5BoUiGm0Gmp\nT5Wr\r\n=qnM+\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD8idVprAwSmT+AgvH7tpuZiOsK9LrAaEKrvpq+wtVsRgIgQOWdYZ9PiUCJYeVUZkb78m8IetpJwmQck6fVGGY09XM="}]},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.5.1_1622874761901_0.9812590153920067"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.5.2-rc.1":{"name":"ipfs-core-types","version":"0.5.2-rc.1","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"714c3de17f4833b8dcb7c0ff51536661a22cd6e9","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.5.2-rc.1","_nodeVersion":"14.17.0","_npmVersion":"lerna/3.22.1/node@v14.17.0+x64 (linux)","dist":{"integrity":"sha512-s8TpZKc/fGFatUe++Lujo8rx1v/1/EEC8noP4B9jWUJFKN3JEDfmhDrpB6YvhPha2WllV03dlYwYhsEL8MM0Fw==","shasum":"d55c73b054e0af1be045e66e932ac5333395285c","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.5.2-rc.1.tgz","fileCount":29,"unpackedSize":77121,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgwdrMCRA9TVsSAnZWagAAWGYQAIeYAqFS28BMm8tYVFmh\nt8ISgyPi+MUd3qWBLEditTzbBR1kK42xFiM3M2ez/gD7c7ycXTAVX+O9hkGM\niWtquwQRnsx3qXQfEkFdOg9zzMRUSGwd21i1wT0c8ahBuxox/Yt7yShMCX2v\nHusxVAkBCbmwPHW2DVcmjTM0uYGvI83KKg8/lMV2umKyUN+PzxKL3rxi4VWI\ngjPxuQCkzAwJ1z0/u25OoXtSLSzIyIzjefrfVrGcy+XnvrURyvW3SGry/NH7\nnOsiWTb9CCzQPBiVKynTztI4KEmppcUeBYGKDKupw7b8CX+c3wN78ydoQWq+\nv28AsG8BmfJCkoyMPFUUgqoeu/3+XsWns9hAnIha5NXWqL/YiiN0l1mUCK/W\nRJH3kDIb+uM9/qS3YcT4hRQLZdZWEKTt6fN/5gldXY+8XwA3E+6luSMTcgw4\nEKWLU7zrJ/MpNotL9ClWEG2HXpqeGmq/SdHX5YETRt0zLZ4OnSr8j7fRc8gj\ne8QDUj4pfu7FAs8RvbR4YaL4BU16SGHR4gZPm23+08URZfH0XFHuxZPX0bZa\nTX0fg0kiBkC0lUhRqdlHIs13cBH8nOwsP2unnxtcbaUfJiEwTFc2rEHr1tTM\nLNq2pFC6D6gPOf3vJYA2i6g2wgIqqm/nQAqQx3y+CAUwv9c9HvqB7jPAZNsJ\nPJaR\r\n=g1V7\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGBx0rhrZlZkqQ4AWh4oPZ44dJxA1aQyEOv9r/7LDIKOAiEAprqzNhZ+cd3x5BNA8CWCWYOK+LgitjXztVUKaoQBedM="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.5.2-rc.1_1623317196741_0.7887798384527007"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.5.2-rc.2":{"name":"ipfs-core-types","version":"0.5.2-rc.2","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"bf44a0371a53325a8ed10c93ffd3514b995185d4","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.5.2-rc.2","_nodeVersion":"14.17.1","_npmVersion":"lerna/3.22.1/node@v14.17.1+x64 (linux)","dist":{"integrity":"sha512-n7Jle4y2kcMEV3AZHFfT0uIm4AIvXpfuFbUZxy476IHb63B5cBZjXihQjAsw1DigAk0c8RnhYmyV89SG8NIm3Q==","shasum":"ca8efec8c1f8e0753840973fdd166c92fc178534","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.5.2-rc.2.tgz","fileCount":29,"unpackedSize":77121,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgyNn8CRA9TVsSAnZWagAAbxsP/1u7/JMljN8P1RT/bFBj\n2alst/4Q973DmbEHGLdjGtA0J6/MhKZifHgzeT8yYC/cDYFDwnSotpDqlgZf\nn+0wfR4JSbw5vNTwd4G/Yp0a05yfSewcp6SaFTnnqxCIbNyXXBEI+c9NTgJ/\nvvgDBj4rzbXxxSBTJumz8CC96dLbXGxYrTiSw70Ak31GKQmoR/TWZmHDr4TE\ng3JGsglvAdr1/SbRXrNSwQ6+gqAkWXlkF14xvWGODRX5nKC5fd/iSy6fcCsm\nagLQFZuhZnN6pkUNuq0gG2xZAj4dOL7iAvz1PnLeCdHysE9dq/dcIFjeXVMi\nQsazuZbbs5RD56iLNsfUuPevmbQGqnHG0lphGAJNFeFS89ixMn4lNTrAV5tj\nGubjwUt1EL7KXPExcyKXGnkjpqkBs8UTm8p02UUjupvHhFRCT1hE+c1tU5rK\nitn/MX6XV3TrO+eNF0ZrDQRgBGTxVdDvHLs48Ah7byOa1jEEivMU9QU2O6Mp\nIlUezcHrbNlwp4J1Hj16Lw+VjlYemJsJ6p3+b2LreJkAStyg1yBssXxTfWES\n8lue4Y9ZppfrplquEUl6t8ND5dLAZ0HfTA1XjKJJe/y69zuBoh3Oy8VKj6pc\n3EyXJDx+7TPP6GPfHJ08MFEez8Aco8OQQYg31whfa72N6qYVm/bOULMtSLBr\ncQt+\r\n=rQCW\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIASIt58y/iilmg1uEF61ETxugRHHhQYXFJ0CHPgGkJ6/AiAE8ZJsjd5GiHyK1u9cIrTEMG/IIk0XeP5nkdvZ3FP38Q=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.5.2-rc.2_1623775740776_0.7938775630750046"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.5.2-rc.3":{"name":"ipfs-core-types","version":"0.5.2-rc.3","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"b1bbf5f004fde7a26f8cbf6e0bd7356f07dddc94","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.5.2-rc.3","_nodeVersion":"14.17.1","_npmVersion":"lerna/3.22.1/node@v14.17.1+x64 (linux)","dist":{"integrity":"sha512-xSbc/Jf5ZcEhmqCD2i2OdzdEYNPrv2ljd8A+rJMF2RBX3uXQCcf7muPuo5IVoc40+EQ/c5JdNt/iuywa5JCVTQ==","shasum":"b48f2019636593c9f336ee569007b935487208a3","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.5.2-rc.3.tgz","fileCount":29,"unpackedSize":77121,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgzFUpCRA9TVsSAnZWagAA+1AP/3VrUZytP5rPjtkMcQc2\n/8xHHaxL4LcRjGhS/ra4HDXgv9XpVzV1Tc7yEDYgwiJ1o+dGxDEVskw2JV6r\nbrQv7J5gCCrecg4ywb72jfboqyt+yOLWb+uIC9thsJUKuIbFDuYDYIeBysJK\nfoLOyRoLcL+lOaTa2A7qfVF5tJB4Ca2uv2fPa3W9tdXeNxfhKYgCGqKGdsr8\n/zr03PX2gQlUvr2PKrmp4rTS3nWpipNxdwmRWRxI/c80CC8K3Rj8CO7xVSpZ\nPiz5KXekZF98zt3t0aQrPvNoQC2tfa/KPkh/EjxZRkLtNNDpzmljTVGb4GvG\nLxi7leGdr9+p/K4DFpc4CvYdsVXH+SyYO4wOqlkI8CeLZ76Ssq8WiNXTD5JM\nszvZPfGZqEdCP3PADdQ8vZNoGG3jeCkbS7XLMU/EWCEEjO2DTtNe6ZmjhEw3\nBaZAKMc2oc0iNe2tKcLiF544o8mlHgSlx1WuVDe0WRmH0/EVLddRQFQ0fqmd\nTPFj1al3cShGLLYqIf8rx+zMi16K2QxWXuElPQQLQQ+LOFPiIKFAcxoNBn/g\np3nAYm0jiEs6JxqXgbyZJpCqB4eR85ZRlq7WB9wzksamszVQV4g/AI+NTn6G\nvehR8bBsYuvdhnbfYCCCZsdSILX2fDEzeUJkog127wJ0SLf6dcCIMQN8dNH1\n3QPy\r\n=27DI\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAjwzE7I5PPs+WKwKNMI/KZ7h+O99KtQ8NZUHnHw1XLjAiBA9YAnZ4Lp66uEEKLDFp2v7woD77wTwXr1of+pN2Np5A=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.5.2-rc.3_1624003880505_0.545918116388036"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.5.2-rc.4":{"name":"ipfs-core-types","version":"0.5.2-rc.4","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"7c1afbdfafcfb81f698cea35cfa0e392711d40a8","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.5.2-rc.4","_nodeVersion":"14.17.1","_npmVersion":"lerna/3.22.1/node@v14.17.1+x64 (linux)","dist":{"integrity":"sha512-g53CYWl8YMUhUqBQICJnGiN4d6GK4YXZTZNKDd9Bfb9ypJykkHguoF0ybiQDUZCj24VozZC6evIUj5+toYEXNQ==","shasum":"347cb8041487f8ffc753b2073debc2d2100c9200","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.5.2-rc.4.tgz","fileCount":29,"unpackedSize":77150,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgzGV7CRA9TVsSAnZWagAANkYP/2CKHNbpqErMhl9JbyGC\nGZ5Y6+2VZoUdlW8pxp2UR6yJRScb3l8ahDhIJcK87lbfPhp5lfoBmWlvl3MB\n7voFKk3/F7RZTLbafHUPwKXjmwSUBMWHExW+dfUWv+qGffMGat1XA/SgkEtp\nDTz67bOzWxsRB2De0s4IN+aq/TY7HpG6jmqK8F43YkdlSQOyWsF7zo/tZkHq\nxKZasHPaCgoYx2bgbWfSwZB6iXhpRnf6N4OIgJSqw6g9OA8VP//fcoymrpPz\nreO6SM6MtpxGJJAIWxk57+Bg6u/veQUed4uonIpy6BbOhyAUu0hq5tzphqL6\n7NMW4ezLr/7LnpxwOBbnuF3kcU+PQ7t1rFy6iD/h8v3n+vqHQymm8AO+yTqx\nXZ+LxPMG7nE+hfzYG4r7pxVWYd2ps7i0Jt1G1+AeMaRAPWORt55H+FaZ1AwQ\neCd6AfOsN3aUEZF36D6+XUzf/NRk8GkI1Q86rNJy9uuXPKc2Q+2Aruogve+q\nxo+oQq30zQ5bKwZd0V15nabS1uN+lMcnxsP/tB/L9JxCEnwizSuf/v10EGDA\ngTkUScnuS9QRfSeUQKNftnHQL5PQwwpM6pTenK+PUk5X2E17DaLbc3FmqL6I\nr6KMdr66a2j5agWBaXl9PEyQaL77JkOG2KdtwMdNb9TMEOt4hMfxWOMtv/y2\n5tNz\r\n=7rKO\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCHddhmAnKzRRLAb6YK7MTpY0t27GIuSoZ0YcM5hWZATQIhAKLHf38rK1evShQ7Bfvp4Volh2uJqJf1zf2zsmaVGHP0"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.5.2-rc.4_1624008058680_0.29352673334098567"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.5.2":{"name":"ipfs-core-types","version":"0.5.2","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"81f944163f5a78ef15fdc23b2c488ba7f44af0be","_id":"ipfs-core-types@0.5.2","_nodeVersion":"14.16.0","_npmVersion":"lerna/3.22.1/node@v14.16.0+x64 (darwin)","dist":{"integrity":"sha512-DOQeL+GFGYMTlnbdtMeBzvfVnyAalSgCfPr8XUCI+FVBZZWwzkt5jZZzGDmF87HVRrMR3FuVyBKZj772mcXKyQ==","shasum":"e1e026f32c9799e9fa5d6a2556d49558bd5b16d6","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.5.2.tgz","fileCount":29,"unpackedSize":77309,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgzIBjCRA9TVsSAnZWagAAyasP/Aw+rXnKWiMwhG/IjSpe\nkJM4DAo9S6ys5PiuQ6+snPvecUYKbV/GVZ1Ff4bgcJtKbuBme7tu3+HzaNPu\nCfiIiS/VKYfYqAbmqeqRjjo8QR60axAl69+7A7LK6VZu47O5rm3CuUeeNEA1\nZdCrXqpgwqQmi56QfM40EcBjN6s4Z/CnKDi7kHlG+BZFA7jig8hMdsfC68v0\nmQQELzP4FIDk7StelCdR6YdUdiNI8mQZ+tBU/Cakdn/KDUh7IEK4fcAzttRB\nhWTWcpBSBVhoaaP/pD98KlIe4HvxJt+2iF3ynByZNMWzR6iLm4SLgXtWlXl6\nnvfZqcT6Hi9ys1yxkk8rlhGsRlpv74BCzuWFvi7msxxV33KlVKTyUPrqai+d\nQzfreg1Ugogr8x0d4Q20yE+FqkwEiIloWeYEHE0xcSFY30GGyXbVF8BB+VVk\nEAX0DBJSDt0I9Wh/RzTBHcgXfH8p0VUfO816vzoHbyLY84VHxAJ3IHRL9J3a\nc+d/GQe8s6e+8yFsgkFlg9DJcKhCitysx41Njyeep2PaxHOvcSRnMx6bCWtY\nRdASdOBXC16LJ6vbIL/5RQ/QDDjgTBSI1QIntQikwpVuM2wDZaIeBqKHGUd3\nzgp/OCmrsuLOxIa5t8fdlCoh0qABCU1MYMOK6sUHkuYnMTokbzRNx9kGEMUL\npBrp\r\n=5KEw\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIErRwiJPAsqxlGynNpoY7CmQ9+gCQ1bj9E3AICJ6bu+vAiEA7yCJetpkojKYoJ2hsoMXWdc5/+2TJeb7KJvpTwbZjLg="}]},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.5.2_1624014947348_0.5160522286526332"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.5.3-rc.1":{"name":"ipfs-core-types","version":"0.5.3-rc.1","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"f4b2a8c204271922ea34ef8c060592eb56a2a1bd","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.5.3-rc.1","_nodeVersion":"14.17.1","_npmVersion":"lerna/3.22.1/node@v14.17.1+x64 (linux)","dist":{"integrity":"sha512-htk2GlfcIc8XEpwqFIz7BIVVM4+4WVovRSTRaO6aXDuwdP8yMVHXexckLVqvu/oiw5S50AugZ9nM6hSBRDRHBQ==","shasum":"921c485d447e389f0c96be97107d7ea60532f08e","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.5.3-rc.1.tgz","fileCount":29,"unpackedSize":77323,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgzMKHCRA9TVsSAnZWagAAFiMQAKDef1uD7XtLkIypdZ3Y\n2H6QurtqaRXfm1gzvndVqOTA0TYMT7UaRitbIOX7nK1gX6n9eUk/IecDe1la\nk58+VbuueeI1S0e1gIXQHkvLJmbnLqhIKv6mLataG1bcb8lcguD+yAQNeQmz\nqMHld6D4U+7q1cnMkL2q3CLWrkdkoWV7YQgwv27pw/wDASABvDUi/wgsaalG\ntfIW9yBzlxZ7tj2X28VWNSiFX6eU/6NfVAfGHTigX7VmElBQWf5fv1EhWTD0\ni6C/5zORVeq+WH38yyWA1CqmB903E+JVDSmdWFj9zYVujHloRCrKphFn1iHC\nnF84myRycu4wPYsLm99ZfEKJMd7LGuQPoOrk3+NILbspAw37u6aa1v6u0plr\nQsgtxcXFxSbv48nTVN5Bjw77/KJhKKqr4qWPPzBEZAhIsormpq4zPLcX41aM\nmCg+gOYv8+rsZPxy0JAxw3EZEy9P+h+SCnQgBoQMX13PJtxSujhUU6DI/b6j\niBDpg11cSpX4Rx9orRQ3OB8aZf9M7+NUyoVwc02sHbHuyHajsA7QeSCRkDXl\npOlvfjHU6fQ4HGbG9klqVJekKTBNtKay7rgl809WRU9MU7QHq4dmSrbdHI6q\nxMjzpyeUkBHs2sLfXJKu+XEngQyRml7VElten8eYwE4Eg22/nHJCEvevZfy+\nJ90W\r\n=5WCa\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDzZ4TAWwk57F4CmFCarLiHct27UvbC3dxsYC4nTO5fGwIgZULnayyzgBqn3d1pMLYVau2Q7v16W0AqLcqZApvaFm4="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.5.3-rc.1_1624031878911_0.6244431576896052"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.5.3-rc.2":{"name":"ipfs-core-types","version":"0.5.3-rc.2","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"4a4a360fbd368b8b27653a81c9301820c93d91bb","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.5.3-rc.2","_nodeVersion":"14.17.1","_npmVersion":"lerna/3.22.1/node@v14.17.1+x64 (linux)","dist":{"integrity":"sha512-W6n+jp34bFCV8HHfh1jR0xyp5b0PRZ4Ci1pKA7STYAbr5FxUgOXU8ongPl5WUT5YhQeKYcgy7bJr7lRbJozB8A==","shasum":"7d69387d27c6fd552387f76a5b55dc143149f6b9","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.5.3-rc.2.tgz","fileCount":29,"unpackedSize":77323,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJg1fKsCRA9TVsSAnZWagAASHYP/14vCEYgU1bQ1aR5zdKP\nC/xSgNPn9pRpycnHvZXdvzPG+okclm34WFykRJFSclNdUfx492U3cB00tPSH\nvErCJ2RCJszB7r2DPTuBxmQ67MZhbI2/AOwRA1uQcj0fxQiz2xZLXufzboWO\nRt6FYOP1wRMnvSi7jzGtRSyirmMECLMDHP3ET/68q5aP2jNX7p4GqzXn87JB\nE/Oq5542WV5CTxkvf/XLk4xUEy866CTh8CqWfIauSTlzlXzys4Ft1+mSt/Ly\n0HY/oRUlmsszwQvaUxxxEsCpcV41tB9GwxlKkkFdRgtk4dc6xGqks88URfxd\nYDIPi+uCGsSXpD5yADSGFlxcwkKiN6LS48zl8L6R7N5RV7iStWc96YCnP85V\nC/yCI51lLNFvPQ51ib4q/qMz16ctaa6NZqzSAmadseBWM7/OH1DR19JKELN5\nKwksSYoxW23Y1GvfbYEGOvpUnUm6Ra7TiS0IFtmeEAOfS27XfS3H3qmeGs8z\n+BkPh4R0fFC+WhT5IIyXo32wnwvJCSJlb+iShr/CRhaVT56X9XegoKbYmL9L\nw9VXLSSXwsX32+di5p/84SZMLbHT2uNMEsFUUdU1BkrfuZgObrtP1E8+6G0L\nAODKZuNDp9k239sPcVXEu/ljPLzeomo5C508HOupmn5TtYktsnvX33mm0z7N\nW99T\r\n=ZR+0\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCDhj42i2mizANdGKNEXU5xU/J8mVyzBSe8nYjQey3aJwIgSugDssPXPzCtdfxudav7dn3J+5uedcGc/N42jIbcvOU="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.5.3-rc.2_1624634028088_0.037533075927387305"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.5.3-rc.3":{"name":"ipfs-core-types","version":"0.5.3-rc.3","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"cids":"^1.1.6","interface-datastore":"^4.0.0","ipld-block":"^0.11.1","multiaddr":"^9.0.1","multibase":"^4.0.2"},"devDependencies":{"aegir":"^33.0.0"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"88dee13a9246d841648d31edf0db62e4a4f859fc","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.5.3-rc.3","_nodeVersion":"14.17.2","_npmVersion":"lerna/3.22.1/node@v14.17.2+x64 (linux)","dist":{"integrity":"sha512-KTGn5LewgTBN6ANxAE+arWEPCfpzWCpptjwwYHGRzul6X65v5mQDxcq9zaHhjZj6HcaYmIS5g2uGQHgZqRD7pQ==","shasum":"6aa0d17039e7a25e479d479a80160f86a0fdb503","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.5.3-rc.3.tgz","fileCount":29,"unpackedSize":77319,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJg3efUCRA9TVsSAnZWagAAmrwP/jbQ/MD2+FPUwZG9r1Jk\nX/JwvIWogylQ1HT7GlwyOgsfUVirwurANwtYy2B6dp1GtXvcVFXUfoxuoBNM\nRVUet0wpCwZEW937JMhZ93P+qgmPFjXCzdOA96CkqT/N0tuFgfNy5TjznBHP\nJByZdV9/pPNH7WLlWBq20nlFuQ9g+eLjRJAmOsRxvKJvMcJcBA2OzZW8MJKB\nbmdwhQex8QMccfa2RsCTcRFWQgFMrxK4MMIhfQUa0dar6wFi560Us4SJz7MQ\nGx/VvYsvOuqNg2trHQZ54yifDBYbo3ur9d1VrA4P1JteuBUbBQ0b8GFAnUEQ\ng7q4WWIsPVHve1i3XWV/EqNsSXpFx7wIzzZjhKof+kkgG1WClcV3/2NKkuhr\nj0NUiuFGhYGZBzLEKQrZDbsgVMRBdQq8rq9/KUQ6W25PApUXD3CwYFl+rX8P\nEBAc+xT8FhDrvRDWIEM0d4sCUwW21IM3x9un36pl2xKGU8m2m63hmqbtgSQW\nka7cIjrCV39M/o06W0K0QVFe1iBZWe8waTdxIBncr+AmXz9sxJjTjcjK33xT\nBfWqRE187oGCxifDge4+2DU8JxBOTtW73MI8bQXIjj2RA+/4ikOVmyjaf17D\n0v7K+0CXd/o2ehav9LaSmtubsVjQWg7cR9OcWu1nz9xyoEmCD7IDD+MrgV3Q\neaMX\r\n=EWWa\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDXBsp9KOhKiwgpoDvXtH+aPHGgrBhp3nQt45W0qJh5ZAIhALtLW/Q9a4V4Bd8ibB4d+rKEgv9MiueMZpWp4uUJ67ss"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.5.3-rc.3_1625155539799_0.42516958990817155"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.5.3-rc.6":{"name":"ipfs-core-types","version":"0.5.3-rc.6","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"4155de5f78134a6cbbaa4551d1b35e8e44b580e8","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.5.3-rc.6","_nodeVersion":"14.17.3","_npmVersion":"lerna/3.22.1/node@v14.17.3+x64 (linux)","dist":{"integrity":"sha512-JyBV9AxQwQFKiKbcCDFOTH0xRP6PumTtO+FODvVO1ysMtFrysdh31uaqlyFfetQR269iyc83q1/razhAFpBBBA==","shasum":"319ce23ab32e9931d13d58b984d6dd9c440f2b4e","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.5.3-rc.6.tgz","fileCount":29,"unpackedSize":76244,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJg9ZrNCRA9TVsSAnZWagAAlQ4P/i18BAeh7S2tyaLM9Lek\nOaGOQ54nypTSdy+N3G3rTG3JusljNKBTX3XdmDaY2EieLuX9LY4U17kOV3sQ\nELZHiUzAQYS+4H5esVzCMC1ASbn03Vg76sxmw7pyNv++tLPykG88v9/hbrWA\nOWiz2U81DzxW9IB656Q0oOLKYorrw7IfqOWc0KEQHbBfIyUQuAIsnc2T5WCy\ndptBkwqh1do7PRmVZLH5yWr3mCfT2TyZqcBDZ8JQ9mCxYlZ2y0Vf9Ot/JlBG\n5YeCwRt8pj31KfFzVNhAY/exKEN9q8WcwcTA8pAlLa8A71ToDBzGSY60ee3h\n36z5hSVSglZ+2NRXVRA7oRwqu9/eLiP6AhNvW3jSQKLKeU9faQ2yJ/cQZD2z\nCwmPdrbNLUvrXCwaRSn51FZkleZPurloXGvOSEKZRfcDujUONsDx2vDuuEFY\nlQWTrpgIayW5HRKWslkC3eYGElrc6Ily5M1c4HTupcjnViS9xowZ15crH6fP\nA1zZ/UAkr3LVPSb0PCby908sjNoVWstlNyCKhuV6Pd8CVTgrhwhsjGB2IlgX\nTN22lDgpr6QWjOGXXd7ktHSCnH1PwwKIfxO9Ve3fZntc/riveC9PkYTpp8Kx\n94RFocorUIeeGpsid+JjTRfxgHfe2urv535+poi2CAjlzoyDjjLMp4gNsBKS\n2vmQ\r\n=V2KA\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFhSm1ZpyUMKc1wYzMoODZT1MmQea+TfKxaeLBJKNbZwAiAKF6sKLHx4+Ahdxsp7Ew4EgjeGzgVztmZN6+Re38fBmw=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.5.3-rc.6_1626708684960_0.9818654498315835"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.5.3-rc.8":{"name":"ipfs-core-types","version":"0.5.3-rc.8","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"50361a7c0ea69489bb24f6922319601e3fd919ff","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.5.3-rc.8","_nodeVersion":"14.17.3","_npmVersion":"lerna/3.22.1/node@v14.17.3+x64 (linux)","dist":{"integrity":"sha512-x7rButC8eWG8RADzYnLZDBZar0pVbtwJs/p3PWbb2Y4sV4Q8ufmvXfmdJSO640oA2oJ4wz3cb5rohOj6Gd8mmg==","shasum":"9452e5a93ae39b5f3b28295119ed4c86219d8d5b","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.5.3-rc.8.tgz","fileCount":29,"unpackedSize":77449,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJg/9HLCRA9TVsSAnZWagAAsu8QAIrDNLOo8HjnH8s4SDQn\n1YoVdbS8vK6k+YbWs3p3BAgrfvTg4GDWXsYDKSrh23G4pzMpOnNSVDNhnGlg\nPyoABi1o4Bnmcn11KOIozTVNQjcHD/qiHSnGZy1pd31W1XwfRNkCP/729w9o\nvUFFG2yINlTf/gjclfgi3skTi5MQNSkYGZk+/76RyOeK/9NgilKOvHWsu8aS\nBiSZyWwHsPubmjQNXz1fMj4WetKOnoI0MQ5tfnuo7HLIk2bunSgwmdIlQN2K\nDHn7F2pxxc/AuKBWQNFEwoMLYb1+et2mmg+vUcQZd6iM+HnTeSNPEhkNsftG\n5axPvDFM5t1O67h0c4tkk0mZN5GemwCDMWHGQwqARZaGDucAKD9gIhYTwJrA\nglpqXg/wTJuIIkoXurZAWDbMkyrSl02co5+u/JCeoP18jaUJ463bczWVZTkl\nk7m/mv9/suFj8von9ENLdxqvsPjcx+aCL7HM5v1LZtuC6zMa2acztUdZvKNw\nFUUezCxUSYbeK704oMgP2eHEevgVK9adxrDXMFeNxHyxQm1kNdzv5TPw6qBo\nAIXkJ5aljJbUpNde4Ptt9pHPL3qJ5SOo6Kbs4MBJr+icy4OR0CvGiGIo7kBD\nL8ZrTD7ZuWbM3UgNnKgY1gtbQsetX0Pz9ERJbe3gUkznOZS7Y6aU0z7om9if\nYjSi\r\n=7qzG\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICfzSq8zIg0n3EsrzhUeePqnggpeJEqX7w925j9mwPqvAiEAtUDNfd0XkqvOzJT76LQviRX/u9jZ3FC4vLYPTPsL7yI="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.5.3-rc.8_1627378123112_0.1386338247179637"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.5.3-rc.9":{"name":"ipfs-core-types","version":"0.5.3-rc.9","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"09dd763dcedbdbc52c590150bf9788c3f17074e5","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.5.3-rc.9","_nodeVersion":"14.17.3","_npmVersion":"lerna/3.22.1/node@v14.17.3+x64 (linux)","dist":{"integrity":"sha512-m1qegwvFOxT4iaD6T39KCeVwmEyTPi9DwxJS3udlpas+YNjpJnyeGxTWVJ66qauL8vrp96LAB//CJbkmhQhwQw==","shasum":"77fb8407c60c05593aee2463f44364f4c802fcea","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.5.3-rc.9.tgz","fileCount":29,"unpackedSize":77449,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJg/9loCRA9TVsSAnZWagAAg0sQAIWBAlzLw8ys3jwP4Ivh\nHVPFbbhzagSAg3RVVaOR587a1T0DjDyz0OptxOSRmpf5w1GPs4G+yQ3TXd5T\nwY0rir1oxpYB8rv+mOcQ/clcAqracDCo1zEGBpzcbvmIPf+AzjhZkg++8pv0\nvjNiZcMarTzb55goqN7jPI066tDWL4NK0wproqObz8pIzEgVWflUo0Q7Oxrz\nqPajGN4TNtf2Sx4iEl8/+vmq5jRsozt4HHM6/cSCnYxE0eUL2V6dJUa7Qugi\nokkShOIZ6MYmhsWuxGT9JGm/7eUWudkEncthLPhGVO0f/tgZ++fbR+24FrWA\nmwcwVF4mK1eGpPCQppW16IwaK9oHZSv9AQP9TQ0c+EQcE2mfse8l96KPQSHX\npJKrP85nNegZ2dGQS/1P0vpe/1hF6eMI2hD7wIg+BSD63RWSKVu9ljttjfXW\nTB3lyuVBwsADSOt73Kr9CPG6MrIZmj+SkVDdfvPLOoFD7KE5pxG9q6SesKSj\nzhQFrnY7cjREIEZX8PUqKrGfToLo1MoaCWsBFHwxrb9WabKiObevU0l+yfAd\nTkvhqxqn0IQsUsYvcUPi1J91YBLRM2ovbxWD2ruDHIhW5iovJQYJ3nVLN6G2\nguz5OHWw1FbpwVdnAYRYehmq9whzA4HrqFQeoK0osc/Yv9Mson5onzl8ITpY\nmBSN\r\n=tEFK\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEwIwIxNv3VxdvpB8007W03IJ2vckgVjm5C0wNcL16gHAiASCEauMfFfVbkDwDanPzTJK7QZhHb5AaWfGHr9EFDu4Q=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.5.3-rc.9_1627380072833_0.036118126718710286"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.5.3-rc.11":{"name":"ipfs-core-types","version":"0.5.3-rc.11","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"32f3424f86c9c7bc28155dbacb12edd97d9b84e5","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.5.3-rc.11","_nodeVersion":"14.17.3","_npmVersion":"lerna/3.22.1/node@v14.17.3+x64 (linux)","dist":{"integrity":"sha512-QgqkOcQTZOFzPFi8PhIBSaFWLrtEHQpzyPE5gj76DAfZGGdor1DHnJDPlSatNZQc7ou6j9GZAj7sSWrd3za+8w==","shasum":"fdf383ca534f84b302a6c14ad57a880783ad2d7e","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.5.3-rc.11.tgz","fileCount":29,"unpackedSize":77450,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJg/+I9CRA9TVsSAnZWagAAA/UP/1WDUH3lsPGwqpannjnf\n6tbdaUHVoQfeVhJMjvbbU6KqoEfqTglecuUsz8kRZeO0ujeeIVsF2R7zjXSG\n6GxrmxbS/PxVXR18FoIgT4djH+TIFI5ZrLNGxRYxbwSUDgGHlJA1iV90DpbK\nAOoyCohk7ZP7HS4UzjSZMYqRHVetXTpW4niZklpKAqvxA+ejEA2013EmN89p\nEJTa/P+1IkgU37AovM0bSlRJua5Rs0qaD5jHkksGGnBuF8xoUorQsR2tSasl\nSnLiZ2gtq4fbPixLvUmlhjHSztgV6w3IWkbCWnZulLM+E8n3f8bfUXiEXTL+\n4E+CJ8F2SM9uiVNwNBlr8+YWgaRTuzVtjFUapT52NNLEiNFY7Te0kJiJGPZ5\nFW0TLXnIQNFsLlLK7yL8Gmti9Mf+ouYmUJ0Xb7Gx4APQGVaiGQ044lJgKzsd\nPS3xyh0cpTpJ6/4euKh1q0xLIBzLcZurdU7/4ZW2ru2b60hM49Qb6L6pfepS\nC6u5GNGs8h+DuVXVfZ02uXdm2gbTFq+tUTTdojIPkTmOhBbdwKawzxnsZA9l\nAK5wSiDkl7zMS647WzTyXKg8nN606IgoiFYPP56Q6YnVbklCKvliEDxvFo/d\nV+xMptqek+XicIViGXPr9LxN1RxFOTD+R2tbew4WV4CSZJHtMeQ1bnxuObAN\nBsJf\r\n=/jZt\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDwwJz1juYDWUWfz3+ij1NLsXwUvGrr4lHi5/Ho12bslwIgDJX465PuyMOLcujLe28qP+5C71pF18lo9oCsVOwVE5o="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.5.3-rc.11_1627382332948_0.6901592186162993"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.5.3-rc.14":{"name":"ipfs-core-types","version":"0.5.3-rc.14","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"71bb03c0a3d5e64a1ba617341cd706c83a7346fd","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.5.3-rc.14","_nodeVersion":"14.17.3","_npmVersion":"lerna/3.22.1/node@v14.17.3+x64 (linux)","dist":{"integrity":"sha512-cH277VHPl+Db1SrpUJ2BzKYZo+ulqXbBb0kVoekMw1vbA5KtXgoSJbFfu5RsXSI84cVTVOFyYOJWSQbU7zjpew==","shasum":"c787ffcaeca386c1b54377397cc5631b7306d9d6","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.5.3-rc.14.tgz","fileCount":29,"unpackedSize":77450,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJg//n1CRA9TVsSAnZWagAAkTEQAJNh7P7DPhbje89RMtCI\nRmioyVWJFSi7TAUpYxbPTwedEa50hLeypJ3wH4cCh0x+uuNgQnE5ehUfIQeh\nqsDn6gY8Z11ZVtv30CapkOiq1plfznWoc4SP4XA4Hty6SCschvhFUBpXpDYM\nMrIVC5M/OyT7y35KRlZO/rhLeVTIPvefkORR2Oh1Rs+1FpIjXQNdihT2l+d9\ngzBZahFWoAFY3S+BaXkCGz7FvxVh/ESbVDpro7KPCbUWqlu/T2jgrbdh1VJv\n2x5rJM14nU8iUJAYpGKz60KPpIIBjaStdeQzdNpENQCcrj4agAdKeWW3ku8+\n1jyjJrvHX0nK53qI1qd3xm4LNIAcpXzc5UmbYurBscJnWaTT0IdzrHOMDcHx\nnS3BiLNxlMyYbZ649TeS8nTbVcGVmHBX7+aDJ647esOJaS7W9c/R2Y9z7ehN\nIdloM3homhSswuu8PPe1BFwmiZkIuha/+aE9cEl+Q6O9wZx0wjK/HTCMHO7e\nZa4cF0jvSI1rAf/3Ci0XkK2dmOrrxZTI78X4cZg+7cT29lxSnwlZpdSH4Ees\nR8sRG2+tdxcDolYDYWWtKu+f25cUu+pqQ3fmJEBF63p4GaOw8PcJlo3VsByk\nNo1pbs0NJAyjFvv8k45NuFLRuUZXqSiVjoj2yv2+v18dGHaD0qTCEgo3HYQL\n3aKp\r\n=Nx3K\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD3FLKaamEi0xQ2FGH8Ty+aHXcJPx9wyAKLQ9UBY5g6JwIgRrUiURFIFf0yv3AFXqQnPd30Y0uHeGTWUjDN0AaqZaA="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.5.3-rc.14_1627388405520_0.9128632567825805"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.5.3-rc.17":{"name":"ipfs-core-types","version":"0.5.3-rc.17","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"3aa4afb30b2dc88a8b3cc2442336fd2583e2b867","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.5.3-rc.17","_nodeVersion":"14.17.3","_npmVersion":"lerna/3.22.1/node@v14.17.3+x64 (linux)","dist":{"integrity":"sha512-jvhF4ba2UREDQVYgFmHZ8wVKWb9HUDT37/jV5+j9umh0x2KeS0HI2umX3a6iGmXEXmwg1tz67ehxlzNzaV3D1g==","shasum":"1514341e327464afe43614cf8c9317eaf180e233","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.5.3-rc.17.tgz","fileCount":29,"unpackedSize":77795,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhABbsCRA9TVsSAnZWagAA3ysP/0x0Xg3RlK/s70QiiOLA\nA7jHrRVaQsdH1BjlseruFAi19tLnZ74+3nKck+9cKBbjRMuaA0/AdwTUB2pT\nZuqc0m32FE9I9GDoBsAtqcptU9YMhkyCM2dz4EmCFhSkjlpumFdF5Y45m9p2\n6y67fSKlvryExriq8p93uCyv8xsqCtNTq5aGW7rMQIt5pxnEDIeUDfAEQJL3\ngBhL96nFkGz4MpZv6kgUQtHQPq7mwyQSSpMGnF0AZCkkuLZkoVkVXixXhvxx\n39wd/W0yxR0e+0WTrlzjnzm4QpcwruP6IO0T2Mv3trGZJV7ZJ88yITUxiEg9\nL3ZA/rbvXOgC01f/xPUbGrYB7384qaZUUsV03yVJ232omaXyBk3xtPCtQwGk\nuOxwX5tzVyOtY/orWRTEyFkevxXnnykzqbvIrUpTy9jDFk3XyNV8zTkOAXv9\n2DkSGpT5k00Q2Eu9gu5riwUupTYlX9pYWQ5MIeyXH6kLoY/3WS2mjBUSRFde\noc0z8swGlFnqFk+xxsWidPVvTBUU47iswCGBm1m10oS2HP3Z11nCk/rDrE+w\nLURvkBokc9gbNEuaN6p6D3aCFXve7EWh9LVRmuUibLS3gb+jdknGrgneF6r0\nXZk7+XKjmpEYygN1M9WfOJyVwarHk6KJuCoZnoViYGJ6QseH/LbY77d0IZq9\nFrzX\r\n=RrhO\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDjK6BqvPc4PmL5H53CYNHdlrwxbvCehGU5XQe972UIzQIhANrw/MqpS5lgiyaQjj0h30uNxkGnS7Aeu6VyYg83ByoH"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.5.3-rc.17_1627395819945_0.8394399787410518"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.6.0":{"name":"ipfs-core-types","version":"0.6.0","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"ef41f924e415fc2acd30032e2b484bc32f042790","_id":"ipfs-core-types@0.6.0","_nodeVersion":"14.16.0","_npmVersion":"lerna/3.22.1/node@v14.16.0+x64 (darwin)","dist":{"integrity":"sha512-as6iUSSRlQtSbe3bO+Epmd8XC62lxfuNl8dVznClKhEAYZLIKsQBSpC2rtL9aSyRMocAUbiuX7W0MI6x5Xyczw==","shasum":"1152dc65f7eef2357bd19b69d56313ec189a1c67","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.6.0.tgz","fileCount":29,"unpackedSize":79106,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhACFDCRA9TVsSAnZWagAAztUP/jXNhCxbJE8BfaGhk+8H\nhojjPRov+EDUlXcwkGw4+QEaUSqGLnFNj3grPx+ySzC3HUG3fwY9rFySUt2G\nIRQlBwjNmKEclQJTmwnP7xRjxCiH1FXlPLXTM/qFhh5NF4pMznUIREU+PX1c\nUdA9JeegFaoiH2ygT9VWOx2xef2w756GkfNmfuKC2134VxeEvkm+Rk7NYrsC\npSwRbfA27/O2VRN+Ik4buUB9YWswtzyy/CHeZCUPZDNYsNfxZwuYKRoEgepV\nQXgL/0nWgd/1Y9WhKjW//GTvxSFs1HO8tDg7UKaLC9T2d7IoVjQ56ga277sM\nMzQMQiv3wXEwXEZCwbbGoIF1R15a/ba9LN11d/eRNdgTtV7ERD9xDtQIjq0B\ns3g0dOB0/0Ba8+NRwyX5MbSM163WPH1OBZgE6s0oQIjyF6k9+QXNN33MXkeJ\nZDFQrchKAP+0p/ccWB9c9zKbJHGOAHGFwsyixghP6qFJkCSgVvjkUo9X6CUF\nuFJkwQk//1clLFzf6UNXhV1D5UNkSgKsOCV2bd4HDGuxydGWWjz9mQ95wBE9\nBoR8EUYXO8A0ZH7iCfm4PcgC9bROUkbM42QW1oKiKhZfv/ADSyqJQhG7+gkk\n6g4HyVJkJeoKI8ZWr7QHNcysuUH9ARLUR1hYGUGjo3OpOFOxf8/nNgmsSNye\n+l2g\r\n=I7IL\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCUPNac6qviFt3TdvWjlc5x8NDfRYPSKyQWuTMIce5aTAIhALeQFc0C3mlfjrrd6HCoq/2w8RowevgS4H8S0BHE3YyZ"}]},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.6.0_1627398467773_0.33889336106243984"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.6.1-rc.1":{"name":"ipfs-core-types","version":"0.6.1-rc.1","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"5c43562dd3ba2d2325e297e0a42ef441f9fd2615","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.6.1-rc.1","_nodeVersion":"14.17.3","_npmVersion":"lerna/3.22.1/node@v14.17.3+x64 (linux)","dist":{"integrity":"sha512-YMa7lgAUxo/8OMMuxC0pBSEzofQMd3VZyIJO5wJoaD+w9PHF/rEbg41eGrUbsdLsW0/hlFCdd4p1ccFJlJKsPg==","shasum":"be253ecb8c856e6967fc2177ddc309f299cda01f","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.6.1-rc.1.tgz","fileCount":29,"unpackedSize":79120,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhAT+8CRA9TVsSAnZWagAATjEP/2OH6V3mA5ZZRSev9m+U\nVo9/NLl5oMbYYyPhpbQW3glq0PaTJ1KYS1/DbcBvDEAqhg6cwMhsy+h3kkS7\n6xINbVSXP5T36PLv281cJ8V9ob2KUNkvFi3K3blbrd1Ed2Idyk+NE62RTGpJ\nowfjt7sbjRcRjKtyGlb9ymXNn5hLobf80Q6AZusbYO8xdcQdz7mj5qMg2qD0\nS70n1NZqP8gzyIOUbxGuIoASzgx199IBKLgXsTHTNbbbi4fc6xPwn8K1Lzeg\nihiZnK2kuPwHAVAzhLHsFqLvN1kcCTI7LBPe+92M5g/1pCfo4NRmV5fb8xp9\nRwfbTKjYaC5hFxlh1g+jF6VNIqmLqOiLNVWo/dOwhC89LlclZlBZAXxjOelq\nT73NiR+OgQErNw+rY6lnJN+Ik2Fdjaior+L/ur0DeorPFl8NE5+b4xHlsiyX\n3EAairlXm2I+QdpLMNE9u4tNuT4is4A4YIXC/CmZTV1eJm6ud20ATl+kudwI\nbUkHgUiU2uPTP3kPEkV73+cnYOnFDScGMDrHLg/TrN7IKiNyIvK7rxcwj4QE\n3fjq3OydCl7BpQ27+lRMIupUsGGmPtE3x5OacgHc1p+Rf3mvihVHtIoniM0n\nwdHIWf70BRuduZ2Q0bLvXWkOIcid4kNGzWYxc1JOTCD+fzmx/IsaAg5yPfNI\nYHks\r\n=uNm9\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCNFDyHBrLMqhYxS3m9vS/XubcpDKDsjxqlBNF0n4uG7AIgVC2yap5L0C/pnOLqYFXNOUVkJGoKiqG/wcZRC3UgXzA="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.6.1-rc.1_1627471803897_0.9600546091374951"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.6.1-rc.2":{"name":"ipfs-core-types","version":"0.6.1-rc.2","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"fa015c9b2291c375a5ecd86337831eb1071932e8","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.6.1-rc.2","_nodeVersion":"14.17.3","_npmVersion":"lerna/3.22.1/node@v14.17.3+x64 (linux)","dist":{"integrity":"sha512-RZ7BaxfTcx8Ccp/ySDkiBXLc6sfdUs/60c4qa1u2uz+pcVnjtg4xaqpzKyDM4cAWYEkmgiHiTHF6Kg+Qcg8rfA==","shasum":"454f4e93f15bae2c35d944c49cca5302f6c51825","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.6.1-rc.2.tgz","fileCount":29,"unpackedSize":79120,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhAUy0CRA9TVsSAnZWagAA3vYP/A3u/FKX9bcYLwK4bQrd\newGcgjBMj7eZuRs8IhrhygRBrBp6GiwpVj9RGd3a1Pun7sxHzqjVjEEh3PVM\ndArtWbVmIGVhBK4IgqP3op9hF9UmQzGffsC2mNOPDLmUnj8M10rJG0Vrj9WU\nBJsSwNavzNvS6Zsnc1RynHoVZjlFuRkeaKNXwf13pshBJ5vUiZg8XdXHdeKJ\neql0LyolFjIVFr8EcfEh/lsx1HojGZReKs3JEUKm7BZ02xUs2xK1GwqCqzc+\nyYcLwpHcKgMLkjayydWlzDFiIHKoNx5HVfUCX1b3rVeKDIJSCuI060y+PWxj\n/2QPjayrc0jIBIzSWSI4tSXL5rv1tIwTUJUjkrXiW6MOWnqe/FlTwuA5ttJm\nJmvp869yvcWgtlD/BIfJqCDaH/h6QoKKBIAFC27DNvil/SCfyBWGa/AZKdPm\n6XxI3QBQCo5uu6fGthf040BcdU3CYOFo1QKzpdqoNMi7EidvibvAkzeB+4BV\njNzs+GOwKxTEhy8WPMOQTU2IQEyFrYg626Gd4MwM3VdWKOnABdWmrD6hb9O9\n+cCeFc/odjXeBRXVQYPZiBImRUEX1eltLA5Mqx5NgBYee9X/TytBpuGLMF2i\ncT8YvL6oKmPNYB5odFNq8Nq/YgsbchwFNe1qFSNvF6f9yaOIGFSYtix4KX87\nrrcN\r\n=zXDU\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICJB64ETUiWBcrRpBc3993yKIbJmmJuRakC81vVSquXVAiAEGjQrZ7xVRg5tnKKKo0sBWp1tsiHT/LPaZLpIx2tpZQ=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.6.1-rc.2_1627475124052_0.2718436122175212"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.6.1-rc.5":{"name":"ipfs-core-types","version":"0.6.1-rc.5","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"43db72b87f0153ae4e9c46aada750fbb85d0bac9","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.6.1-rc.5","_nodeVersion":"14.17.3","_npmVersion":"lerna/3.22.1/node@v14.17.3+x64 (linux)","dist":{"integrity":"sha512-pB/GMCv1MsM66NiKF31oegSEKxZ+OOM6tLewUe0tvPX8fScfJFB7nqT5W4u9xAj7heUKh9jfdG/oW7s+EDoucg==","shasum":"f90e58f2732a245ee23182c3f538c7e111c9abe9","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.6.1-rc.5.tgz","fileCount":29,"unpackedSize":79120,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhAYxECRA9TVsSAnZWagAAm7oP/i2XTxY0nY4KiUWt7ijm\nDIMhE6V8wtB1GgLa9Y9+MMuB7kxI4FvwQTbGeKoqLJ5WVveGi5u/f7aV/vhf\nRA+vZZIlBuzJTSzOmX538M6u8WXADIzlZ4Vg7KM3Ya9fMntLUBH65DOJgDLZ\nKxMrQOGvi0QLzoWpHq19Wh/ngGb7euVC4QQe598S7mDKxuV+Fo+mRMAI9diz\nZrBNTmQuzJyfPnE2ioktPiT6rvOiaSQ7sOb8J2zORGKLfnaaqnRZVH7hKds6\n7Tqu4vrXTNbX6CA56piLuCvSw7PeF2YCfJU7jpBz9IpuqeozVG5EdnhG9aid\n73EBq6ieiLexPPl9M3Sh+v00h0rQKQELypaedniL2R8NdXXbDoReGS7e5SW4\nwRvFbWuo430Ic8g+RQVQ3slwGV5NY237FzeyEC53TI5IJmv/WM4LL/25N5PS\n8HUpn/vkeekM7PfXgQRiBoW/QkYCJEJmJu8S4M8FyK9tWIKYdALbFBbrR0u4\n8333B5F3qdnVLAN8nUpGUvaWIx2h4acET45YwiniFXUBKwC1ajLQQ1d8jRCT\np6j21DWUAmlk4Dq7adLjDt10uBEU702MGk+H1Bwg7VsteZrI+32fVo8W3Ws+\naWCPAIWb2/DErgivM25ciXjXquhPwJY0LL/pp2o5DNdgJjb698gS1HebNG+c\nOyyy\r\n=Gmmh\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGSAVVek/qQ+ukiNaDloraGlxSXlcl3pxoyoYFzM0dKwAiAHmkbP+gMQcaJ2TGW/3u/zpgAfoqFyxfamkLGgTVyjcA=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.6.1-rc.5_1627491396627_0.9151819632372444"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.6.1":{"name":"ipfs-core-types","version":"0.6.1","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"dde3d28b4a0d0f74d73c0c0b38eda2e01874a2ed","_id":"ipfs-core-types@0.6.1","_nodeVersion":"14.16.0","_npmVersion":"lerna/3.22.1/node@v14.16.0+x64 (darwin)","dist":{"integrity":"sha512-2SHaEIb52JGzLikiIq0Y665Qaop0q8ITOI41Z1VfPG9GJNiAl1uyasaKffNIFlq+RQFXVup3V0g1R04engHzEA==","shasum":"d28318e38578d1f95ef1d97e0e456c235bf2c283","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.6.1.tgz","fileCount":29,"unpackedSize":79411,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhBDICCRA9TVsSAnZWagAANY4P/2dOGm80YhwUSD08H1ZI\npaTtV416CAc8F/Bw3f7EIDPQhzeid/mAsG6qUnu7A941B0iL+ZOV06gXPod8\n8UguaW+9h8kJLhn6gUbjN9qolkYQROFLJnrsKacIHgaSO1MrTGeWKKUrarTw\n3it6LllnV7qyU+dTPTtibdBQglVjOWqsZJ/gEmf2JFtR7OalKpBHlAYcXegX\n/p6GTmkXffVmlt3E7Lt2ZXRGqmrVzk8+pV0v5XSMp2+RrOPnnvhv0gDk3HfS\n3staxzE70EaLa3r/zBuDkvwVaIWO7+jeKo+VuWV5e3acn22T830kBf+s8uGT\nWGEOSxxEYnR7ZIgRTVl8qUhS6qofBhUbTiLJX7SxqZscpYruC6WHhN/uowpL\n+yWACMYd9x5scYry/BgVOD7ufLYseeZYohO62xAnlxfddxFe76vUROc1CHKX\ncnZbhx2/9yEwySAAvhPutYYH7ZELee8qeNSiV/iO9CeuvUeu5gwSKCtQPrxI\nxaODeJz1HGL8wAB/pLAamJwNepPVw2dNvmQy4YTH3sjAEDdbTD21GNW1n4Cl\nQJaPFQpMrVjEnBqFq1gytwvEDbtIgLdFWrA4D1s3JrzCsS3m8DI1VNNPRmiG\naNTTmr9r2VAINDBWYM6v6r3EYmURqZVYfFSBtjxG0fyPndffzI6PJc9kpFMS\nxpF5\r\n=xTJH\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDHeSbuwG+6j41/mdhQrMi+s0fz70Vc1RWjJypTTowLaQIgQEZJtYTPrfitwOxHXSBbb7PqiAPFPY/TYJTiWJFrArU="}]},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.6.1_1627664898732_0.21221324913504902"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.6.1-rc.7":{"name":"ipfs-core-types","version":"0.6.1-rc.7","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"fa78b4fe1386a151422bbccf33818f3b15fa36de","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.6.1-rc.7","_nodeVersion":"14.17.4","_npmVersion":"lerna/3.22.1/node@v14.17.4+x64 (linux)","dist":{"integrity":"sha512-yv/+AMLLldrW6Y0IHFVmF41rCxlK7Bi7XDTWtR85Y36iaeVyCuGSkKCHpStfjYophXBoAEOm1tRdLdDhJX34mg==","shasum":"b6ce95ea9ceed6cacb2da5b0728c92c981eb012b","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.6.1-rc.7.tgz","fileCount":29,"unpackedSize":79109,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhBDdLCRA9TVsSAnZWagAA+88P/1I+n8Rxm2bA5bmqzkDh\njkwLgRgpjz79EWMAZpgMGXkFR+mmgq3r2e1dC7P8vUZO2a+jOqHeiIJRxMm9\noU4Z4ylY2Ve1jUff0dmr35z/uM/sfWLtK8Qs+jOYS2lTduu8YQPnp7aMxxJh\niNC9O2b/Vx8xBM1UzxukCCz72YXkd9Q6JMykabMYcvCrWVdNeQNhqC+NCRv5\nv9N1penY9C4kqPUy8IwXE1XHYcPqxdT5WuqWppb4Zw8ff8e9AMateWhdF4Xq\n8auJz70/+MzEzcluM5Y7N2mewRfNLqBrRp1JEdYdBpgo73HpudW3iiHxPe46\n8ObxI7RY1Y5oUVeQNb3Ms2aUY+WGC6ATaK5fv52XnmCc6Ril1TJObFfSsbvl\njiP8OQ6ISikWILPQPz8jHM/xxSNCuAMluaFF+bTnG1mR0OLnTKTEiO9/mSpj\nG4Lckj9IIXrUu/wNOosNjdSCljdG26V1fuuKBhLmbI93YAZ36ZSIgaVeTnVN\nntIcI6m1ck+os27Pz+kWPNYvTkXx9PBUpyPpb8/qGufuuuJS9cByOtHyPpJZ\ntZyeyaYM4FrPUTWTchGhcZW7fA3QYzwBkB8pTdHZGml381cM7kHnsOF356Ab\ne+X4BlcByFUZu033VeVpLwXi4vo0sBCRCEM0G9W0AHcaW0fLe9nL2zyVqAvY\nq0Pb\r\n=XLUB\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCrictuuZwHUr44HDu4z2iTALbKdAvhRK8ymUQ80CIF2gIgRmBaEAfF//OU4mW2MjIwc51CceXP7Ly4fY/grzhNhgo="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.6.1-rc.7_1627666251309_0.6289777727887613"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.6.2-rc.1":{"name":"ipfs-core-types","version":"0.6.2-rc.1","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"48f655ad4a2ec96f84c4f73082919a753523408b","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.6.2-rc.1","_nodeVersion":"14.17.4","_npmVersion":"lerna/3.22.1/node@v14.17.4+x64 (linux)","dist":{"integrity":"sha512-pt3n5cp4XbsI1MpE3KFA6f8ZD+hno+J2KHbHyBJ4yjoSZS8Ztd/M/WePd1lYkCT2CufJ8tBfjShknhXjt4UYZQ==","shasum":"4b6c824b8e709753a7f3cd139c20569089455a59","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.6.2-rc.1.tgz","fileCount":29,"unpackedSize":79425,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhBEuJCRA9TVsSAnZWagAADsUP/0WyFW6AEnA9CO5L7iZz\nhjo8G4+oEcjP1iLqyP6Wo0b0bii2iORAxhcH+0IizoVCgXc0/BK+MewncCwt\nlZ39u69qAUoBbDGCOpTk7isPAhfhu2wNNN2NgpSCeUQOBj6h7D5J+u+xZLWv\nEyLln2d+ugT+Ufupd94uByVVfRkjFShb8Ou1B2mgLao3ACzBQZsRnkkZG3ln\nQj/dA5BM50U0xCFQHOO3fZRRyLFB+u6uNn2VgWqsk4GH6IfHNZhoCCP80Gh+\nOPyQ0izEoV67j9vsROGsY2F4rkziFVGvW/a+94v5HNhqptwBgAmaH8NPbhYn\nAdc0z+2T9WLMsG4rm/mTIt+h/qnmY2HTWoLHkujiNb/Crjzfk0Ph+y9GMxW6\nDABnFvUpPLaehPMYTElMEpA9kUJi3It/2yn9Y3pcF4ugGrw5zcYfABwzQ7oT\nDe6ddd/nF6myQBGcPzU0f+MOd1nSTFLW0LvvtQN3rX7MwFII5TpJ/acH25xT\nXYWkz/2qbp2BTMqieDzA8dSrRmo5btBpuT3Dc48dovDprj3jdPOXtESpWwRW\n8l6rz3rEU9PWYGqbgU8ynoqRdraArmu9oSIDpHbFBuwACbYWFNa21HrG8JQv\nlyVK4ULXLKh/2ufTVRnQL35qCcAZ+wXYYj6Ibym8iLWmhganXaCitw9ChGNl\nqCox\r\n=D9cf\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD55EtX5F8EPoH2ab3UbVsbhAYd1uNr5BZWjfgAtgP7MAIhAKyi1+tfXN68gIIHac50Q86mrXG9RY4OPevMnObEvX6e"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.6.2-rc.1_1627671433204_0.7714767037336203"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.6.2-rc.2":{"name":"ipfs-core-types","version":"0.6.2-rc.2","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"1db6b88afc5647d3a187e0ca4199d8ab2082c629","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.6.2-rc.2","_nodeVersion":"14.17.4","_npmVersion":"lerna/3.22.1/node@v14.17.4+x64 (linux)","dist":{"integrity":"sha512-DKfuor+nMr+hK1x6jJ+DvQji9rh8DpQbYn0ox2Yx4WquAqQ9yvnOdfE10pPKSqACYNKpSH31DK8w50TPu2VeLA==","shasum":"5d03d4a0b566385f29ef2ab0a4349851ad95939c","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.6.2-rc.2.tgz","fileCount":29,"unpackedSize":79425,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhCpulCRA9TVsSAnZWagAA3moP/1jM8OtnKa/H4njHSrqm\nNpo2CZJUC2JycDNUZvg8aivBjx2YOCHLh9bGg22SiTI/7gL//lrVXU2kwqW1\nyWoB2neIrukGglynQmy/+4ATVFhhEZ3YIDqbJhsyg/OIr/cjSbqwm2ncBq8h\nk6y1pCwIgRrQl04X9F1Ug0Mzp9xtROQh9gVnIu1cOul9njofc+DyjM8jiiKy\n+7Uy0oYVcmv9O8W4cn6N+Ok2p4SVUw06XLhOQpjwhb+sjx+T8npR6kOjMjv/\nTFiByx+xzj25MFvsQxp+VIG/BKBsWdac/ABGVXJk8kAOyYhusFL+WUiyz4oc\n2Sf4v044OfgZhzSf0q08whgPr3FG/H2Z6SS3jqC6HwMcreIEEPTEOTX8L0fd\nCvjG+SnemaHH5FtIylYtsFH+quDE8z5DtLFxcGdWG+SqiI44IrD/38o34irX\n4gyatrV1qQWsvYwoAqtc2TOrtGxzwlsnOI2ePz8at7tFS8jYkwUUUXlzsuyB\np5gPXJSYoN9eXcTECIWF/v8BzziXpjOepUacO7CDopDlf7jaSWVFZ4do77Ef\nqjmwURPHFzmTHSZehUwBhS410vHkHu18J5uvZuiOuPbb7pz36gHSStsTM0jJ\nMyN5p7TFALxInoqogFt+VlulTsZOCZ6sJL9jDfi3jgpkBsgUhbygJiZyMbmu\n5vnz\r\n=EBwH\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAKIJtalxDEiY9TFYT/+tUYn8Ji05ccgRPwj1k2O8LhbAiAYv3F/mqpde4gLJ+1q/hp6AokuT85lWCrrmaGsMvVpYA=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.6.2-rc.2_1628085157770_0.6416270515101858"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.6.2-rc.3":{"name":"ipfs-core-types","version":"0.6.2-rc.3","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"6adc3fa18f1dedea22babce41d24d7435e497ecc","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.6.2-rc.3","_nodeVersion":"14.17.4","_npmVersion":"lerna/3.22.1/node@v14.17.4+x64 (linux)","dist":{"integrity":"sha512-+i1h1urjmd25lZFGFEx8uxzeDOsuqVf2MROa7CDTkJEACx6Z84ILmwqTWLsGDdQEUqB3Gm+kbl+Qzas74yob1A==","shasum":"06f2c61803648ffafe16bc0e13e28d13986e6dbd","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.6.2-rc.3.tgz","fileCount":29,"unpackedSize":79456,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhC8/4CRA9TVsSAnZWagAAyKMP/0fmoALOvFKLmnjBR5C+\ny4jmrdhOBdnvNj88TTzUJfBaYnKELN84uVDQoTcs1d7ZbBM1FPxzUL2PsP81\nEsM3HGXLARrPD9AYWbekmIOfGo3QuiM+HzLimcZjot1rtB4ZTbxUOeu4D4v4\n4MSW3JSlIXCJuToLn6iSQ2Pc6ZWZZ1bBXZ1wFNGEYN++WN8r23N1QYTWuHqe\nCsbyyF/NvFtFsHJYjNuBUZv2YHh8Xi/8YWTq/15MO45alkOCmgVjvMdi2RA/\nLsN289bfy3rdWfbCGCEFZWPSjmjYrXEfEHReQIFo2GL7tMs+2v0jcvr1iw1n\n564C23VTthSGZraWf0fEtvaA8c/SmZ2eHni8qMOHgaFrStcf4bIUwB+QV1Xa\nkcUlgVSJWBQx7PndbOZzhzfWZSShHt+FMk594rwXbIlAJfhkKQx+7xpN+e/M\nPEUYwKK6LMJgIFc5/QhLojwaqKVzGvMjaR5DLr+hjEIIcV8EmEg9ZPzt7MMr\nR4Cerj94vCc9VPX4lf9ybkU9aleAf7s8x+mJu3o17BRS8GVI1ty2Onpynkyc\nEYsHP8sWgzV3Q8rkDBC8SqGtNiY0WWCLGuZwkQgL5rBDT9S6MgpZ+ioc5PTi\nz+OSFDpOze9QRMoDnStBaU5kbW+/LxVm2oEXgO9x/34nCrkxOqc5BR+T5v96\n2Dju\r\n=yKIu\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCpG7liyfrbkHlprKX5Loca+QT24vECxx0T7nWlmXj5gAIhAKF1bYmlSBQy2eaKyX9tBsFq+s+6qXF4bbCKu9rpXfHy"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.6.2-rc.3_1628164087839_0.9384959048767301"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.6.2-rc.6":{"name":"ipfs-core-types","version":"0.6.2-rc.6","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"a6c68803ca19536c022c72554af2311962b2a063","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.6.2-rc.6","_nodeVersion":"14.17.4","_npmVersion":"lerna/3.22.1/node@v14.17.4+x64 (linux)","dist":{"integrity":"sha512-xw0sHRLvYAQHyt02P7Fuh5tyMwpHI9LQ36YuswaA2FLhM+nRgHHJihOSmB7+BMns9pN5NZ9Th4mt7QSkD1C9ng==","shasum":"0f3a14cae74ca30f84aa5b6174c97d80da4d6c67","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.6.2-rc.6.tgz","fileCount":29,"unpackedSize":79359,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhEViTCRA9TVsSAnZWagAAOg4P/ifzs3UhS+qZM3fQ+zZl\n7gVXNKRO3Q2lclId3xAK34EXbJKq9pLIMO9jmyPW8pNVxFoeHGzpCSfgpDWA\nUa0U1fIEplziK2Y3p1WZpIcDX8rxtPLfENVH0nENpvk4rRLzutZiWOhXkeGZ\nBCefUoVFSwLsSFyxhzGcODhS94qLZi1H3U1twDXJkCsPtAS97uA7THTpDDTW\nDSlTseUQLJ/+TJZRdgxXUXAvrTOVPzJAwer9oXZBubNvi42DOReGNWtvRnBy\n68ZXDYhVmcbIlP+Q073/hTe3cxxCfECGEQbHtwUi46Yg6uI0lp7BCt8Wuy0p\nlzbwAYSqKW9v7ounmXAxHQOk1ndpRARvj8aieXtY55kt5fBQL4ymYIPkeXo4\nl+lMM+ieRP51E5nCAScsO8A0ActL1MY50mbA7J2hBfpGadZbP7mQ6OwGvisQ\ncFvK55uSDZeqHMh9qQ2g1XaoHS3UIRi5+35jS3XmmFGzpC5VOUnRnqqr2ruw\n8SPCc4Wonzb/b5+okwKXl71aistEmsEZDEvRnb5xJrCt4NEzAHdXsDOhH3Wd\n2J9/7TLC7vJDAY+vWdS14z6VphzcSiLjajDmILbTTJFLoEVCJVS1kKFxn7TR\n0LPsY+zxTAw5GYQsiSHlZe44qiFILcasVmXZAj+IYGIy00Dk8xdY46msnUSN\n0Hjh\r\n=iOSK\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDrEW4wAb8x/aObY6adNLuvK015gi938ubGPvb71tsGzgIhAOvJIcPbPawtm/tTBNvJ6UUDvAAtqWT9FclX6+E2g9lo"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.6.2-rc.6_1628526739238_0.4426809968824019"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.6.2-rc.8":{"name":"ipfs-core-types","version":"0.6.2-rc.8","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"213f0b2df0e407dbb97ac2de9b82830da234fbb0","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.6.2-rc.8","_nodeVersion":"14.17.4","_npmVersion":"lerna/3.22.1/node@v14.17.4+x64 (linux)","dist":{"integrity":"sha512-Cvj86eqzg4X6mmHjxJtcPXrL3F65/dhQ4Tw+hPmm3UyIauEzU2eAQMdfNcPFovANg85UoWwPUKa3pi8z47XJGg==","shasum":"523fe4a026f421cef67f1278dbea39a17f7421d5","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.6.2-rc.8.tgz","fileCount":29,"unpackedSize":79359,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhEih3CRA9TVsSAnZWagAAJ4AP/i6geEGV8JqHv2UYGdkJ\n0v+CtrNIDxmGOegGlJjvS7yjTm40pImJzKy1E1EttLFwOe8FKHuMrxA1pO4m\n2q9Ucdq/O/iJ0JDY4dcwdEuCv/sAaA6RVFjgJ+JwfifqDRUgm0pra+b94Klz\nANZEvDAodlANk/WmN17wASNmnBDKWTfxxVs4uj60wezuKQ7Aubw9u0hV/mq0\nltGRdd4oyQfpfH6HMXEb16HkyAwR/4VUfdo+Ij6HxJFxozcN1llQ32RxLKow\nn3BhtoaMRupGJfHvmEzElEmzL+3+i3GgF//Tfx1EWkwP7aXZSLUEa7D56xLI\n2ALkwZR+6c9GTa9lcGNlgb2hkEQY9nFWHa9dyHJfySMB/AM53G79dVxYgj4f\n6XtfUinLsE1NqDpZz46ZZOL9nRQKzF0DZvNTcatL463OPaiIbLk9Suf0Fe1O\njiIZV8fZ67vW8PYvrc+5B0TDUiBYr5JAeLZtBwhjy99QaU/XffzMdFfXrf9L\n4r6I21dhaEfMKkosU5UOJgsrPcaAjxnuji+3qb+IcDq8FcofaWzaa5C64Xnz\nCTcRlRAh6/D13KU1nb89wG+SgCyePv2oEVO22NtQluPdkrnqkL6gD8ChY56P\nbmIuHiLeNGdFUj/j5P60fqCPaOQHXJW2Y65QCRWuqKqSIPYTm2Hpzp307Vjs\nTpQz\r\n=VIXD\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIA+F/saoK5NMDABBTvqMCCFdjf6hWyQ9ebuUUgEfJH1KAiEA1aDyQVnZHYMmTIdNzFYjWh1yimLJKVjyr73PW/JyFqI="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.6.2-rc.8_1628579959441_0.2312759304567975"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.6.2-rc.10":{"name":"ipfs-core-types","version":"0.6.2-rc.10","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"4150d1e736c15863ae7e354fd1f7d6d4e34e4452","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.6.2-rc.10","_nodeVersion":"14.17.4","_npmVersion":"lerna/3.22.1/node@v14.17.4+x64 (linux)","dist":{"integrity":"sha512-B/hZL5YAJCFKc7kRaVborB5IDuOiiuHLKHYgIcClf9pdteZAZEX5WIjcqvAKnH0YKmzKSM7V4ZWeeh3sg1P+Qg==","shasum":"a5500405bd27c9dfd96ce4999f9508418fc1b599","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.6.2-rc.10.tgz","fileCount":29,"unpackedSize":79360,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhEkJXCRA9TVsSAnZWagAAFu4QAJGhAkUuj2OllMTzlTzZ\n9M+e4bSZM+9sV2abAyWX00bIvLOB54fRoRSMO8vP+kpyZMqkVz96FOU30cQA\nu8tmsenw2HXneJpum9USF6hTLXUSauXE2LP8zmEN99Jui0WS4GZtw8Vkwen1\nZbAsbGIV4UDswMjYQDq4QgB8EShWxyeeEti1ajj6+FtPrqYd4xwrYOIp0CY/\nVfoNX+0QZBTTmB3jJMadQr5PTrgBDW2VZHYjyLpN1+wm0w0347IuYr2jP+sw\nJOxQjhDl2m2t+b7U2RvUKy+76JH94CmHcPvCJIot5sVN4gavvSQ+UyXGI3nO\nJRUhEbQ0eiRmeAa/7Dv9NsEd2OpYb/4Ur6oJXKiwRq45bhdI/uJd8QI0Hcsf\nSTVg2GbUe1D3bU9K1r2wqCZoEErXZ4gCHU3hOlPSn5YsMbcJM2HNrmfCnFKz\nM+lzenzBrbWTwZ4mH6HjecpKTyDJwR9SxFXYoRbxAZCq5uEmMYGjbGXSiUHz\nfxHJNf8J1lM/QH8rToEw7ppK018YJYjhNscvI9mKRmlaZLd9O2FlG7IVI6GS\n+d/Mw6xtld2+9BUFN4f2rMms2YcMSMrKvSjw5N841jxNzjfxUovIVSrCClei\nYsEHSihqJ5jtUp2KXpwnXpOUCVAmEaqemxbgCew9ov3qdEUz95Cph9BfWREm\nbd/m\r\n=b/ER\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDtx7yJa6nr3Mx8rsqzoyloq9CwqaI1643mKOAdea3QWgIgEU8+K7KqYXucsCNM/0WgJUxCVxt3SRP7np/+wGtlF3M="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.6.2-rc.10_1628586582766_0.9490728115877849"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.6.2-rc.11":{"name":"ipfs-core-types","version":"0.6.2-rc.11","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"fae598689a0b9a3bdcf80ac71c19b709294f2932","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.6.2-rc.11","_nodeVersion":"14.17.4","_npmVersion":"lerna/3.22.1/node@v14.17.4+x64 (linux)","dist":{"integrity":"sha512-epn5qkJxwKQdeMmgrf72H3ww+KENNJ+8OhOr3N4+1KhoZuohjnY0tASLm3QWEl5idahHxo1LZT9N3P56xQ/rrg==","shasum":"8814f47c7b56d817b2af8e3e0c87aa58bd55bbe6","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.6.2-rc.11.tgz","fileCount":29,"unpackedSize":79360,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhE5bdCRA9TVsSAnZWagAAM0UP/A4iGTFId14Ml+kapQ2N\nh8t3DzpPX5hBFntatgtAzmkz94jndO9qtDJOQdj8JefLzuz3lwy0xzZQ/324\nZ/HaUncyrhQwMujFnV32cwbQ8NR4fORhJX096WYaJ4F+6AOWOK5Nv+K3VUOV\nRDO5jh37Gbw3reQ7MXAqAiOT+muDV5tEv/wUhCI6SgP903pAPLrzlgutYw5S\nimrKKh/7Vmsegq30CUYa8eLDhYNH/pJDxumRO67gft9StPF/6WzU4gESjV0N\npCKoVXK5E61Wevyd3/9oNaPFxWaMyc2XxKVQUscoziJk209vIUIrsN+b57lD\nki2Zd68K33sPDv+xNDx+H6b+d31/c9lXCVqGZkfsB6V7u2UkRtUOLOW1HBSD\nJCM45sg3PvkP6/ojgrK9rV7pregx1qu/qGFcj1dB5tRT/0vox3rUrhu1baIL\n8i567LjjD1c0azwYMsqE69YcpPyrQCVGtlb1i6ZFGTUfzug9FxP0YzpG43ig\n4ghaOeu4+fNCO2MX00q5ebfAzL7YcDWJFtXGuB4aKVSVb8PseZUXA24ypei/\n1h95BgfTWoqDpv0VcAUqd4KFqxdGOQjxsxy7JJ8J5L2guSI2lbV+ysoxozKc\nSP4vaQgSxvZk8APWa/bTRF/bK9jCZrFN9pSx4jsGPoWzJBohbPpz1kEurnxH\n7XIk\r\n=pmEm\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDPqWIRQqPuUGCMQ87rSp2sXMVE1A73HSuk4w9AM4DyVgIgVgccIgAHdaVqLO3eXgPLWt1OMojbhvtmYxPnOLCljSo="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.6.2-rc.11_1628673757380_0.44190323899602313"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.0":{"name":"ipfs-core-types","version":"0.7.0","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"7f241319856719f2d9f2c1fc4a6b1062ed1ad398","_id":"ipfs-core-types@0.7.0","_nodeVersion":"14.16.0","_npmVersion":"lerna/3.22.1/node@v14.16.0+x64 (darwin)","dist":{"integrity":"sha512-tWJ5aJPPKeMHccPIx9EEXRZl1vsgu4rJpSPMFjjLz2JkGr6tSyCkxCOvsdSTsscfITx+NQcvcyPQb39O12fGOw==","shasum":"d9cf2b60b4c2c3b5c54c01c84c55a06c3aa49e4c","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.0.tgz","fileCount":29,"unpackedSize":80287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhE+imCRA9TVsSAnZWagAAYC4P/R5gSnx+XoSj9n1/Zcih\nWZ/s3kbePewX6tVK+cAa7lpusLUG6qnQYBf5vArVs3sNRzpOKG7iVd7/3Jmb\nQJwmJc28t2+VKOUXJgbHH1Xiw6D6hM7aLsQLMmIxHQPwkfeCtNZxAl1fbAn5\nCDqFZCKB8dhkX7AWJCshIl5UNiXYWvlwS2dRvCPonJ6sdMywzJabJQ5AVQlD\nVrHsDP89i25b1Wpt382kz/yn5HIh474U66dirJtBGJo0KZty2RIMQZ3y8rgD\n4uTxH5gg+JwXuvxBLMvqu9SwvNvcrUroXHL/is2o8wE0InmuRV81CerJKW+7\nPlVQeZSPBxlhpFkON9ZtMqGxt5RnqtUo59CDANQYXtHG8bwPwTHG5NpVW6D4\nnNQsWqwZHHvm7kpDAXkjCYLcghfoBLUFBJN4FmTKQi+TFOof279sDGkWfbkM\nboX8IKN9e+Y7mcpz5DAmZ3z1IaqkItmSs8DvDJwHUliE7kFUVWUNSDM0FvCd\nwAmT7ylyBP2i0C6rT+KpHimpNNSEankLDOenkGapinmhC+TTugveDbjRKPju\nCR002Pd606CWxajDdzkNdlyc6x64kle4p9IoQ3vWh39AwGJ3k+cx3JsZpAqN\njsalHiNUGVXJ/VK32he3pS+Qt8ppdC57Mt7AKKs79+WUcFWDn6TSGLE6F+jl\nctwx\r\n=cx78\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCzsNjQiv89lNReShlr8VxA2BXYqnIYZPhVzY2kvIvQ1AIhAMgLTg6txro7pW9P9wBIw3u0WbdDKA6SjBp1y7lPrGXV"}]},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.0_1628694694787_0.01349848883610738"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.1-rc.4":{"name":"ipfs-core-types","version":"0.7.1-rc.4","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"b77356741ac597f57e0b9ed57cddcf0ce3fe7806","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.1-rc.4","_nodeVersion":"14.17.5","_npmVersion":"lerna/3.22.1/node@v14.17.5+x64 (linux)","dist":{"integrity":"sha512-YzOAEq6Z255hhNO0hWNW4IZgFtZfDzB71G1JZ0Zg0GT1RFFrwCVVCtQlwcLo6zh3Otrjy6Ab8y4kUi4cPgWJoQ==","shasum":"ee630f211dcd33b27233a54b0a786293d78bef87","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.1-rc.4.tgz","fileCount":29,"unpackedSize":80301,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhFP0JCRA9TVsSAnZWagAAFkoP+gN19yGQrQiUOw02+tVb\nRzjp4MgdIb7R7PbdeWi6CSIyw9PDrOagfq7WhcAPnCAD5jnLVEoNIrRr1qzg\ni+nddRR7JaOtzTKLzfjkXXc/Q1AgB36lYPkztjbO/s6Su+SBVMaQGZ8jOYZi\nabL1z2AlNq/Ns8nFYfrc3Rdcg+4lpgLG0lTLei1dV6dC9TedTuyVzha9Hy+q\nGWvKDtN+XpgXsv6iZ3ikA5WaR4jhNuiBhNw3ur07adZVZDvdE/Vu1P03H7O6\nexcwgWSX4HEKcVxYQtmlrjZk7Ji2MuDhh7LWBtV9DcySDgdk17kHBaxMVbsN\no7mI2br1bfOMjFnKfcoFZmXHqc4mZNj3K9dgANUl5mn1VukRJzSWO2lwv+oZ\nOtLHuIbMTJmvUmGzwRjqdwcH5g/rD13TkTOUMuuY4MJjS8UjzFwycez/orFm\nYPXrlwf92WfQA3/1NCxbYl3ZhXI/Uy5aC6StJIo2ZQDbodDPdf7yg3viJlUw\nwnTlDAAqjj58sxwR3FKcw7pCtRHO8CH3iJ2C/xoyvxxL9i+5eYGkNx+NSkEi\nEVELO29+wjdhfpMiJ0Ww6TBb2em3fwduUSLU4seCTdPGN9xK/YEobv/Cfex/\n9Y+9ztbcjueTmWTS5Oc1oR7lrhU1yU35wvIFPaYZ+7APpzFC/NyES4mWB+ot\nR9TY\r\n=3Sq8\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBRk0HWzfXRx9z/KE1pdTXlC7bnCDyJCqHz/fypE1mBqAiAypPc5yWKA3i3TdZXq0pwYv4ckJmZMGPN003qbJdM7Gg=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.1-rc.4_1628765449189_0.1690194635304869"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.1-rc.5":{"name":"ipfs-core-types","version":"0.7.1-rc.5","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"55dfd937e4175e049287b9093ed9a52bcf085711","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.1-rc.5","_nodeVersion":"14.17.5","_npmVersion":"lerna/3.22.1/node@v14.17.5+x64 (linux)","dist":{"integrity":"sha512-7lxQyKGqr1u2zMB2ETLpFW8/zTDaERchQKNXojtv3njsPQEeFcm4paWRbbWRfcG9CCjcFdODIWfNoIQkEmd1Vw==","shasum":"a09083fdf7a08a125f3a1eb351ead8d7f399011f","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.1-rc.5.tgz","fileCount":29,"unpackedSize":80301,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhFQDbCRA9TVsSAnZWagAAIr4P/RhnY61kqsoJJ9frhuWU\nkgfIny0fgFETK2RPHqJFDysu0IXeI8iNSuzwBsF9ZIdKcvsg97WHrsqdzmzp\nOfVE7eFFFo8trQpS9B8SbKp50/pSN58japf5NMH3e0gMhcO3D/5uyXSQCHFA\n+PaWBaeATnzwXlI1D1uyE4o9RGWGu5konz6atixASFWuW9d8XBP0t3VgOH6e\nv6yv9ofjDLBTrNmtiijGpmNlY9BVw4pRMXElyHhwK+V9S7LCnLpGN2WGiON7\nrSPES3bxNb9eiMSwMjnsJDKAyonOBEpJ8WkLVnHthotAPSFqzhtTooPzej3r\n2HT272MEBmRQLZ+aguNvQb3kzHtgd3oguMpJRzjf3LsW38wpKVwSFdgC51A/\nvUQwVrlkR9SeK86IqoWoir42H104J/v5O+RfNEhux8ug0mILOgsHJjmN8Wer\nSie7v5QBQmdih5jL3+xt8IQMDF6x0EDeuDz/fEIxvdwuID5tX6VfOU82UWM4\nvLR6FMkjgoKO27fW0b1I5Ir36EoMWPZPP7TOIJm1j0KC+G3tO7o7DosWdVMu\nSPCxmivwGQCzIcdxL+PDuF0eTYP/b0OTutm1ZJGQMK6SQZQq4etDGe4KFYg7\n8hRX+UUBkkdPES/lGTVvC4nKuvVJ5L7xO5xk+Ie99EcbTsyYcMXiSX+SdLcE\nNDZx\r\n=CN9m\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDtUJmyLFy9MBgYJmpAw1YKc6FuUHlYhLhIY8h/it1S3gIgbpD26srq/dtitPbODhz0qTRRy1y26jJ7v0Ot9JUAZhc="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.1-rc.5_1628766427252_0.47901875809122396"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.1-rc.6":{"name":"ipfs-core-types","version":"0.7.1-rc.6","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"9eb29106c07253d50121a5be1aaceaf62b022742","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.1-rc.6","_nodeVersion":"14.17.5","_npmVersion":"lerna/3.22.1/node@v14.17.5+x64 (linux)","dist":{"integrity":"sha512-1bKnqDoyAlp5e+2hgK3vQXmB+EQLAzUwK5N234jW+/5dB6lf07FxJkD3ZdqEwhKdULEbUOdtQk27uQEYwZ8/2w==","shasum":"1cec132e0691afd3cbdc25e1b84bd5da1b612b76","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.1-rc.6.tgz","fileCount":29,"unpackedSize":80301,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhFSvlCRA9TVsSAnZWagAAYjIP/11U/fv9ih1HnPoYusoI\nHAD5MztYgDdw4ORsZIVrRwLBdU7b30lWxy7UvQz8E2xwN4NXFzGxZgDxPwPS\nmyox3iU8LG53uBy1TxO5bNMsoZsURq5FJAz4wW5T2BFWnva5xCg95EgwJjgx\nSBi+261LLsA7F9zPxmqiMqKbCYhNsziLPxrPlNQ+cGOlssMuXqzDhCEb76gY\nkX/cJEjHkN9AIuXjGe7wUIXz02rH/zMkoCAbKMIzkP7N+qvCMT84R5OTBLnX\n9Jt90/PLIh9ZPnK8tsvnxnHi0rVOKqgObPcGFXZR4G5+0RPJjAXCaDqlLtVH\nN1CZ145wxW7VdIwSwXK0LxfFVvLn7RizMHD8Mr2s839DelRycqYYXHEVgSXA\n/p7IPSmlrIq994vpwhMlv28UmQytc4KSc1NEcXmxdxGo/x9gNUjC23ytuGSP\nGqMTFSdcqrueg9FyRS6iV8ztjvaGjk7D/2qQmvxoTVOvpGs4AIxIDhcMO/GI\nOYiwr5IImObFOFkGRQOyGldZ5opOYOHXVjcSpwfJGyGzHE4BK3bM3b9euwSC\nYcF8/kAuXhLyBSKA63QIHW5PM6GqQ+n5TeITl7wR6n0U/mOMrQ4HmDdL5QQm\nMLOvlp2NnBwCbdJW/E52swITdmoscGJAbl7k9BgwTQcjrMp3iSzz32SkOhKQ\nzdjF\r\n=C1z5\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDK3f0aTUXJWPPaSvfyY+RPR+y23/q02D4llztcO+gCRAiAzekS4pkR0/ZdzEfvQUDoLqSTvYNc6U+U/1//h8udFhg=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.1-rc.6_1628777445167_0.8960245448655995"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.1-rc.7":{"name":"ipfs-core-types","version":"0.7.1-rc.7","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"1fa4e8d34f47d1d6273b6d82801d324dcbc6cb61","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.1-rc.7","_nodeVersion":"14.17.5","_npmVersion":"lerna/3.22.1/node@v14.17.5+x64 (linux)","dist":{"integrity":"sha512-7Ow2ak93/WdjMMXMK9QSXdFVo51olLbJDz4m21uVDVc512nDcJNwq3Q5lLLd037qjwtMpU1jxW3XnlOKf68/Gw==","shasum":"9edd197af4cfb676f2cd35cd3b9b670fcf0eb36f","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.1-rc.7.tgz","fileCount":29,"unpackedSize":80301,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhGoh9CRA9TVsSAnZWagAAJ6YQAIUodsTa4quDnfxZMQ0w\n7d/GqPEWIf4S6MvvHPLCws67AHlZ/9jh76k3m43S56cz7RAxtbFqnixhgmg2\nCQfpVAR3o8xyDrsjNvwc1f+FB/dBu4hQ1iZzcLGAgn6NrQOctpiujd5pRCnr\nnfb7MY3w4uaiTqew80+koCLXJyhSb4/xDefjx5l+SaabINzlmo5Pfae6LQQ2\nrBSd7cK0FiSNJZKZYagUoyecBdltKZQ2oyBBk2VgY0wiYEMuQH7wrpVXG0UL\n9AW170jxnWT7K1cPh+yBI+nM0pfjM6Tuiaip4RzK+VrGLRXRS4baSg5VnKCi\nZBOp8i9ONyVeCoQGuAub3eenO0kvHRTcPxUK6EjBuEQ3mie1UppZcsJS2d+I\nizFaV9j7eRgPYIBQO0bIYyDBz8KZAF8zHZlmTXbpglLraobvcyF9+C7rl4Zs\nN235kjzE0LPE/WoWpWwLw4bpivVOpDP05CSoWxaALy8HkOKugtDypEc3jBKf\ntgShuXBH73cnwLqybb1+6dsjfvr/xK9T0aftC+OwSVYkYLrrOVl3HZT5y6t6\n/hBqvPD0r+uNzgEw8AnIoo5UFvCmXFHojq4rO7vfW7WhHRhj6iLu45A0+gds\nSIl+guLIi/SCszsi9Ozaarz6CUWDENjzvxF6QR/dOn4YnPW1iSpmrUYHiP8v\nvoLD\r\n=6tTF\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCHl7gWXhw+CImnR0wO5UK63oVJ/PH0P9c9ysNcc6+F3AIgHqYBytN5aj1fdIErzP3xFAIe5ZqlsB8nDvla7iY9MQA="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.1-rc.7_1629128829304_0.061109580095750626"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.1-rc.9":{"name":"ipfs-core-types","version":"0.7.1-rc.9","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"c1375617b6d7137e098375134097d61edf316ffa","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.1-rc.9","_nodeVersion":"14.17.5","_npmVersion":"lerna/3.22.1/node@v14.17.5+x64 (linux)","dist":{"integrity":"sha512-A9PgujVq9Xzfq+LCvPIrCTwY0KEYhQXTpR7xlQLAxp2PcQh/p87y6OY9yyzJg9+NYB32EmIoR8G7TXTqL3Apkg==","shasum":"17de7e28e6a642ee395c5d72f2381292755bedbf","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.1-rc.9.tgz","fileCount":29,"unpackedSize":80301,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhG5TTCRA9TVsSAnZWagAAAxwP/i2laucFRbqpSSiEW6zr\nvZnFZiKDeg7BxflvxMFvBpW/V6Tc12bgjO73h9cA1RDqBccjGSKnQVqeRbro\nEN3kM4vWJbz3+Aqg+wxcu/1VP3qg7tO7W6MbN9FQ/h0YgnH0K0HkdzvwJEQe\n0Zvk6EI0q8PGYU0ruLcXwtNS+h9AphbR42Bkuq0swG5nAhi4AEYVTg5IYEct\nByfM1d70Q1Kxe8+EhCgvb1/5cS83PwrNcWanxmDhqf3kzk3EJ/sBANF/PUmm\n2UEtEi7apBsnHfa1R/m7gJuSSBtZkFm22+Evc5/tT3/SMlOFvE5vkTjt8N9W\ngK55jf+z3g+ppInErnJ09Br0gJKZdWjzPjZgfpVjDU+382exIALRdgBknh5E\nIUDPaRTvQ0n7fU1ku+wKItXl2dk3b4VQ2heXjTDn+xW/n/vvhomxWQdMbXPr\nPn82XFHW/6UVryGFv9fmKWRN/wtn2Bosdu767GzMMQdulKgoqkMfIIB0DXtl\nTeeQYMuk1vXvVaI99u7PQRrOoRT/g625Zt3iYEmZy4Urwd6pcIrdiZdIXys7\ngNk9x7E/mcXCoXfk8/wptqm5kCHAsHxJ/qpaDibpxUNfMfB0nEdLrtJbWVm6\n3kv9qCxtfy+f9QaQLFeq2Po8fSHvjnClQtOQRGX/2kQ+40w9U6ZYOM70gWhn\nvrEH\r\n=R7qM\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIANg/HfB00zZ1IJu5NWRMzRxbTTTFHkNOy0wino///QoAiEAvVw1A23Qn7d7EYWG19Ehi4LZEBqaiuziELWwtL8Fnvc="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.1-rc.9_1629197522943_0.7546712894898371"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.1-rc.10":{"name":"ipfs-core-types","version":"0.7.1-rc.10","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"2c1a23af193a23c4a710a9007c7c22b4b729c7b3","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.1-rc.10","_nodeVersion":"14.17.5","_npmVersion":"lerna/3.22.1/node@v14.17.5+x64 (linux)","dist":{"integrity":"sha512-rlDqkqzAO7RdkBiRiIjBMSZ7bvlXVRBpBSX27SyFEtx+Bklb983JcdlQp7XTLteCJjG2DF+wmyeZaAFTRbVVZA==","shasum":"d402e1f543cbe4c04b79f2536984cbebc00e4ca6","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.1-rc.10.tgz","fileCount":29,"unpackedSize":80302,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhG5joCRA9TVsSAnZWagAA694P/17z3KIYhbBv3wwsCeWo\nxRtP8OXt0ectomzriQrjoLSeMqWbt0JsZ+y4br3gA73PqF5+SCmGEMDQoyGA\nRsvKUB9hjHYawtv5kI11O1FMp9fSWaASxYn8+Ngd750QYBzY1fp5RSmnCdZl\nJMF3dYD98zW4RMFh35Q/MMHtHikuQFqc4vOVxZVEJ2dDD7dBDHBN9w5HxxX6\nMSi6CXsWYxJE4EBYJXe4zns5FeaCpex/doO14KPwNWSrR8M+A4BiXjnTHB1t\n3USL1HtB2F5by7be80SA0dOYH+/1T2cqohN2auhvZhF3Gggg1fcf0fvAI7Bx\nQDD3CRx6tw+j/vyCMxV/Qqi+F4ZEYbHAtfki6+6EfGl3Z2MibcV/dtsjIxkA\nz6Bw7OGbgFreRN2XvyJIY3tcySUVXepF4VxRk0d7ua6Tl/GGuTE3y25oIAqY\npRXLsrrQ2AKJ5HE4MtLEjQ1u+Wat1BryH9EXA9GGrGhDbxAApx4GbGH30I9g\njdXyuMLiLyZgzp5kG4J7i4WVgUHRnYoRBK+X9mZsWYKvietF+Cd0GeujRckV\nKCmmIDve9OGOfSDVhNwPrtj+e0/otWOwa8IIX8a1moIotNXEwde5TRGtRsZw\n/IB1QyjXXnyiJFCXRpj9CYbRzr/ED+y3pNATJ0KR8pNd2JMhXA3k9iAEZZwn\nt2M+\r\n=7PiH\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCsXK9/3T+Mu2cBVlLD59LIP2o7pJrlICtRPhf8XscyxwIgIvGIalSHHRg+chy1ruQpL/fqDSCA0depdwtfxdMXmKk="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.1-rc.10_1629198568366_0.9923778545969755"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.1-rc.12":{"name":"ipfs-core-types","version":"0.7.1-rc.12","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"438110ca4bce91dc771eafd9d6589573801b16aa","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.1-rc.12","_nodeVersion":"14.17.5","_npmVersion":"lerna/3.22.1/node@v14.17.5+x64 (linux)","dist":{"integrity":"sha512-KvymdI1YczvyY3qmYZR0J/Th8NYKvCOL54DGAWSJ5CaBvBnjO7oiBNCdLvLwsDViuOBEkUIgNnqGoBaeCYaH4A==","shasum":"4143e97934158b55b98b2b6a24b788309c521fe2","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.1-rc.12.tgz","fileCount":29,"unpackedSize":80302,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhG7HaCRA9TVsSAnZWagAA98kP/jMb5Mh/lIbOCLzGmo/V\nZbbGUwes1H7eSqCMTZz5vqxQonBMESoR6IONu+2DA/FXr3nydQIlRnLCeNgJ\nMVyuRdb/3eIeEBFzXIWd8Rg76EMX0cXBkWxzZn08MPK2clG+eotSY4bqYy3/\nCeqGVJDvJVMRZrBIOLBwd9QxowwH0NrteRpFmoTynZcV+QZZHcVZreOXtbt6\nRhADGPInyZhXDAHFflW4smJZo5BuqA4QTI3Y0AywzmgUMnB1yTdSZfTx4GzS\nxBLLaV5P/NA4a/esZNQbFw/FIC/ExJZw3Ivs5e7ckhVYQhiySEy2fwHsU+gU\n367ZW5QqXUajgvRlWP8Pr2C95UugNL6LDv6ppqJugnHNQSGYzyifsmARCqnV\nAeU60irmlQOSgU1EucqWb7YIznimM4/IcUKRpfKP462coGcl+z4yeTWG9Voe\nIug43hM8QdajHz5QH7rG2pBKmSFM0joT8pKf7PXp/NFljLoZhrK7iWvk11SS\nv5gc2t+14rSw/u3yG+OeX5v8Juj58HIg1K53/MYhgMvjhtE3/f1yvgbaU1Nx\nVYu2TrqcdQyHcbs9PyOHOqit46HCxG0KegDjG0zBKhjDSbVSCXvg4O7A66SM\n+2TLt9AICjiPcJufYBSyDLqN8JjQpguX1ZKk8ktSV8kaxUBbiLtCtRG6ZphA\n17ea\r\n=SwU6\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCi3irMBZO0UrKqLpccLw8gtNKaMRrjXFEqqZx85XUZDgIgAWJD4Yp+BTg8eeU70vIj6u5PY590wWCMv8BZXQcMJ1g="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.1-rc.12_1629204954064_0.9247675353501765"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.1-rc.15":{"name":"ipfs-core-types","version":"0.7.1-rc.15","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"abcca0453a2b769464a46b23d1f45319d62d0aec","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.1-rc.15","_nodeVersion":"14.17.5","_npmVersion":"lerna/3.22.1/node@v14.17.5+x64 (linux)","dist":{"integrity":"sha512-fL5t81ux1kNLPklqblwPIoZlXQ3hB5xOvZMUcBuUmAjYnHPaGG9UdfFqVwo41QZnu80jC+QDbnUH4Wg66rh0TA==","shasum":"3f5c3594156b9422fda2f955505069dd3df1d7f9","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.1-rc.15.tgz","fileCount":29,"unpackedSize":80302,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhHDBnCRA9TVsSAnZWagAAFaoP/jwcjJH5XU3d7xXnBGWQ\nz51hUI4cNsxbSUJbASemukdQJH4do+inbHTa7PVh7uz0UWBtFIe4IluNgbB3\nyvbpBTDMFH4e/V0SG2qPpoJBQQdMjoQFsCtw6rcax02jVIJfv0XpAt/1L63B\ned4QW7QOpFQ3KPKpvY8ZKWwHQm/ulwfsZk3LhSUnRDRwaqRRD5jJcyNwYSOE\nSfbTUUGinkl1rO6GekDp7nNWBTkD9Er+//bcnSAtx6ov8PLyyk1T/8wclEJA\njZTvbIysgwGRJWOn/ITPPTFfODqlN7Frb8RQSRueKrN68lDIfHtiZcPq+OV/\nPcLzBb/pwzd4b8RsjA88IhJz+TUgMXwOn21YtqPT7bodoT3l4P/n8AfSGvRp\nBNx7OaQn+5X2ualePcOS/hGuwCYxQ3y0fAN5XwHNY2kXnmdZiyf87iSo05i2\nlxE+w7sSFv23KiuiiSUoy3hz9JxAs88/1m8Bm50hWfU2ZD/8gIWE1zcWJDAj\nrtiKcF8CSK6GKTuc8J9SsgJkZm8hcWZ9nM6Xcc7fwEDNlIfyUBK03AHRUiEJ\nMFCVBUP/ILDaMjUlSmIRAXV8aFIAfxWC7GEQk6jqDqgiqRKMqdHbpvBNimig\nr4t4dxfiwNpnnesG2Mn8rnr58sH/7K9KMS/cKsHcRw+xaPB4elgSDLJkBZJn\ny+ah\r\n=bdEG\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDVIrkuJkUqPcon/nSU/wdRouhQy8Pbj1LsUbSPWZmSCQIhANYNCDg6Pax/DOIxWtf9U7zgtBUsh0LR6i0UPrXi45ki"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.1-rc.15_1629237350959_0.030016132522760586"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.1-rc.17":{"name":"ipfs-core-types","version":"0.7.1-rc.17","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"beeeff017ba49c3a171d8990389a67eb5c3103ae","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.1-rc.17","_nodeVersion":"14.17.5","_npmVersion":"lerna/3.22.1/node@v14.17.5+x64 (linux)","dist":{"integrity":"sha512-9/ZMdDXVwAZn1vx3lKgUIAT+J4F91ai81PuqVF9/EDC6EkfNT/2UTyZmlmq5FvS+tubVcBt7BOdxZbP1qT6kfw==","shasum":"9ff5218449788142769e4e1795b89c272abdfde1","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.1-rc.17.tgz","fileCount":29,"unpackedSize":80302,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhJfIECRA9TVsSAnZWagAA4hgP/iOwHiDBLsrfe2ucRwXO\nOPEbdMq1KnRaJFiNAPBXbgSCFqgIdLUgkWbtHkP5gWM4vs36YxfajLtQqri8\ncvqoWALCg3YR3HUuncOxaecrMT+6k0byQlaDqB8KqjBJwwLlGg734GJGz9+e\nzKhCF9V7SbDcqEX3Js6ziIagaKmhJAUdJoI4JCHQgJxdAU7FrWmk8+cRJvcI\nbpsbG4sdtSyHBButKvPCaH41sxP2OjdYjKk1t3qr+Vxb+OVKMRshiJsCmHxQ\nvblBAnErj6ySiDRAflh6mHu+olgYvyg+N/bkEI5V7ZBy3GBUvuGwt7OwcnKp\nDAAPKmkKSeEqIobowWNVm3Z4ycNwYFzmelnUXdqAwO5pNzJW/70h0wcNcLXO\nqbA2CVtb2gGt5gJKFMgrRVwfOnwg+Bc8Ay67zQ+4t4C5mNVUgrFCHCtXGSq5\nGJFJEpDxcAZfhR/9IXCVQDY3PjKrfdyCxgEFGzseEBN8/YwU3pRYRkib6n2x\nvGfjbkEMz/xQ36OuMf6eDhDWT2esPmJViEDujDty/NfUqEqKKrwph7wmE/R3\ny7o6MbDBjCu2Gr51zvVfajkrZaqRC7c3GjMiR9LdxCbioTtiwGx/X9dzAeKm\nIDdaCJ/XT6UgLhdY0UfmCa3sTy+gZ6v8uixifdvqXqxTL8maio4kCGyHRlOq\nU7u1\r\n=gzno\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD40KoVUZmPRltX0MztU34XRdP2cPVSWXc/BIijHnMZggIgDrRu/bQeUW5PrLIe8+lZcg95DfT0uACAdWGqWg2ZAwY="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.1-rc.17_1629876740497_0.020326540014571126"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.1-rc.18":{"name":"ipfs-core-types","version":"0.7.1-rc.18","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"aded7dcd65896586bd46024bdb562c9646056b7a","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.1-rc.18","_nodeVersion":"14.17.5","_npmVersion":"lerna/3.22.1/node@v14.17.5+x64 (linux)","dist":{"integrity":"sha512-TlJs0ggGyDe2C8lhQmGtnqbYEFJTdIfI2XT0S2S5W39QP4FauiWMFjKJvfA/swdjy6lrdDCocoZGGMuemW1v0g==","shasum":"8793fd5727e22571f19a16e65b5e5c075650f1a8","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.1-rc.18.tgz","fileCount":29,"unpackedSize":80302,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhJgTbCRA9TVsSAnZWagAANccP/iN85+MpG2LtOByaxrZ2\nOFL+AYeo6iRKvYvJbzVUGeusb2C1oJ2tJ2uMx2WijoH7HpMJ1h00jTl+ftIe\nFlK9w5JP/PtuFNu7fh1pOKrtmSNcGL+cB1W7KmIjBUvRiqItLk1Or70u84m6\nh62IWj57n6v4iFW1uCRJqvhfkCikwOzqjzNFPE/gMnKAO/RbxLAmR9TMoMHy\nbWV/PNex39f7AhHpDCXF6jQPlhNtsAxNHj8pki5rZGVlzVJl0U8j5AxycfSW\nNW5PBfbyxcS+EKaMAFO+x8cAKE3vYfSTLG+ZyhlfDrN/65Nn7SJLUA73ulRR\nftJ1GhigJcdS/AkmMEbk76qU4VMauEvZhYrqWgHljsmV6ftY2nfB6cbXsmjU\n5fp6wZLGU7itnTsvmjOCEvXlx4tQRBAMY/EHYLAUb565d2NUxdPz/QP9Xhhn\n0hNzogpojK1jtLKUxjKkeleqGbtn+6QCIBd1twdx/HPiJe4EfCHTZJZ64Qbi\ntSsQiLAn8RorDEAVLOz6n2DNBb1EBlIJ2YAu/vH/b8ZH5biIyWFMZCoODJrO\nucB/QK1CecVvPz9RQv7Bhocp4dUa2yIG5dRba1/nxg04ki44qFCNJ/ej7ACO\nZC22LgPg/6MLbKRIlKIp5XZ6GgkB4DlsU8DSBT6DAarTLx5vvvnWX/F1zRDW\njbSk\r\n=rYgM\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCBIVePibrHSt5ndiVoeJnWT6a6QtEAnc4rSIt37kR/+AIgM9lkDFmrd8+P7dPJmLAItrdO2u8yEbDMKTYu++Jg19E="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.1-rc.18_1629881563190_0.1539283380173404"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.1-rc.25":{"name":"ipfs-core-types","version":"0.7.1-rc.25","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"ebb6c5528eee66d07ee64c4ce105e9b1228cf857","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.1-rc.25","_nodeVersion":"16.8.0","_npmVersion":"lerna/3.22.1/node@v16.8.0+x64 (linux)","dist":{"integrity":"sha512-wYwChHKFQURtSbq/0EDmLfjmqYSQFktE/2BBzeuKmEVDMwWsWw7Y8W/d36rAfksUmL8eXO6m3aCsXR+clwdLYQ==","shasum":"361943db6de48412d080422f9cbcc9278e1b499f","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.1-rc.25.tgz","fileCount":29,"unpackedSize":80302,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhJ2NWCRA9TVsSAnZWagAAx2AP/0cdEwJj4Z6OBGyBi+2+\nmzOdcQAilpLI4hjQl+iRnEsVEaEPe7JEu0Zf9LgylvUI8mwm7Kboax0wVWch\nILkklxTHwrG7K0TdW3+nV5KzRPnkfJQJFalbsxANhAP3kGGlR5kGUmgkLVJJ\n5fqEsLkFj3TXArsGqBOFqoviN6XOd6wq0QdukK/Vx7OxKd94sPFQkSa2NSRT\ng2hhLv8udggvGLhUAI08+na1OTauKKVklIO4TampKJd/MoqlS+tQKhcYq8jY\nYi3f8cHIty08YO5a7wETQU0WP6n5Ohs7LBCxp3II43wEOrNlRoKjTfNE0bKx\no65k8bn0gu15ZMIRy/LB2SOzISGztRqBDdTEfp/4SBHBu/nwc6BkswiKoI2q\nz3YwB9ZEsyDFILOJdbJAkiXbOBFSwLOF8UFikShu8WrPYAxp8rcBJnDgi+p2\nP2mRa5AdSDYJz9jVx8NjFjQuUvxvxKnKHoYjNYYdkegKGqMOC3cjq65lrkOG\n8MDjBAKAv0N//ai3Jq6aZ/2xBOUhyg1Um6eQ4/tZNDpM5w2Zw0W7uMnSgVV3\no25YroqsNHIvoaHrlzIOIT6niXb52dX+TTRWOAx2h3c9BMc899baGBtaI3en\nNrH8AsF2EXG5SMAua1JukHL7SD0xB+hQLgzSzZMLz5lCX2p8Pv8u6jbueAyp\n+cIC\r\n=Ofyy\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCBXouT1dJHJhrw7SV0MbPWtC5O5qAInXH3x6wQl0R/8AIhAMuvhDEGozCpkBHBTsOXRTxL1UlL0dg+vW0R7lMcpM2T"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.1-rc.25_1629971286311_0.11052558485363795"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.1-rc.26":{"name":"ipfs-core-types","version":"0.7.1-rc.26","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^34.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"6c46a3cdaf6e9f8756632e501019923a01503282","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.1-rc.26","_nodeVersion":"16.8.0","_npmVersion":"lerna/4.0.0/node@v16.8.0+x64 (linux)","dist":{"integrity":"sha512-PfuOoSoQEa9j6amVHN3+EtZftep5RoLgmiGQsZG8SHthHD4FYlRfrPFffu8igvrYVZrnnHARzHZ+E4vRVt7WPg==","shasum":"95a3cd548ed8b774be46a623f3e5fc4678c697a5","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.1-rc.26.tgz","fileCount":28,"unpackedSize":73191,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhJ3aHCRA9TVsSAnZWagAA8EYP/A0nEOQmAo3UjlnBwq3D\ngqL8W60SGUQw+umQjVTnaUhfnJ10Un44eC0NX9BuLbsGvuTZywhbL6vnVDnS\niaY/nUiTvJvSZENeHvpzrAm0RKF/0DhGdYHZUxtMay6PPO4yNIT8kFPp7MZ3\nF6JLmv12t4u7xjjOul3UPjaurQkGtbPujrmlu27a2syszLszkm4UJFDnZKzf\nmaWb6pML0NbNrWh2DQtZnyxcx6J+t1hjO+OxpHhw4WDAVqt1vE2gOszC02O7\nngtR8Q3TsqyYfUP+tQcfR3qvFMWVXRQO6L/i+Yh0bxUQhr7dcbPQhzKVMM35\naC3XzTzMiUxY/7i8ufB4t5hmLGUa/l/ojUsweGPWoFXRIDycWTf8X+SyD/ra\nwDe8OFPSvhOlDo7o7Jl0pKzvlSFXsYGfaHN7JHuuuFztpvTZDpPo1kVF01Dn\ne1G8g9v9bF4d77i9EeWaWtb7KM/lapZqffKFEf+dt1frG47Lv2xRulsdqYYa\nfp+4z4aJa2aGUVH3BX2H2X4yTHvpAe+Mn3Q3AMuDzdzJNW8LWsYPlSiPLT42\nza3gcPNJ6hdHQv5mhLywUS0K0je2TNCXWcp49v61mlBW8+9sL3IwwAaq3eC1\nB9T0Ic9yFV7KkHe2oG6c8TnNgypzlTs5o/OFrQM0aKSy+S4iTkBRTIW42JSc\nU+Az\r\n=AB9J\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEnPU3eUoJ7fdix6BLNoOxgHZQxNO9HZP4AM/HRX/ffQAiEAhs9tT93jwm92Aw16GsT5Lw0J6ANdyinVjd5xgyy3m+A="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.1-rc.26_1629976199362_0.3062936664398703"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.1-rc.27":{"name":"ipfs-core-types","version":"0.7.1-rc.27","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"1ae25d01d93d192d8242c7ee48ba338064ac9e03","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.1-rc.27","_nodeVersion":"16.8.0","_npmVersion":"lerna/4.0.0/node@v16.8.0+x64 (linux)","dist":{"integrity":"sha512-KwmGATfXZIJ52U/9k3v4r/eOLndEgdBkFG5kAHOgVIlhyiegO1bLnaDhxyYXLmlsYeZ835hsTRUjQzpMIzhE/Q==","shasum":"7e1cf3ae354e5f8600b494864d9a3f6f9100f14a","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.1-rc.27.tgz","fileCount":28,"unpackedSize":73191,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhJ53wCRA9TVsSAnZWagAAOqwP/iMnUdhpLN0WAfDNSbKh\nvlKP1kf5hModFUd1ji6k1l7CUbMZppDNu/NHEIYST+Q0JxW+JssxKCeOdr//\n3g/GVL6+esxN0XWJCDXN6cVUMtPGMT3pw0gO2vEXUFUif5umSdlaWVwzQB4h\nx7sRv9HAIa0h6uRnkU74xH8NDVy0EQTnRHPqJZcTSxMDXNyMQlhs/R4lcXMt\nDv2M+xd22VlX3jkl/yGXqtd+75rP9vTd83weloS2bmS2ibhU16HFbxbNotpt\nkBUZv9iPOAAvQe/2D1C6hEgJgaFllvu+o2gHJESEhqSvyrdHtsnbWLv5FsYj\nUFrm5fuEEdsfsz/P2Ui+Jhu+Q887fVMlqSRJJXUezNFy4zZfEOLyypyEvE2V\nuVFNaqFe/+ROojcVdp1BQ6fct5JJPmXElMwR71hN4OhkBKB2XLEcqBN9VhNr\nGVqdO8PgCzUf/4RnpuwPuEwq8KR6WB83GdyrEz6v1/JgzhOjq3xz3+qO/F8N\nZ8mRmIt1FKhMAWhAGbc+t/d6cygh7NUlIv1c9UNwwDMYR7RGCuOnemSMPDbo\n1xziSH2nycesSgLOIbvMu/ccpbmCuUkYagFg6cQe/B5C/nn9IlESxylmRHE9\nmTztpU4nvMfLnfCd2lVEO9cJZ00ajzQbVMblvxfkhUl171l8I0biuR3k5K1A\nJBCV\r\n=5tkb\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDshyg4QeMJSPCbXNwVHNk/IqT9k1VjAmRk1EyuVD7l5AIgVJ+eBx2JMME4j8EN2WXAw4LcLAouYPtvRtsw1qFRqhc="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.1-rc.27_1629986288640_0.15560124195206027"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.1-rc.28":{"name":"ipfs-core-types","version":"0.7.1-rc.28","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"6737f38a27cfd7a7fc44afeedb1a7465cb17a3c9","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.1-rc.28","_nodeVersion":"16.8.0","_npmVersion":"lerna/4.0.0/node@v16.8.0+x64 (linux)","dist":{"integrity":"sha512-MMmURP14m1/c6GRaH3PT9y6nlhWz7fZFQO0UXEU0SjoqW4y/R8MFlcrAV8nw4LE8wucj3c1+6ODCilomNM63lA==","shasum":"90a6935efb8be4b05bcd3293c010fe47352a99e3","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.1-rc.28.tgz","fileCount":28,"unpackedSize":73191,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhJ7aHCRA9TVsSAnZWagAAk5cQAJuepmvnfByhZC6Kfs+z\n+pIf0nFv0L0K4HyKqfI3Yv2F8baVQZ2XwYZJXgd91krbN5POjvF7b1EaNFNQ\nUCCL9MgqD2oFO9SHCz7DP0w3O4vfWT831eb2DYBVMUVOHmwyFOrQf0AuoohL\nP73m8BG9IELDjctvS6lZdyHLrySFfi05HoFc3V/SezwRipa0Uy7huC9poLYx\nSYjEl/NhC1jr12Sy4xj1OwrzpXuot44Z8GeQgsJrm1mi0vVvGJveecL99sBH\n8LLGIw/I8V54yFrk7bA1P35xczBXspfEDqumzeIKrKGMAzQNT0+XvzXriN0F\n6GkZCTTg6tZxaLq980egMhouaWKH4ZSLK4uTXFB9ba0W0pcdBVKPDMC01Lwd\n7mksi9Ilp9NNMsoz4ULyfOfdslRn9rY6+CipyF8M3WIcCO6X2Frd3t7nmxKP\nO1/qQiS5/m2fBtxhO/dzC/yMudl5W3RmSTOhUn5RLDl/AWoA8OSe9jgCPDXU\nu8IPL8isjtgnbN/cPUdtpup8LwdtQo1ddWFZwRcqRE8ymam+hQGbDiTguifH\n2gTRh7Yda9P0sxz9QN7oBYqCbR9veK6s/RvfWA1XsZDJFhm+nTNe74ogRe/1\nkNtGHTFWEXplITp2435mEH4F6+llI7sr+5aPy9Iyrpf0hlPFeZXm8SRwqyLe\nyqtP\r\n=JSt9\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDDF2heYmgBqSMdoZkG2MvgtV5lLsfnkoWWA5eoQppKvAiEA0VRgidO2K6d/u9EEQnSOZ85RDBj0Y9VNT0pE+9OcA/E="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.1-rc.28_1629992582989_0.18916892254127826"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.1-rc.29":{"name":"ipfs-core-types","version":"0.7.1-rc.29","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"typesVersions":{"*":{"src/*":["dist/src/*","dist/src/*/index"],"src/":["dist/src/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.0.2","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"100f54f5b6e29ff64d9afb9c2c326707c5097cb5","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.1-rc.29","_nodeVersion":"16.8.0","_npmVersion":"lerna/4.0.0/node@v16.8.0+x64 (linux)","dist":{"integrity":"sha512-80954qjrjqiddBO9+YPzh1ydmCCtT6fX/bzXRS8iPXaOLboP4uCP7uanluhwLugHvvVnNJdLmmjtuhyOClPcNw==","shasum":"e7f2f5bddc276b362687160c112c800276530c35","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.1-rc.29.tgz","fileCount":80,"unpackedSize":189573,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhLi/5CRA9TVsSAnZWagAALRMP/AwI3gvRmlFmkHHCWaht\n1gss5vaCi3AHOlDu6twHOGgM/yNp+mmN+GssKXUATcjqJLvMLWrEClALOjmg\nMxTkh9VX7uKlCqWwOMZqoBp78WZfD6RRC8rZ0qOIsNsZ2b4mgoDtsm778ftg\n6CpIgcGJI2EvJ6cxzU9N05STK5xTi3lvUu6JqjmcSrgoNQMHSqeIpPhzjiM0\n2U+k+jwVycN4WJXt3V21m6NqVZe7wgq9AxHGsqx/m3l1oGr+WElUVP7ttmfM\nW017juxk0FDshTHq2N2z4O/dLs1gFhMoXSobuBuvaWjqj3IP+DphAyjCBIH+\n5muSu10NFVgOml+hkMSbQkbz4Y5IFQnpwZZVlI065Y152cpx+WdNPTHAP0Ma\nNRbwPbbKzP2mvTRCTeYgFMAeswn/JioJLPwSmajote6DtMUaYA48q5PkDaJt\nLMoFlP9r0WMpzcxMmZlU3+l19M+QsbtGNrcglNbfCY33IJU/DjU8qDnkcOIk\njvD3gPvOLn/XAQQU0GObAiE4WYkn3GRP0wBtMGvbZJhtABlEnWYpzDBn/NDi\nrJJc63HZsQmM9pq+xLdozPh8C/SMi7SDjAp0aBXj4hOSoaXBZJE+WZyXoXOf\nMg0KD/A2zm42LRQPCiIqzGuagodI97T8qsCbKmEfgJLP5oWXAOhsrSfGXR0g\nESjD\r\n=ddwO\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAzkHOGlS4Hqgsx/Oq9JpYokRZOQTexghYtKdMwnkGJ/AiEA02sdy44imshTCXrZ8DAPa9bzuqQGLV+vTAfHSbzGmZI="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.1-rc.29_1630416888937_0.1354723453307911"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.1-rc.30":{"name":"ipfs-core-types","version":"0.7.1-rc.30","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"typesVersions":{"*":{"src/*":["dist/src/*","dist/src/*/index"],"src/":["dist/src/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.0.2","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"be90089554b3ff3d7adb02e76076e5cfa1d82572","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.1-rc.30","_nodeVersion":"16.8.0","_npmVersion":"lerna/4.0.0/node@v16.8.0+x64 (linux)","dist":{"integrity":"sha512-g00rNT9grZzNAj/UmMsy6rHzFqh1pvhj6KUa0phf4m0aLVJL8ho9fHTl6K2g8RlDQCskMrWrIzdPj2SsRuxUpQ==","shasum":"42f9f8b550383f87c568e5a8ebc0f3fd53690c07","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.1-rc.30.tgz","fileCount":80,"unpackedSize":189573,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhMObjCRA9TVsSAnZWagAALXAP/A3xor2dZIM6ISQ+UPMC\nZ3HmwRymVBMmJ1s8Iz6bEotkuqLw/kxTHqXkDzGtquOgYhKBLDkhWUTFriw1\neG2E9HlHpem4ESC9jicotaqk5gsuaBEj0+ol5U+VgmgRSuuS7pdjJnAckL3F\nOaXTTOeH3BXn35P0niGV4h2MpKqjLC/DdxfQ9pXtidVQCqqWUr6Sv7ff7zGk\npOlmNIsFLIt0TyCyTXp5p3sT+I4+jhYs4kSw5JJ4vy/mngMTzmOwHucKSh9U\nPL4Tg4NYf10N+Ct5xK+k9h7FL+vMIFzjC/j2Mly/LDL2mNAk353WFAc9ty5e\n/n6w35/NeaaY1PMSEz4rqCRnNTnC1S2wcPQdSVwqd7LaZTtikqr7zXNOnKsV\nwA7q5VUwYdDQSTDzJyxlE2I4zF6XnqBxi/VEdm7cUXHASoZ2DVwTVmq46XjG\nQ3YmzUN+oa4kdKFpQOH2xMH8u39g44pKFiSscZ/J7bYrY2NmdnnzjPesbr/b\nEVvJNKnBi7ju+nz3M7IU1hSBqt2xRKZAMeiiIbhS8mMX1LUw4Jy0oACcnMYt\nRBtcyaNG8UGN/Cofw9PTyTI4+STUKZhuw6iioGbmFVBuW0coKI/mWnUgi9ox\n0U4nCNz8bPhZiQazkDFkEP6TnWFRsVlojmWO3FqJehWM9DEO3Rw39DmaXTx6\nEnlJ\r\n=rG+U\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCvOGyCoT+X32YsE6mWvIml8F6RKpEGSq6H1UslOeXyqQIgFvEiM6+TJbSgtpF5qh/XTu5ajRhPQZK0H9gdyea5N8Q="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.1-rc.30_1630594786999_0.9996048613182673"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.1-rc.31":{"name":"ipfs-core-types","version":"0.7.1-rc.31","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"typesVersions":{"*":{"src/*":["dist/src/*","dist/src/*/index"],"src/":["dist/src/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.0.2","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"c4f96faca331a2e0db2d6de35a804bf2b9457c80","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.1-rc.31","_nodeVersion":"16.8.0","_npmVersion":"lerna/4.0.0/node@v16.8.0+x64 (linux)","dist":{"integrity":"sha512-C03WBkn6MZgFl8kj+ftAFJpruHZhof+3/5d62Y5EItQFWfWqebWJEik6y8KXju1TV26HF5F65IArVuA34uAG8Q==","shasum":"e7e2401cb2869a064e2810a19868d70911e05860","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.1-rc.31.tgz","fileCount":80,"unpackedSize":189573,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhMQwnCRA9TVsSAnZWagAAh2EP/2i+IePoNzl73uXCQqGV\nMUx5xcswR5HA4EJ4l7ST8OHjEX/9Ka3o+4xzAS3W++IpIT7FOFYD0qNblpfX\nxDkokxHPbq9oNrTYj3ihWKDoFEXm2b7ceIQHjkYEG48DFm6MB+h6SlnKHjAd\n8/yQiHOMaVtGCM4QydiuLyCK7o0g8yN1H7ndvihb4bW/puIb7IALaP41AEMW\nd06FUKg0lQwLvL3OWIIxRRSYh79ZD+xL8fCoN95gsKrWy+PauUxIcbxTzmTu\nC//8dVO/FDyVmynEBD+D8oyAvucygD4kyCrYPeQ5ZWDa5jhoe0BIXoUNsfBq\nPc5s3+l7T6zLMovh9B+NSfOFlsOVHxmnZhmDQpMUS4+UoMiisLNMDWtkQKx8\nVIgTZMiCHiIyqFockFPaEbZMatcBa/G7Gor90Z6+R/FRDhv0dhhBQBDD9Iwm\nAhE5LoqOtCRCW6jWJXjOO/vrDenbvNPBHqbzZkRpNQ1QFnyD6S0kJU41SpVK\nNCBtniWDe3HcdHKfcsDHoZ8r6nBcWNugvFK0ZQdf8Hu1bqqhUOUC3u1BXG5E\n/pId2ydR5gZ/ItbIhCinh/hE38PvHOaW1WTT1SNVN9QHLPbGsEZgODoApAOq\nR6sin65uNs84gmBy2Tchpb0WwX2+MV8Sapu0jbIuwK8qCN3dwTN8b0QSXCLO\niwi9\r\n=uEsn\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDjJrCrMF1ZvDQhq0vfTdDHfltBJvpcv4LEE7Vy99PIhwIhAN899yf6tw/YfKwsMCe4v8Ofn22ZP4SMeiV3EjTWvzKA"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.1-rc.31_1630604327074_0.2385573553518905"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.1":{"name":"ipfs-core-types","version":"0.7.1","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"typesVersions":{"*":{"src/*":["dist/src/*","dist/src/*/index"],"src/":["dist/src/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.0.3","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"9d92e8079694dfbc7be262021cb9d41e6c5e2c07","_id":"ipfs-core-types@0.7.1","_nodeVersion":"16.8.0","_npmVersion":"lerna/4.0.0/node@v16.8.0+x64 (darwin)","dist":{"integrity":"sha512-vG3cX+mLjULYAKlGF/3P3uqr6GxhWZRrg+LQrUUZmf9kjBI5ikIuNnhtPqX6sbTNHLQFqTZb7NhCxFFNOud75g==","shasum":"08504d3b2b65fb910516f310049a0b022759ad21","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.1.tgz","fileCount":80,"unpackedSize":189558,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhMRWJCRA9TVsSAnZWagAALK4QAJ3A3hBcefzvc0Id8hFH\n0VanMhswo77aR9jU4SIeEcovwSENT4MPqqRgoQd7EZbUaqnOzYwNoBv8gtnB\nKIFTdD6sht2OeYt4XT6kOima6G4+lY8BVclpkV1tOJI2AIwUK5lHR3+LmJ/G\nW+8J0FA39TctrogOzgIND1cneFsL/PkwyANMTGHhf4/vn8rkgDSirS82Bcsc\n7hLP8gQ7Ydj1lAYTAJ1CNK75+gD5MmLc9oqvHVAYn7wwjzdIcxu8ufFhTF5Y\n/iF2Y+UOQ1SPoSAz/dN6N6uiyErG4g3YcvXwuq52CCrfWMvkafd2sMm9upkz\n4kLqPzr5Yk5cJhJeJhD+ESdP5Hr6v9qCswQfAHTqBQDP+E29H+D+/J2C80TU\njqEPoyFtKNg+aa+hknz3qeC5+cylpCmqh4sCy7LJp6QpnI4wO8TPm8itjr39\nS5r+7+1Hnddo6/7H6GfrQgbri+Sfd5op0RJkJuv1/9OPfiTQVIwnszyiYh/H\nOzvJtGTBY4AbrvPWNt1EOlCUBkA+FckKgSkTix03NhcYTBZUJLTNr55ylO5x\nZSaGQbGQPSgGjY45dZnEGkEG3CLyBwwJ6LUNS2uzQqrkPExgs29aHC0G/8kf\nTWZKRsus/tl03HEl7TA1sdpPDQKxc0q4Y61qedn5KCSZcItKFRc6tdihJSY3\ngG9i\r\n=V+Gd\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDnAWB5vtIfebxSh4VW/suamK1lUVaH/KXAsmFr2r77FQIgRIPxXE5+ca47sC69rCTONPHLNwSza4gBuWdMlZoof/M="}]},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.1_1630606729629_0.6807888845811316"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.2-rc.1":{"name":"ipfs-core-types","version":"0.7.2-rc.1","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"typesVersions":{"*":{"src/*":["dist/src/*","dist/src/*/index"],"src/":["dist/src/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.0.3","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"5cd78e56b8344b3f71fc7c578c4a50d92c25f0e8","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.2-rc.1","_nodeVersion":"16.8.0","_npmVersion":"lerna/4.0.0/node@v16.8.0+x64 (linux)","dist":{"integrity":"sha512-ji6kkPFDfBw+j46TWg9McoY7V5yICGNHr8dg2g2eQyxkamxI8LQNZg6wmK8ibMTgQ+j1K6f7c6aHMo16846oCA==","shasum":"c2e40ed273e6f43dd4ed00d3b4e0665e22a62320","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.2-rc.1.tgz","fileCount":80,"unpackedSize":189572,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhNfkeCRA9TVsSAnZWagAAPWAP+gIRVRRRmt44KX+w0iBi\nwrntvRmvKUM9ya91PzEO68zvUdq5vtQR6X8+9JeeyPzPWTE0/hvEf8wnmFH1\nBqtC42YiBKro1m1FcdixheFhN6kIi7rngyme3D2tnLDIOQJIph4yxKW7V5qH\nPgyIzp7gIs3FKexBE2yiWK845VNfpjhOooUKVgJ39akuq7XGMeidgGEl0x2i\npIhwDu/hFMhMv3L4gaFlVhpg6XvLbw0ZsjCSHgLiqCI1IHTJEfDM/1HsmgYW\nV0bqJkDeS3N8yWTKXK9XEi0Y4JAY6Oz2KFIzyIHVAKfmgBhINyKxZV9ofM6c\n3WzwJE08uJlKcd6opSwzUFKfENN7aHA7Q/y/sGIeTTBk5N3PBJDTquVfU8Io\n7AQNbmzIXXg4zRysWNoEAb5+wz7Bq56YMX5DzsgeaDlBY/ATpSYT6OC58iXk\nKMEXe488Pf5q3iLpWDl6JbWnxVdmifzCAfsLitGLR80AWYOirNpWVd/Mo72F\nhnc1+4DFW4CeC3oKR5uXMEf50wdk7nXKHuGzK0KkN/OtJBK1WMXxHDCNaXrg\n4jFdp+Xky1QDmHdQxUK4IbrGo27kMY7LApNrNjzEAB2gpxiTSt//oUKqqQU5\ntGQ1WLwQSX5mOicZ/1ge7ThZ/KWlqojPt698Oro/jF8wcRvP/4WGKmP+EFOc\nSjOk\r\n=eIgC\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDxiZopWDzBOT3fbGtRuFdf0NSasI/GS07bOqT/WptUDwIhAKHlR9iUeWbKaDsRrwravgfJRLGarSseqsrB7SGFaSaQ"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.2-rc.1_1630927134372_0.7003189685815265"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.2-rc.2":{"name":"ipfs-core-types","version":"0.7.2-rc.2","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"typesVersions":{"*":{"src/*":["dist/src/*","dist/src/*/index"],"src/":["dist/src/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.0.3","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"2be33543a07c14a604fd484a481032dd75fd8235","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.2-rc.2","_nodeVersion":"16.8.0","_npmVersion":"lerna/4.0.0/node@v16.8.0+x64 (linux)","dist":{"integrity":"sha512-KmIfXJPa8srCyUZ8lylOtRWZ2x1bF5FG/ayPJAM3bPWKOKW9cxKdYioNAhljd4xMfVyD/LQ7KMKmADhS/Z2jUA==","shasum":"7dc3f09b4ee928f48f761960f38ab706f9f1972a","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.2-rc.2.tgz","fileCount":80,"unpackedSize":189572,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhNi1oCRA9TVsSAnZWagAALQ8P/RBOwRMKoZURxd3f0ur+\nGXj8aoslTMhwlxcJrdJu5CCHuHJKQRVLffaGgsIvfKwmBxYByS7L7kWIOtJ5\n2ommfoNAJwH64gqBbeyPR+u3qWqyvNzP102uz6ZOak+MXXF6pacxWMfnVftN\nCON8+tiLbSeS8Iwy7TrHSUyouJMKp9vOTvJ/g3YehqXnQAbLE06gWX3i2cD3\nh38ycSex8ZVHqSOx/BGpK078e/N1dG7RqJGI5W6FgckfB+evXsInMloVjJq+\nwgbyQTquO08dTz2F5B3sYhBphAjUG2gjvRIAU6WKmkDoN2SiIQpyaunt5/wK\ntU1o+oR0MPb2Jdl9z5BNbaQCLBJSomLBSq5jUyoAU8tv9Scxkgg/nH2Ri1AS\n6Q0mQ4NyYhH2HP3HJEllgFBzt5nrEr0Un9txYfXhMBpYXoG8j78Sh1eEhPxZ\nfGh4SSB/RrnvGyfhWpsvR509nMJ85xMvYl94HFclsWvzEOpDA+9ke1JR0u21\nT/HX8N/Ok3+LSnT7Mr4c6MKJmmw4pDeM0U6lYw0Ee43FE+TLyNTZ0BDIxB16\nwWHBSexX/BSuASrbOQalvabVvDRtqishxlA/BXoFwtGULoC5UW6gUzHPLwHn\nx4dvE5KKJrv2EclOsXdyO96KJzempn1e+Ke2L/xbfA1mmTWVXvCYv8ayt/E3\nRz4w\r\n=XMS5\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCtSzpsbjoLGnAG7QfKI3tOGNpk9xYRpO3AokcsyEgwsgIgbz8JPGC2jBFT0daS40oG1NCyo9iMc4CHRRuyk0W2XsM="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.2-rc.2_1630940520471_0.6904625343244337"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.2-rc.4":{"name":"ipfs-core-types","version":"0.7.2-rc.4","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"typesVersions":{"*":{"src/*":["dist/src/*","dist/src/*/index"],"src/":["dist/src/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.0.3","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"84c772cecffaf4deaf967c0c4e9d49c3dda73237","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.2-rc.4","_nodeVersion":"16.9.0","_npmVersion":"lerna/4.0.0/node@v16.9.0+x64 (linux)","dist":{"integrity":"sha512-ajrUcBm4l2PUJ/r0vNmsyQbG1Z4UTxFL9wFHshSjlakNK6DskGkkNvOP2V6zWeUZ2Oxxu2lqY/HgYZ0bIianiw==","shasum":"dcec99c007b0f8ea5a072efd0d07b912165a24c2","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.2-rc.4.tgz","fileCount":80,"unpackedSize":189572,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhN5tsCRA9TVsSAnZWagAAH1gP/iIZYhehQTHxECeMIskD\noTt0t2plq3VKcPibAcHFLffjM4FbBgsNyS0UKV1IsOmzJ1TyOmveDPLjJS3U\nqtugadxTZZN9rcWglRrARx3wB/xdwWkWP7s2AKt21K8+poJRoAskujGOsPoa\n3TMPrwE2h3g7eUScEk8Qqj70uJiH4jjDMNCII0OiJs06NRYEWuHwIy6ZQzJh\ntOegY8ekqyK+iyYJphkjbXDK28g3lHBaRgG/PfajRQ9T0V2dJNFmYPBhp2bc\n/CK0+u61nIrGRFEI6EtdhSYJy7ERt1AGo3fP7X0UZkkAdXyih0cG+f163h3P\nUokUiVJh3WNi0OKZPYL9uwJDOawrpwmAYSY0czcZJ5dUyx2nbF2z8Wwbeh/a\n7EBnDTSLZNHFfkP3ELcMCSfPAxaRKFenZZPjrnPs1zdLYOmCyPiGrn97w+Em\nXFVrDxByMeK6Gf+TzqgI7EDOlNLc7DQ3oI0/5gA0k4VhL/4QPCeMR4mLb2wB\nFwuzloS4usgNVWo02E8zboKoXE5MFaPYi7XCk4lxCOGSVdnRFBjY2wSXxjY2\np1Fon8+Tk+4IMK4NfbJW47/t4VK0Eifuz++2AICLyKVDBfuP9+4blKH9OdfH\nRhqnL0dG/VjMRb3g79lIym7SBNJvgt9L57i9fn859xJAz1TtAzSVI0UHdSKS\n06j7\r\n=MhUF\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGaviMyX5ClgcABUcHc54MUVpVDxUnDRQftt3amIFs0RAiEArwgUc9oY1YtcNxswkqTcZZ3PzBfv73uy/u0qo9taf5E="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.2-rc.4_1631034220618_0.6143843548463821"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.2-rc.5":{"name":"ipfs-core-types","version":"0.7.2-rc.5","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"typesVersions":{"*":{"src/*":["dist/src/*","dist/src/*/index"],"src/":["dist/src/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.0.3","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"b072ef1635759a3d64e02afd7a6d853a94cc06a5","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.2-rc.5","_nodeVersion":"16.9.0","_npmVersion":"lerna/4.0.0/node@v16.9.0+x64 (linux)","dist":{"integrity":"sha512-Sj+aHKLaaAJj18fxaV+9hJ4J5dVb5Iei3UR8B7jW/XR0oyfPbhLnxPjtIYigrjm8C3e1M7Og6twTasGNXCUxQw==","shasum":"4d73c8077c31f19c59db8113cf6d4f3f0376fa76","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.2-rc.5.tgz","fileCount":80,"unpackedSize":189572,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhOINeCRA9TVsSAnZWagAAtt8P/2BkEwy7IOLb3O5Ws2bZ\nV1xqVgE3Z9mQHZfJpe9McCddlAbGp0jOV3yLce+4Ff2QizBaifQ6mi/fTdQ+\nYFfC0Bl5DMjo4HMSyB8BrqBh+2b5l83p5R1OckHnSi1fxdj2xwXl6uPEXzbN\nsbdf/ytZ7gF73XI44mwS0DuYN6b+AId5jdu/+aC5GG06ahFoJPqpxRVsCZLV\nOJHJY0g3RijMFvXG24YzePFZai8I/yEyb42k/KVjFtui3hoAntbtMFPwvLaW\njApBUKOWxEvdi+S8DiceN3uXwTDibbXvzwJDDBmXwy1laDPNtr1xSK12g0Xo\nvmR4RAEyU+53SGLmos3jRyNJqKR0jInC8BNP514Je4qDtpqj9vVz5ZOjoIM6\nPQed6FVu0KDVqJh0526FFrIBdoOYmzvCpmZMKKeAXOamOjFN2+d0odsj+afs\nQKsEH53276PFRdnS338EMHFNlRzOSJ6UVU/QHJtlTAMPJ703I48DD6Zrhw86\noMSKccQY4TA2pEZtPkasma/tLQsuKSoLzcxTpF5mPxRktiyUDPZzyLAN4RR5\nPwmBgfiPiPMd0madJPCcew5nuHL62jAJgAeBGX8yF+b67STWoE1YDLmxSbcP\n5r9rV96baMynW4xJLIucRwGkhAVG+kGWWzsI4Qcgca+mXPEG2YmfROAEQMOc\n+26z\r\n=4LsT\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEMCIDPeu8flS/+/QK+t3kbQEV0RFaa08RRPKRAFv3K/qR6LAh9vX94VjzYBMQxCUNNTwXJXMyqlQLnXl6HKbV7i/Sj2"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.2-rc.5_1631093598022_0.5939013343091193"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.2-rc.8":{"name":"ipfs-core-types","version":"0.7.2-rc.8","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","test":"aegir ts -p check"},"typesVersions":{"*":{"src/*":["dist/src/*","dist/src/*/index"],"src/":["dist/src/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.0.3","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"3a8f1fb75cd49c882d013ebc1ff600a9815f997c","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.2-rc.8","_nodeVersion":"16.9.1","_npmVersion":"lerna/4.0.0/node@v16.9.1+x64 (linux)","dist":{"integrity":"sha512-PJkV3li/uNlkT/LFwPe1R4l4HLoEemXuAv8lSJJ8+GaKFUiqqbQjg7x2SwcfJS6ITbmBblRXgV6CHExgfx6Ljg==","shasum":"7287e376c44d32f90b8fd65c8b4ec1aceecd3da2","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.2-rc.8.tgz","fileCount":80,"unpackedSize":189572,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhQKY4CRA9TVsSAnZWagAA0OgQAKMwwdCmNhgjAYSiT5yZ\njC9FkPnznBYe0jTYjbd+5UOpZ8q0I9RuE6dv88VqdqzgVr0wy5lAWxrxC2dG\nwWe5FeZSphBYAT8v/IHQWbVgqzeRpdjBORCPRHxybG98qtpVLzSplwhoVZel\n3hAseKPTugpNeC0WA15HMqHyNYj3XRzvycwTMaj0qZy2uq011p5bAam8QXbs\nqhxFCLpz5yPBfD+G1zjOwzBKVg9nhUUUbE1U2+TbE8S0HpF97RQlxX+o92yE\nyhtyg8u04pZNO2at/24fBO61E+U/dZIkXgacKB/YsAvCFqQDHYvnbu2O+qeO\nkS/2LplVbLAdDodwv34Wa83EGsBedBFjLdr9BBnu2dxwh6hgQpCaeiciyZYu\n7H7hx7avodSh5X6mTTlHOwyUR3SFbW1iEBcqgeQCvg0mr6eZJ7TqSV7kuI+9\n4dIFDttjUXQ+7cbfX7e8oES/Wfmmx6w5ztBg/lddOIXjFmHibY0DHF0hhvLv\nQMdmoo7mvBVrNqXNSGn6ujx5MEdCjn6nR89jbavQxZI09pAO2Rv/Iwus3ZVM\nwUzz3k0KFzXcBvnwVY04ffG4dQzcWPcBKnTDANHmu9n37FfxaulSuP01Q6rw\nri9N2uSycwS3/l/rYl5Mv/iA7kPAGnOXOnLayNeIicg5wW3ThOdSIhcR0OgX\n7Znl\r\n=yYvF\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBXCjhTHVXSobjjFpC6uDw+Cd5XfbBfCP4touKsTUt+nAiBOztbHfhfSAoK6iJaxB0XRKhOIfXduIKkj8Ax3Rww3ZQ=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.2-rc.8_1631626808014_0.8241781595974502"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.2-rc.11":{"name":"ipfs-core-types","version":"0.7.2-rc.11","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint"},"typesVersions":{"*":{"src/*":["dist/src/*","dist/src/*/index"],"src/":["dist/src/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.0.3","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"d4b4fd24ccb37ba7bf7d587308929bc4843398ba","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.2-rc.11","_nodeVersion":"16.9.1","_npmVersion":"lerna/4.0.0/node@v16.9.1+x64 (linux)","dist":{"integrity":"sha512-4Dn1M+FVgN0ku9jxOU7uqU9ylRRphu7PTNEW7L/yKiolmRPzGUCRmDMAS6N9rsCr9AWmJU5APAYazAiVTWRrhw==","shasum":"81f3c463cad0565352bf21b9a322078c1b99cf94","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.2-rc.11.tgz","fileCount":80,"unpackedSize":189540,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCfw8bzshj0nxg6WY4XPmCw+CKBpx04+XaoEREugZABdwIgLWvUioGGMT1BireihuyG5Mjg4d+y4fSgDSELqDigXw4="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.2-rc.11_1631883048722_0.4182099447318086"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.2":{"name":"ipfs-core-types","version":"0.7.2","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint"},"typesVersions":{"*":{"src/*":["dist/src/*","dist/src/*/index"],"src/":["dist/src/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.0.3","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"88c9921362ea5d71f7a3af67d30765c175783b5a","_id":"ipfs-core-types@0.7.2","_nodeVersion":"16.8.0","_npmVersion":"lerna/4.0.0/node@v16.8.0+x64 (darwin)","dist":{"integrity":"sha512-cyD4fOZ3lvahJWvjtPrWfldhNXN9VJNHPXUY5RRhxoXkuHGrMnTV2t5W3RtBOqRcTB6iRPtdjq7VervVDUlr6w==","shasum":"20d7cca654a207d9f795f664e14ce1c49f6a987c","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.2.tgz","fileCount":80,"unpackedSize":189525,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCba5tPS0urXSUCSHmJAN2+iTChZHtGNfsCvI5Uah3cFQIhAMXniBgTLT8B4vCLy4LQbxYY38rpgq6q9JWjrbVMfQRp"}]},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.2_1631885043997_0.5180694534927839"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.3-rc.0":{"name":"ipfs-core-types","version":"0.7.3-rc.0","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint"},"typesVersions":{"*":{"src/*":["dist/src/*","dist/src/*/index"],"src/":["dist/src/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.0.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.0.3","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"88c9921362ea5d71f7a3af67d30765c175783b5a","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.3-rc.0","_nodeVersion":"16.9.1","_npmVersion":"lerna/4.0.0/node@v16.9.1+x64 (linux)","dist":{"integrity":"sha512-Yyg7TDDThnfq/zYFrssxehlhLHQX/jXwO5trzukVKRLJaPl6fPnNnsK4YlL1vgNqF5r0RsvTQVTWm4o4cNXokA==","shasum":"6a27adc60dfa721f76c99c43d4598a92ebc18472","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.3-rc.0.tgz","fileCount":80,"unpackedSize":189539,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAtW6rOMpSpNyXRVzX9XhxZXVBRg1hs/L8wlXye5cL3tAiA3F6B8X2FHG0vzrkJcaLgddfJo7Cdi5e3iYUIVyNPLEQ=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.3-rc.0_1631885411347_0.1396834385296548"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.4-rc.0":{"name":"ipfs-core-types","version":"0.7.4-rc.0","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint"},"typesVersions":{"*":{"src/*":["dist/src/*","dist/src/*/index"],"src/":["dist/src/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.2.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.0.3","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"a49a89dca7d9b81d390af0833bcee2133959d1de","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.4-rc.0","_nodeVersion":"16.9.1","_npmVersion":"lerna/4.0.0/node@v16.9.1+x64 (linux)","dist":{"integrity":"sha512-roL2ZM5m4I5+RQYmIbZh+c0Tb5obUAtuT2t4M4trgEaMSJnnpBQ6GO+cZET4g72Vl1/cBm8FIfIsC+3hH2H2iA==","shasum":"3425f2f408c02b00250b7445f73c8949ed49023c","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.4-rc.0.tgz","fileCount":80,"unpackedSize":189539,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIF4DEduYhW+pgfoaImiPnVJljVk063gmqu3aQmeZ7OEgAiBC6ptub6WxcFuZd+3YzkcVfye7v7lIzTUEEKaF82lgeA=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.4-rc.0_1631895929025_0.4727020701146183"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.3":{"name":"ipfs-core-types","version":"0.7.3","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint"},"typesVersions":{"*":{"src/*":["dist/src/*","dist/src/*/index"],"src/":["dist/src/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.2.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.0.3","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"b5488cb3ef5ab7ea24b8b2275ffa8cfa4b7b7ed1","_id":"ipfs-core-types@0.7.3","_nodeVersion":"16.8.0","_npmVersion":"lerna/4.0.0/node@v16.8.0+x64 (darwin)","dist":{"integrity":"sha512-FkmOlqhEf3yG0K8Qt7We7kqA0xKjj8pe0dmNK593I3cgMP0MQS/xjMj1CXVdGeZc5Nn5CJ+TsuQydPbJ+7Y8eQ==","shasum":"b7cdbeed513ee5c2810b971081ed52e1ec590f2b","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.3.tgz","fileCount":80,"unpackedSize":189525,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEYemIA80xJqdnpsvwpRO8nB9FPOWCI3FTChFvRgkH10AiBeOkPFhVcz8ZoBVND5qJjnFEBhHXMJWPWAIJNfpBfiAw=="}]},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.3_1631896562930_0.900792509902568"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.4-rc.1":{"name":"ipfs-core-types","version":"0.7.4-rc.1","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint"},"typesVersions":{"*":{"src/*":["dist/src/*","dist/src/*/index"],"src/":["dist/src/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.2.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.0.3","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"4126a5a38bd7b42e96171b67e9cbcbf4efb94476","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.4-rc.1","_nodeVersion":"16.9.1","_npmVersion":"lerna/4.0.0/node@v16.9.1+x64 (linux)","dist":{"integrity":"sha512-rRxmQKaz3+nBSSpor9hXb1Ovo9bDohtpoJAOpLFVDPS44+uQBG+45HbhzJ0yb9v46kf4P1YOoujqdTZ1njFc0Q==","shasum":"9c9436f1f39dae4c1363ad8c0cae4dfc52860946","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.4-rc.1.tgz","fileCount":80,"unpackedSize":189539,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICdFw/2QReVwW758oAJVJHHa+LvwK81lKCsDP3KB1OttAiBiqMo8lDjoMuXsBwMJrScQ77tVwsPqYKy0TvyM8mcb2Q=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.4-rc.1_1632240643113_0.4439654556814989"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.4-rc.3":{"name":"ipfs-core-types","version":"0.7.4-rc.3","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint"},"typesVersions":{"*":{"src/*":["dist/src/*","dist/src/*/index"],"src/":["dist/src/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.2.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.0","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"3052c4a647d528e2726ef4b99151df48d79bbaab","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.4-rc.3","_nodeVersion":"16.9.1","_npmVersion":"lerna/4.0.0/node@v16.9.1+x64 (linux)","dist":{"integrity":"sha512-oi/ww1TNq7f6H5k3KnPI+YxPvDDJQSIJmMsYNrYu5gseM0LzCaIpqAgJz+HlE6AkOeuD6bT1BnCTrtkoMg6xpQ==","shasum":"f5939d5d5d2abbfdb150de27a50ffdbd2bf9cab1","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.4-rc.3.tgz","fileCount":80,"unpackedSize":189609,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHdsuUflwbgTr5lJ0CE5qNG2P8r9exp0p3FQ2mCKOKg/AiEA9AkV6jcaWG8X9Q0OlSUlJtWkMr5cdEYHnP6StTZxXQ8="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.4-rc.3_1632312726586_0.8445665939160172"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.4-rc.4":{"name":"ipfs-core-types","version":"0.7.4-rc.4","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint"},"typesVersions":{"*":{"src/*":["dist/src/*","dist/src/*/index"],"src/":["dist/src/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.2.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.0","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"42919e31cd2e0a49f540cbc4fb8ca68b7fba1222","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/interface-ipfs-core)](https://david-dm.org/ipfs/js-ipfs?path=packages/interface-ipfs-core)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.4-rc.4","_nodeVersion":"16.9.1","_npmVersion":"lerna/4.0.0/node@v16.9.1+x64 (linux)","dist":{"integrity":"sha512-MCFQmOdc+5Is5vhO6/VzYuekmViiGc4O+uBySlUJ618TEltVBKHWbZmUTbMYReUsfra2S3EDt+5wE6B4DpcyPA==","shasum":"b413cf0dcfdac380120f0d517a0bfc7011a5c1de","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.4-rc.4.tgz","fileCount":80,"unpackedSize":189609,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGAhPM/p6fqfFsZ0dlIxbpFhY1Oi9rCc5LnwypEudlMSAiEA9Hn9FNnBQY8qEW4lVYxrPBdhRVVrUbdn2nS8LiwJuUk="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.4-rc.4_1632315333513_0.2336790517755818"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.4-rc.6":{"name":"ipfs-core-types","version":"0.7.4-rc.6","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint"},"typesVersions":{"*":{"src/*":["dist/src/*","dist/src/*/index"],"src/":["dist/src/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.2.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.0","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"8124835cc7bf220cca9fdc5d4d0d6463e6c79c00","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.4-rc.6","_nodeVersion":"16.9.1","_npmVersion":"lerna/4.0.0/node@v16.9.1+x64 (linux)","dist":{"integrity":"sha512-LF8J052W9ixYEseh20jKKHbywxHW8vQjPt4cIIjHZw2UchW8xbSKvDXP88Zc0EStGg9geTAcVw7X6fgGraxBaQ==","shasum":"9e6fee46fded30e1ab0d27239da3cb2d434c0d40","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.4-rc.6.tgz","fileCount":80,"unpackedSize":189601,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCpRWObJXUxBZGEbBkEORyKh7hVdX8ec5xhv084X7SStwIhAMwmirylugAjysusyS/wAWtNG2av0z/WyM9ubi+r3Add"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.4-rc.6_1632319923889_0.6727287505786934"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.4-rc.7":{"name":"ipfs-core-types","version":"0.7.4-rc.7","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint"},"typesVersions":{"*":{"src/*":["dist/src/*","dist/src/*/index"],"src/":["dist/src/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.2.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.0","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"a4403ceb39d1bc64f2778c61242178724e22bb19","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.4-rc.7","_nodeVersion":"16.9.1","_npmVersion":"lerna/4.0.0/node@v16.9.1+x64 (linux)","dist":{"integrity":"sha512-oYAIQEGzMFHe1/wKeLylVceBhF0pte4N5dP89HDgzAm9L/hUhkrq7mk7YuCgrkj11RikrfTDwUQFKkGMfkSAHw==","shasum":"e09d55e250be6bc7e575278a9d7b44529e9ca691","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.4-rc.7.tgz","fileCount":80,"unpackedSize":189601,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCSu3L1GyfFIKwrSTh+vSoYOXom5PMi5U9mRcR9VrsXTwIgNUCf2kdazWrs989Dr6FW1m53AjbLeOg/I8w/bxVtvwc="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.4-rc.7_1632322479586_0.055298809571056484"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.4-rc.9":{"name":"ipfs-core-types","version":"0.7.4-rc.9","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint"},"typesVersions":{"*":{"src/*":["dist/src/*","dist/src/*/index"],"src/":["dist/src/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.2.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.0","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"09512f2f5cb63efb12ac87905ac42c4b97e1ddf2","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.4-rc.9","_nodeVersion":"16.9.1","_npmVersion":"lerna/4.0.0/node@v16.9.1+x64 (linux)","dist":{"integrity":"sha512-PYOYlw6AtUIUuIp8th0OAHYminNm5aPb3oPpP1VMm+W9PLRlt1y8DFja0gN2SzTAJnd0SjM4p/muPIrv/TEVFg==","shasum":"225860572a6c22aaa8dd2e655abb1c69cea2da98","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.4-rc.9.tgz","fileCount":80,"unpackedSize":189601,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIG380oRt8NH+xFrevYM2Nqha+CWsJ1Xm8LpK+Mc2NSLUAiEAigzRODcZdqa52nNo72sifQR4MPFO8PlTrMabG0YOov8="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.4-rc.9_1632328511608_0.06127963510500023"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.4-rc.12":{"name":"ipfs-core-types","version":"0.7.4-rc.12","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.2.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.0","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"98e3c72136abd56bb6e3a8ee1421f7dcc8c8533c","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.4-rc.12","_nodeVersion":"16.8.0","_npmVersion":"lerna/4.0.0/node@v16.8.0+x64 (darwin)","dist":{"integrity":"sha512-5rprt5yWfaqSXOjdu9Eg8mDbPmfEq75NaFa5q/9sHrqAiv68Za8wjNlvB/DYKsDXdL+8MZS+7LR+3PwMT/x9LQ==","shasum":"4fd26f723ef8024fb6c1092e63907ae972e4be43","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.4-rc.12.tgz","fileCount":80,"unpackedSize":193869,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBUJhADv8q8znA4WdHZpvSSVVD2edBM97q16JWccR8FyAiBdqJZwbFNi5903nx49CzYUWI9KdrgThM/7WejtbjsOJQ=="}]},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.4-rc.12_1632377765653_0.19762124967231198"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.4-rc.13":{"name":"ipfs-core-types","version":"0.7.4-rc.13","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.2.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.0","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"1d568430137af97b76555b015a18718c83f417f8","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.4-rc.13","_nodeVersion":"16.9.1","_npmVersion":"lerna/4.0.0/node@v16.9.1+x64 (linux)","dist":{"integrity":"sha512-WkDjemOqEZmehF70VbZ+VPXBSlyb7jL6qK9cR+U7yZHHqBiXGxsvSlrYmkIMAMA2LhgqP+mwH3PenHx5B1mYVg==","shasum":"17b5b924fecce5d437ce7d4a07418a7d2c42ba32","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.4-rc.13.tgz","fileCount":80,"unpackedSize":193758,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGBDfxZHz47wCcW9i+adPO9wLttgE0vraDvHrTw9EkZeAiAHJAkizI/+FMSmOilAbJp4/Jnb5UDVqyDcQ6qq/q+SKw=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.4-rc.13_1632378388136_0.4740705343575964"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.4-rc.14":{"name":"ipfs-core-types","version":"0.7.4-rc.14","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.2.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.0","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"498d9b0f3c5325af2d2f93ce1538c65f7c1eb2dd","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.4-rc.14","_nodeVersion":"16.9.1","_npmVersion":"lerna/4.0.0/node@v16.9.1+x64 (linux)","dist":{"integrity":"sha512-YkPRWlDTZv0gf63Lzr0ZLn1TtWo3ONjvOZPr6LjkHs/4eaMWTAVhD4T5cGSljPp3FxKllyayWigkkLOafYnIDw==","shasum":"3a00a3ea1f2efb8cf21b01cd1cccbedbe83ea1d5","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.4-rc.14.tgz","fileCount":80,"unpackedSize":193758,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDx1Wmm0bRlDHCb6jFoU0p5gSFB4JwthiU36odTj6UYGAIgLZ3TGwWMOSaHzujoADRPsXjyZhlx2UFx7qQJk0Pa+/Q="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.4-rc.14_1632394069306_0.25766209343599167"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.4-rc.15":{"name":"ipfs-core-types","version":"0.7.4-rc.15","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.2.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.0","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"5de1b13bb685405ae081a824dd76e34228724451","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.4-rc.15","_nodeVersion":"16.10.0","_npmVersion":"lerna/4.0.0/node@v16.10.0+x64 (linux)","dist":{"integrity":"sha512-6EPIIS0S8D22kGc/8DvqLtXdAL/FINgahweMNHiSOiCPHDkhCONTjCcKx8I27Vyoi6JPONIQYckhoEg8A4FMTg==","shasum":"22e348ba385f7592f4f13b3f2a705e1c17e0f1b0","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.4-rc.15.tgz","fileCount":80,"unpackedSize":193758,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDYIIXVrv+6As1a8OHWQyC6XqOMmzgCcpgMRRh9eezJpAiAb/+eoRutR10VrLlqpAo1tsixoUVXxcZsjs8Ow7eofXg=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.4-rc.15_1632401805593_0.057188166473121305"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.4-rc.16":{"name":"ipfs-core-types","version":"0.7.4-rc.16","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.2.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.0","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"be4a5428ebc4b05a2edd9a91bf9df6416c1a8c2b","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.4-rc.16","_nodeVersion":"16.10.0","_npmVersion":"lerna/4.0.0/node@v16.10.0+x64 (linux)","dist":{"integrity":"sha512-GUOaiZPP5gRNCWLR6XI1fUBeKzyxn9Dt2uIZH4djKdv28/DYy0GX91PFRl/40l7NeTiLHIIsTofxZdhZCvfVfw==","shasum":"82d6114a9c4140eaca7032c7a7fcde4cd1ba784b","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.4-rc.16.tgz","fileCount":80,"unpackedSize":193758,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDXML16Rmvshrfq8BSKKmozPTGoH7m+pNnENTxSDCkWFQIhAO9fHHUtWtysk5pSUvdrcWdDUDHN5+Hxvj6J3Z6t9FeK"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.4-rc.16_1632421985443_0.9361617791527297"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.4-rc.17":{"name":"ipfs-core-types","version":"0.7.4-rc.17","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^5.2.0","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.0","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"b0f367d666aceb4ea8bdd532a9d8c3501f8cc78d","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.4-rc.17","_nodeVersion":"16.10.0","_npmVersion":"lerna/4.0.0/node@v16.10.0+x64 (linux)","dist":{"integrity":"sha512-YsrXMffxTFFjyqBPDFalWyEd+m5hfEgDNP6LYbrCZpcX3dcA+22PviEtXyoTVxH1l8aZ49e5ap8LWps5iivgig==","shasum":"3f4065ce4b1f6546809d0f7718798560f8f26641","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.4-rc.17.tgz","fileCount":80,"unpackedSize":193758,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAl7qlE4nHpHf/L3SBgT5aFDBoWcv/2ys/fi7h9e+fOQAiBaGzwwL96w7tMLj7Qys5imJsEEOAKDqTfKDZFF9Ov0bQ=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.4-rc.17_1632482441002_0.8772688208950312"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.7.4-rc.18":{"name":"ipfs-core-types","version":"0.7.4-rc.18","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.0","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"938a7d72896bf5e5afb2ce6d472aec4fa4929a3d","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.7.4-rc.18","_nodeVersion":"16.10.0","_npmVersion":"lerna/4.0.0/node@v16.10.0+x64 (linux)","dist":{"integrity":"sha512-AoMxKIdRoYZOw3S/yERfEMVAwDZ1ApeFwof0LdCr211lYEx4+i5cYoIPQ7QccOVnavzVADsTPQJrcUqYmeM3xQ==","shasum":"e9b92971e52f123d831e5936629a248421636490","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.7.4-rc.18.tgz","fileCount":80,"unpackedSize":193758,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGk5iRhGX9J1igTJ4MOPUU1UbchU575AUbQrC5UrCZ0KAiBrnOenpwMDQCJ8mw/GrwIhlap6O27m/LunUojaXnoOig=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.7.4-rc.18_1632487529231_0.48240194782411594"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.0":{"name":"ipfs-core-types","version":"0.8.0","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.0","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"cbd3e948deb5a6489cd69d1705a0261860c2ea22","_id":"ipfs-core-types@0.8.0","_nodeVersion":"16.8.0","_npmVersion":"lerna/4.0.0/node@v16.8.0+x64 (darwin)","dist":{"integrity":"sha512-eZppEEOOT01KwvgNT46Npf+wO0b1dF8j+/Gux8CZ2rgqmoXi74CAARgCUeG+e8JEYgoO0i2OzcE40eFs+NjNLA==","shasum":"5399e3d3bbc532e4a124904ad1d28c026609cf4e","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.0.tgz","fileCount":80,"unpackedSize":194141,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHs+vVy1RPsmGgxiHh2GXkkD1xb1l/7cBTXsOCnhHc94AiAdaSjB1Rb/j/p6+4sRN3gWzyBzwwOlWZi1icnZf1gzNg=="}]},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.0_1632487749245_0.08883458957844326"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.1-rc.0":{"name":"ipfs-core-types","version":"0.8.1-rc.0","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.0","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"cbd3e948deb5a6489cd69d1705a0261860c2ea22","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.1-rc.0","_nodeVersion":"16.10.0","_npmVersion":"lerna/4.0.0/node@v16.10.0+x64 (linux)","dist":{"integrity":"sha512-Ih2vX/OlTc9ECZDZ1+IgQXkH1BzqaJHoC0brTd/rmtR3d5HYoWy9+s3tAutNBZzJ8s5M4hXKvF1BN95RKHLMdg==","shasum":"88386279ded78dd5bb1f8b59010993d76388a5d1","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.1-rc.0.tgz","fileCount":80,"unpackedSize":194155,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCo5CNclvexJPWtFFK3JmNLlRVOpCSC3UGuyTk9gvVmBQIhAL45tsUv/NnW9Uu0fx9TKhQBnCjGF6JCDSUD44tn7tqI"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.1-rc.0_1632488013232_0.8805912795027537"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.1-rc.1":{"name":"ipfs-core-types","version":"0.8.1-rc.1","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.0","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"a0e36f408135c963d4fe3a66ccbe94e60ae5d8c7","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.1-rc.1","_nodeVersion":"16.10.0","_npmVersion":"lerna/4.0.0/node@v16.10.0+x64 (linux)","dist":{"integrity":"sha512-iraOFbhelNUstIeoTQ98cg4LgH8EuONSIOODJ1cDt9BWV4XZkg0KSwwkf5qtFP9OEHh3BpTsuSMFizsnFUiR3A==","shasum":"b16a35e0d1163c42e4ed77ba91f66660bd9336af","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.1-rc.1.tgz","fileCount":80,"unpackedSize":194155,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCgnBSj1yUDbvcxKZeivnch6UvCKOadkTqsBBC91D+7sAIhAMU2njNiIbxRxou1j3PinzVpp69stLK/MyNcCcz0/tXx"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.1-rc.1_1632590769204_0.7504575395124018"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.1-rc.2":{"name":"ipfs-core-types","version":"0.8.1-rc.2","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.0","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"78060914410f54f443aad4c5c0de39f899ec6f40","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.1-rc.2","_nodeVersion":"16.10.0","_npmVersion":"lerna/4.0.0/node@v16.10.0+x64 (linux)","dist":{"integrity":"sha512-OFYjW7qE5JKw9KUJFtzyA9Kj7NiCfgVoKrBFXU4O26goUAOK4dpcPDOY5IaQbj4Dga+OI2VSrJjYTWMY6kkPPQ==","shasum":"743ab05b4ca61bd52a92d7c3410e6743bc9cad79","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.1-rc.2.tgz","fileCount":80,"unpackedSize":194155,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDH6uUpjnt/e10wWg2JeQi8R+qICFNTSjdFaSXcQsoP1gIhANOzCWKwrK0my0o2AL4oi69QDB16esP4O8CywaeWgGgU"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.1-rc.2_1632593465085_0.5175685914617469"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.1-rc.3":{"name":"ipfs-core-types","version":"0.8.1-rc.3","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.0","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"7cb986167d2e51ab0ce94104bac92ec63c0a7cff","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.1-rc.3","_nodeVersion":"16.10.0","_npmVersion":"lerna/4.0.0/node@v16.10.0+x64 (linux)","dist":{"integrity":"sha512-3VJWUc1JPpwKmT2iKPkaPLitOHzI58bz6CfX3cL8ID++WU/+zUX6eW1GSQQqj3n3HYf4Kfr/l+zrtp5QH9VhKg==","shasum":"f1d77f14de5f9bfbc1f06b5618c169b432a40b5d","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.1-rc.3.tgz","fileCount":80,"unpackedSize":194155,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIF6LW5sMaTVxYXo44NAzfaD6SRGKTb0V5TW4usr7UbbaAiEAu6qOFALkCIR278PvNWRMyLcnlTEcNbJzRt5ljC6c8T0="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.1-rc.3_1632760643839_0.6495396620219278"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.1-rc.4":{"name":"ipfs-core-types","version":"0.8.1-rc.4","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.0","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"7bac6788a525a541c3e20fd3c754857b44aa0216","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.1-rc.4","_nodeVersion":"16.10.0","_npmVersion":"lerna/4.0.0/node@v16.10.0+x64 (linux)","dist":{"integrity":"sha512-9k2ZSdI+JxlChrKiXemdHRIc3YZ1fTULbQaxp+GnN0Z/NBRk/mld0ZvTuH912k80dd86niecCbnBP2obDipIiw==","shasum":"0869c6a8c0d13ae85c2d9f040322c8294bd8e856","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.1-rc.4.tgz","fileCount":80,"unpackedSize":194155,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAqjiCCfrMD9MzYdWzjdhXW7qj5HkJLcRv1mHQHKqi9nAiBQBtHEml9DXVejEWhzSlWPR6rsn4Jp3NnlkddkXqP45A=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.1-rc.4_1632812620995_0.6819076020021839"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.1-rc.5":{"name":"ipfs-core-types","version":"0.8.1-rc.5","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"4dd8acf4d7df0ece0afa764d44dbdfbf788807e2","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.1-rc.5","_nodeVersion":"16.10.0","_npmVersion":"lerna/4.0.0/node@v16.10.0+x64 (linux)","dist":{"integrity":"sha512-3kZsDipnh2UIdiwDulLmGelRslE5arHLm1yfljNwalvD5JXFFTNkpr4TZge57lYkxzcGW6NAGIA7h4Bg5MB39g==","shasum":"98a43891a7e8cbb837bca5fcfa51026d740fc3f7","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.1-rc.5.tgz","fileCount":80,"unpackedSize":194155,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCoa5mgLcANfrl/lwQjzj09YDCxj13vwSknUUKRXkXvYAIgTzg5lgk6CiJPVMWQZOK7fofeH9PUjndk2FdHJBxOXIU="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.1-rc.5_1632830408885_0.5494314712405752"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.1":{"name":"ipfs-core-types","version":"0.8.1","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"5ddd0c555cc6577ee15667f4ef4e7f3a3b17d04c","_id":"ipfs-core-types@0.8.1","_nodeVersion":"16.8.0","_npmVersion":"lerna/4.0.0/node@v16.8.0+x64 (darwin)","dist":{"integrity":"sha512-9pfHaPGbl8EWeQZTSodN/y+lBQ9vyh6RYvpmw6Ik0ksy5QLj7soEkH4msHO78t5ZMeChpPIYpZS/oo1bOld1cw==","shasum":"381dec9a05612691ee708faee1561666cfd5c482","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.1.tgz","fileCount":80,"unpackedSize":194424,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBbVDh08w28KgoHgZ73IAHCLmNHaAg/aSa5zD8zyUwM3AiAMYnB5AS7pflyUbI0ucYtmScpt8NT5Lh6uJ8kQ6sIyvQ=="}]},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.1_1632830572551_0.1877645423828178"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.2-rc.0":{"name":"ipfs-core-types","version":"0.8.2-rc.0","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"5ddd0c555cc6577ee15667f4ef4e7f3a3b17d04c","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.2-rc.0","_nodeVersion":"16.10.0","_npmVersion":"lerna/4.0.0/node@v16.10.0+x64 (linux)","dist":{"integrity":"sha512-rmOzGYsVhYKxZrOJl349ZUklScgfOCMcO9c90sakSuP8a0Nu6EpU6V7tiPJ3hVcDROHA40rHKrODB8oTiNvlUw==","shasum":"bdfc9cc8a5b39977c0e7b1ef57422a8ad83b772c","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.2-rc.0.tgz","fileCount":80,"unpackedSize":194328,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDztEtRfMiXFa7+v+kRXBu537+2eMv7BIXyta7Lvr/MtAIgMHMAGLq7RB/dmAG43pJG1Oj3cSPuTCNWgg9j9KJmcZg="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.2-rc.0_1632830856506_0.44346430956181204"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.2-rc.1":{"name":"ipfs-core-types","version":"0.8.2-rc.1","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"3ce2f7693b59ad4176e245c4c7e75a91dd1bf94f","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.2-rc.1","_nodeVersion":"16.10.0","_npmVersion":"lerna/4.0.0/node@v16.10.0+x64 (linux)","dist":{"integrity":"sha512-mCXOnpXxm2umHP5ms+BARLxEmUDabVvax2Soj2hJb4kULz3zgeCfng5bgFu1vSss6tidxP/TiTx0UiXlPXLtxA==","shasum":"a6c8de718e3f0b90bd578ab2c488297f22ebd041","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.2-rc.1.tgz","fileCount":80,"unpackedSize":194328,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCyoLtnqMwj92Gyey1Yr6jILMANjlWd5yvA1NBSg85yIQIgY1jxWFQSynfeJSZfofawTbpo5DXS4+G58ibWofCzOB0="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.2-rc.1_1633016926916_0.43897060955783074"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.2-rc.2":{"name":"ipfs-core-types","version":"0.8.2-rc.2","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"b09a18cd98883662353d116a8ff25a3ddaa48fc2","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.2-rc.2","_nodeVersion":"16.10.0","_npmVersion":"lerna/4.0.0/node@v16.10.0+x64 (linux)","dist":{"integrity":"sha512-N4F5BY5CmjVYDAvvhVuXWWpaneLNZLZqYHKdMe1HFuBy3YBXU49jWHWlBLfcoZWydTg5fmHxiigO1VwQBgaLrg==","shasum":"91efaef5da5817d742e7538861d46c8dd48b5819","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.2-rc.2.tgz","fileCount":80,"unpackedSize":194328,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFRndUNkHDmzRn6/1LN1w3qMn+ubkMlrNHtGx1ZkTvhzAiBCMH4aMhx1JaC4qgqPWqva51+SkT+/TIljH9tozl2D6w=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.2-rc.2_1633023544160_0.4603206074559165"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.2-rc.3":{"name":"ipfs-core-types","version":"0.8.2-rc.3","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"bb0dd96be3e570f5a43a4f31f43d1c97e8322605","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.2-rc.3","_nodeVersion":"16.10.0","_npmVersion":"lerna/4.0.0/node@v16.10.0+x64 (linux)","dist":{"integrity":"sha512-rRuLICzSp9dys/UuFnK6P5yC4P8kVLPxqdJUsP5a/8EDKt9kFsY31/Cy9pGAWiyFErd2WwWT4EpJyDF08QH0sA==","shasum":"0b9c275ae85be0ceb86baec7405a64f189c40406","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.2-rc.3.tgz","fileCount":80,"unpackedSize":194328,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDDzehBvp03tYKSFMh1yvQuYVT0SCSv6I9IiHk9vzuEXgIhALW+Q5Oqbu0bMcZmXRsZO1Gicj0HrZxiP9EXrIeHkUoY"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.2-rc.3_1633179489048_0.22022932874144363"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.2-rc.4":{"name":"ipfs-core-types","version":"0.8.2-rc.4","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"09c7bf7b63620f84d50c8a3983a5d4c28410cd82","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.2-rc.4","_nodeVersion":"16.10.0","_npmVersion":"lerna/4.0.0/node@v16.10.0+x64 (linux)","dist":{"integrity":"sha512-RyOijVw2eqPkle5vvqCBcmUPjGjJXmbKD0sOj1/9MRqEiRTW/0vMSyRVPiJTjLkwdD7KluQFsNoPMxQZRoYYbw==","shasum":"795e32a9a5ab6e40293fe5e39fbd155ae01f84e4","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.2-rc.4.tgz","fileCount":80,"unpackedSize":194328,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCHz+ReuXE36wqiomlLD7j8EVh8gcRcMMVqOYgtmrZnO4CIQC1NjsKorY6mbtlN80EFNdpilk+dVWHb9jTqzBI/8AwTQ=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.2-rc.4_1633703575101_0.000004509463953361603"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.2-rc.5":{"name":"ipfs-core-types","version":"0.8.2-rc.5","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"15184bf1838956a44c079660a4d82c24166407db","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.2-rc.5","_nodeVersion":"16.13.0","_npmVersion":"lerna/4.0.0/node@v16.13.0+x64 (linux)","dist":{"integrity":"sha512-1247scCHwjULesSgO/AFtXMEMoK+Izd64p2uB95g4w5DvwB+qSRcCmdLWRDrJrO8E+Wpk5xfq5abFKjce+7QeQ==","shasum":"6f2ad53028798c8f04f6e597666b7ee9d28a17ff","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.2-rc.5.tgz","fileCount":80,"unpackedSize":194328,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAQ834W/J5fBJJMYJ4ghl5ERjl+f7hnucZJrIHGGBWI6AiAD5T8ke+KbW862WEVxOBkOHIvR0qcDSJiOs8MAN2LHKw=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.2-rc.5_1636010773568_0.2853385997578548"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.2-rc.6":{"name":"ipfs-core-types","version":"0.8.2-rc.6","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"8a3ed19575beaafe5dfd3bce310a548950c148d0","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.2-rc.6","_nodeVersion":"16.13.0","_npmVersion":"lerna/4.0.0/node@v16.13.0+x64 (linux)","dist":{"integrity":"sha512-DJrNUDnQWr9BWvtvfgSlP62uvzOll1N9b8GmQfUf0cNf2j+r1gxg1Iz6zlu4krghFJ3Cp+uUH0gywa+xeWAR8A==","shasum":"fec3d15426e00ceddb947d0517d7d66186034f83","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.2-rc.6.tgz","fileCount":80,"unpackedSize":194328,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHvX061goS55uzO/Mx/i+QsDabvD0iXR4ORYfBeVivuOAiEAlN7efEB7EmhrtVj/YxTdrBo6ZbL9xgGR2RJe35u1HXU="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.2-rc.6_1636716669070_0.25355974405131776"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.2":{"name":"ipfs-core-types","version":"0.8.2","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"568aeadd8f308cc230de06a956c1a9e6102094b6","_id":"ipfs-core-types@0.8.2","_nodeVersion":"16.11.1","_npmVersion":"lerna/4.0.0/node@v16.11.1+x64 (darwin)","dist":{"integrity":"sha512-qgKn+hHAdRRyP4eX7ygmNSPucI75KUMxtoxgYaJGPcew4rdvCA1VCD/Rc0W+dHlRbTRM4CYIE10VS3qjpXSgDQ==","shasum":"6923dd1a5fda9ea26d7b03e83f96a16a9e8cfc24","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.2.tgz","fileCount":80,"unpackedSize":194487,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEsxMmq4Tbk2NN1WxxqJpFv/p4wrnG/btVIsASYVdjgdAiBg9HcONPSHCESvKqCNv3pQjq0ZlFHDXMRXEFANaFZcOg=="}]},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.2_1636718049979_0.7721282821492965"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.3-rc.0":{"name":"ipfs-core-types","version":"0.8.3-rc.0","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"568aeadd8f308cc230de06a956c1a9e6102094b6","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.3-rc.0","_nodeVersion":"16.13.0","_npmVersion":"lerna/4.0.0/node@v16.13.0+x64 (linux)","dist":{"integrity":"sha512-py9hqndw6Ta74/DKqaIt6OOaX3eCR+3MglWQdOSYXM4z7dUGFWHtwMUwRXJq8c/DhIEvROXMHWgGa/f+g76LVQ==","shasum":"0bc01eae9b46916815fe12c26e618d2a502cb623","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.3-rc.0.tgz","fileCount":80,"unpackedSize":194501,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFEGZTF1SLb/3OKv3UXcEkUM3SXByKXheukpnGsrvI4eAiEA0zvQ2Wc3FeG+pvwPUpDlqBuKnqZ0EbJqzlwYnqpk2xI="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.3-rc.0_1636718162927_0.7233193875840871"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.3-rc.1":{"name":"ipfs-core-types","version":"0.8.3-rc.1","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"f419553b9dccc0a1172f399c41b766a754a3ac56","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.3-rc.1","_nodeVersion":"16.13.0","_npmVersion":"lerna/4.0.0/node@v16.13.0+x64 (linux)","dist":{"integrity":"sha512-5zFWcnvWlYCq/MGzeRKNyDw+mAAAkAGpgat6NK7mlTvmLYuoxLexROkrl8oPyraPDswIQmmNiao6WSWxckVxtw==","shasum":"a27693d0a22ef96df1aaeead72d6aaac5ec8861f","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.3-rc.1.tgz","fileCount":80,"unpackedSize":194501,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhl8XHCRA9TVsSAnZWagAAE7sP/1ksJLE/v933VHuRK1eC\njsS8/DOmU0OlC6fx2gIvxcFJlKKh5ENHbydrhVQQ7pt4uboJ7nyTn0FDuIuu\nyio6IWqU3Wr+z+dBO+/v+mpYijyVdBMj+6EtZ5GGZ4lhmO09wJtYqIVz9NfR\nx8t48SHR2j/yUQngs4mQEOEUx7/zvzywv9mve9Xalt4JQNXKWrQI7dLbCpoj\nZwu1brRdy6yaQ+V3NCOEMhL412jiRWJ0bjOZGS7lIcNUkJmxfM5SlNdYHR9a\n7J3na4I17ijJo4aLtA0QOP4fBabnqL40gitzJJhmNht2hrmHmdRyIYfusBGr\njvd8QRleSyg39AqvnkwLXoq4q2J9fhOi3Z3FRAm4i6gU/3B5EVSvofpsFuK3\nRT5EBhhiHi7PQJIotpYI6+gDEAVHT51Be1IQPaJhNTbJE8w0iT/KlscCza0s\nZrFPwjKaxQeIzNZHfzfaUS7NJrtPS/vOhiGjVpSwaR+4KIk40lJrCUGMwqh+\n/bbqbiqN5KFG1usELijFODIFMvrZ8RVlfHqQzl4RDrd8zejSlYCRAVbTkHEX\n1hizBnDt2fOc5F0E7z2YrqbVKfjkv2hdsBFGr5Nk9OBm/0gRdPWUHem1tS3M\nDJDdVyTTgkYjBRAmNanw7jINlIDXmeg62zd24SFZNM4uCFmN/Rmsrf7MDa7Y\ntvyP\r\n=QxJW\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDdNYwrDaM68D1IPKmnK/1R2GQNIpg0rbBc/HTKtdZK5gIgAsxL1hWG3A5CKKSzXQ3ezw36yrStmtC2ZuJY2WxmiRA="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.3-rc.1_1637336519248_0.3062142742780465"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.3":{"name":"ipfs-core-types","version":"0.8.3","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"fdc148b5c08c0be49eef77a18259d5baa895e3f9","_id":"ipfs-core-types@0.8.3","_nodeVersion":"16.11.1","_npmVersion":"lerna/4.0.0/node@v16.11.1+x64 (darwin)","dist":{"integrity":"sha512-AmVIeYhYJfBXwPlJxJE4sYaW7CM9AhP+hZzdNJdnCP450Kaw8OXRct7fwIvp0SBm2d4AdeHrA9QNpPuH3vMTKQ==","shasum":"cb042a35c4ccb0b100348a0d9f473b22dd482102","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.3.tgz","fileCount":80,"unpackedSize":194660,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhl8avCRA9TVsSAnZWagAA08oP/0AfjRoJihcybFvqyq58\n60cin/3JctrjMBoQvc4owtiyYB2p7Kwfy9dx/XkZhre70lZosVDRpbhU7rMc\nDKM+9dEu0S9hNnx4H6MfdeA/MZ59t1RzPSdLdNGbAl8BeqVhDJ/QiiD9NfIh\nOPzZY0hiOZ7tvtGJqUctpI+lswrXWG7jhd+z6C9WS7QCsUO54BBLw4ju5iyg\nOOmwv//fEDDZX/5FTlU3/Ua3VUhN8dLz0atebRE5P3UrXb3qUdwi2d9lkI++\nxuK4u59w3fihO0oEe+Fcg0oqmCMoQMHlGnTLLpeoFeoCabtSNFMPUT63mqKv\n35R0/NcEH0R9EvXI98Bs591g8LVkmhUy9fcpT78LSANACo9uFHrSUYYEIdyT\nLq/XPN0hNmFx+Fd0GTFn0vaPnXHYXJSmIV4xShkXcqdn7J1zE8GNrO+QbK4E\nf0L/FtVq+/j4zmzo71wSCtjCmZs3GdhLCzXMwsY/f9SbjU5ZO8fDf7jpOo8K\nNZKK64gbMjJgAVE7TpiJ/DnInsrVIVJhPWSiv4VTzlMMSVxqg0VQkyC59rfN\nacb8YuItRqVAoRP4npWfPg+uX20jwHs0EjgZF5zRxmz3pHVD4JmKKtZ7PifV\nSb1C9lwOiP6NQ0yP65p61yocsNCn4LIXHL1xUiwbI31C6IMnxSD/OtyydiId\neSbO\r\n=lA3L\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICNurmR5dBVBfXFoHQq8QJ0vlg4x0wZ7+e05a4Lx5uP1AiEA2ljGIfzhPJ7EbjExgX9AH/n8D13b2omWP32CI79/s1Q="}]},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.3_1637336751416_0.8015528765246505"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.4-rc.0":{"name":"ipfs-core-types","version":"0.8.4-rc.0","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"fdc148b5c08c0be49eef77a18259d5baa895e3f9","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.4-rc.0","_nodeVersion":"16.13.0","_npmVersion":"lerna/4.0.0/node@v16.13.0+x64 (linux)","dist":{"integrity":"sha512-j6ZBFn2FTvIun6ie3O9ICur3vSgTuQ+6991DG5EjncEQWezQjopcRqvfL4ujZF+wYFPRpjoRWjW2MOue+JblOQ==","shasum":"7d2e8542241190deb4c728afdb35871fe2d9f7ff","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.4-rc.0.tgz","fileCount":80,"unpackedSize":194674,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhl8dECRA9TVsSAnZWagAAEEgP/35Be5O3ukWtCEJyBPO3\nZhWbAingRRb5GVZ5l5MF9GNjoXiTA96lRYx2xrpnR8ZMlNKrluWYYoXKmFRE\nYTpl7ZP8p22UU9onbAr2rzcZ7rtBYtPffUrn75GTYIv67Du2Q92H9cMpBOX3\nBopVG9uuhRnmX/KITHwY38WyvJTBZF9ZDS06eFb1jyLMU/yF3n51IyKuchS7\n/in43dsyafmuzI6Y9TQ7h8cFuHyfYK6dQV+ML9B3vONMDTgFdDeuJ778omhO\n/GcUoVUUrNi9brxmSjBv5VrC8sBim9bMRrmGMiEVM9NTlxCkmp3QwDo1JOYF\nIK5bg5Eku5nkDPxrBJGZowlkQuDd9kycgWDNYtM7DS6UCbTbG/pfT0MLAe2o\nIQYguFqufNg1l3ScZ83OCR+oJlcJ/iykQiXOUxhsEQ+PGL1duuVObQJx7sFf\nS1hwqYqEno/fUcp9paRvlSRAvrhfIMgvFOQ3f6bzasef11qFl5RInLsKxkW1\nogxfhkEh0aJUKKB9m3Zsc7R80/y9QpygbzfLwaw8V6z79Ijir0o4nK958ava\nV6F9vbP8iOXwwwjtWfaGUYiwL1G/QYJjYqJRbDzHvEm9UHYJD9mPG8hLkTaO\nuRtZPA3lr5LHWw0Fx8FNhaQXISfRa88mouj35OyIRwdh7vvwSs/jCqwxA2MF\nKDg0\r\n=e9tA\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDS1QBIV9A+k94hFa5vccl66WPOUkTiPleRhU4T3yNIDwIgH2tDSP1UVT9j3/KYuV0QRzQk0a4miSUXTEIo8RQkJ2s="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.4-rc.0_1637336900123_0.38161783749919054"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.4-rc.1":{"name":"ipfs-core-types","version":"0.8.4-rc.1","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"041fc29d151e8727ce9aaafd2c46a4cd34baa8ce","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.4-rc.1","_nodeVersion":"16.13.0","_npmVersion":"lerna/4.0.0/node@v16.13.0+x64 (linux)","dist":{"integrity":"sha512-YrAo/S0G/Y70sAVUkRxMq1N/yR6VZoo8tCIsKn9jc4m0Io9MWCQSWfhx6pWnRDLFdVGqOFG8oulMoSMry8vVQw==","shasum":"c8c6baed9ec78ab4a038a6b4a62f3dc0766d3e21","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.4-rc.1.tgz","fileCount":80,"unpackedSize":194674,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhl92JCRA9TVsSAnZWagAAnwcP/3eiMQbCWDwxLSAKLjR8\ndfTcVljbTuykw9zQaqIR+S5G5PxNthZx2PGyvFhYbTezP/MB+K84CKyihiXK\nvNG9UqdBms4g/Cl92opnNI+xVvLv5RC68dmU6wITAGhWCTPyxwpGcl0iMuR+\nKUrIB2yywpdSFCHwEv0YwQk/87H0lIzBg0jjajgGBHb2BVRGh2Xec3/93Q/M\n1mn++6ni+iDvQofZbd5/k9ohf3Y+xIwX6uM9/he7BQhj2r4ritLla2MLa4T3\nhVVNHVdGux4M2ap7eLlCOCoTJyKbmgnLp+lPOaNOR0T/wT/ekhZqiC3sP+Tw\nernPrPbO/sk+MTHfNBDLTZ1TZ4d3b19XZlW122rrRx7o/bvAhdt0ocP3wTLo\nYtv5n+bQSbd49YEia0CQSgiLvdTCiVgC9TaCUWY9tkMa6JVx6bvjTWs2U9u3\nPGffdk75Txm/BWW3aCwUPuiXeNO/pEYCvcU89ImimV3HS2womQ+kujZ79cnh\nDDNDwWJ4NgYQLpnEZGb6pXeqsY5AXGlJaICnwYhl6E1MMvuLOAwBvoF9bJOl\ndWXSNgb9xCPo1TBgc+5Fx04Rm8vYiTs5sHYPbdYbIRUbEaN1r7I8gqDucuti\nRb4ahq8kVmSFR3U4NabInqgxGSR3jThXS33u8nqEydufIv9ed/rUOdvljKxU\nL7ax\r\n=WtIy\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDmB06tVZoErYU4Fu3oYZ3znydx3LyHKngC2/Xn8NC6+gIgK1kD2vsY/SxkYF4Q4oVkFOpiwB5jbS4ZoYb3AHL8AvE="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.4-rc.1_1637342601002_0.3485437183237243"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.4-rc.2":{"name":"ipfs-core-types","version":"0.8.4-rc.2","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.1"},"devDependencies":{"aegir":"^35.1.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"70c67e27d0b82c7650a2a0d7a646afdcd24e73c2","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.4-rc.2","_nodeVersion":"16.13.0","_npmVersion":"lerna/4.0.0/node@v16.13.0+x64 (linux)","dist":{"integrity":"sha512-T1I0te5281tWUnyHkKaNnqjOJToIAkqjl97VPrmCxEQox/BdskB7QZ0xBxqjkdQKVXwaIwCjzLaIEv/PugZpbQ==","shasum":"8a3b86a509cd524dbaa0a4ca6dbe4ead69d021b0","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.4-rc.2.tgz","fileCount":80,"unpackedSize":194674,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhm8KECRA9TVsSAnZWagAAbEwQAJUz+amW1aspQEdrPWbA\n48EIWyzs0xGM7958DGHEBxKnPfOvQdbyMUGCQCImgpU/YydAAIZFwdxD6egY\n1GqDZEVAiiO4Mq9VlHNOgypNWHCH+Vkkz6G3o1xXZrHEhaMr11oqRbPQCOih\npnH1uAWpUtjGmuCc48Bnbspks3AEq1+HQB3tpZ3EIS7y/07qDICkZUTlMVby\nldSp22jMuiLCWPAXhb8OD6i2vF9vOamCITQ5rwcmAJR0sXXqPyjD4tjKSi6j\n9NWwlEvr9IUIz73FqJgLoxWJdtMIHIcx3QcfFqjhbg2Hni644lioEZsyUN40\nVaYORNiT32M7IatNwfz1x/zcDvBJuNIx6Z9whUeO+MXb3EdrQGNHGvqG190V\nYP4rKOSemt7tARAgVbVmxf5x1wdV2sXQVh5jdde3ZYctp8ASaUVI2QCDnAou\nFtYY5z5oL8piGXV48K4Zpx1udIUM7YONobi7tI+E6GZsmT0Ti+chrB2u3GzB\nmytJEwIQ2TFsbx6IuzDOCfBHNQcWd1Dvxvcv0DjUKZe5JaE4dNv3vzVupB+X\nA+c+b2T4J+Q65kahaPy6x2CEsR94O9ksCH3ELJyrH+RIp6YEqDd6Mfvp8lGo\nVJDCtHInaCErQmyO2iIuaKltD9nwr5HVBY23J1L4jWyMyAtvz2x7s2FIEUqv\n3O0q\r\n=at1d\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFxPOGfkpClbD/Zidvm2uPN6/uUMSq1Pf/8fva9QgcLRAiEAvSWy240mEA7tYR8PufG2K0H2i/AGTmDB3TlZ5d0G/Kw="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.4-rc.2_1637597827770_0.6283971209128731"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.4-rc.3":{"name":"ipfs-core-types","version":"0.8.4-rc.3","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"484d2559cfe120f01eb9c5dc728d1f7cfbd89730","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.4-rc.3","_nodeVersion":"16.13.0","_npmVersion":"lerna/4.0.0/node@v16.13.0+x64 (linux)","dist":{"integrity":"sha512-bs+ECKWhKR/oFTIP4JBWdSnkO2ZzIBfbU9afEdS8J1fuILshYLhL7TTdwcsmLHqEYtiBDKuhFrAtodQbdCqxKg==","shasum":"d634e4106b85c5de5bdfe0c528477b45f565a813","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.4-rc.3.tgz","fileCount":80,"unpackedSize":194675,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhngdjCRA9TVsSAnZWagAAd5EP/R2dmJtuz5nlA7gSsrZD\ntcuV4RKEQK48HZwPrTzGY77LTyUbnhMnuPJex2fnlsr4+lPl5LlDldbFu8iB\n4avjETWy+HYeOAfymBX67lfnVTzcInKLjptpQR4gnwVOqSD2tQYo2lTkvhdS\n2uMcGqe3H+qjC65npXpQ3M0Wef9Kcg7xbNiqe7omML3EuaQW0+lELb2pRxxG\nUUraw7/f6TxaZute1UeYOXULnsrUq0k5u00qNnDlVQv8/rKfoHMC0o2PHklq\n4meNT/MwyGHOWmG0p4ki29xrtqHHBnob2r8+tLcmBLYhCUFygg/VbKIafHGj\nUXcICDGty3pt8JjjNJpP1oJjjSggRDJJRQpJYCEflKeq246FUYjuYgh4lgja\nmaJyKKMlBctWIZek6nxnoFwIpCnIHUHLiPBXEpaqZX4dKiS8Ta1ijV8NCLtE\nxx9zwR0Mxo9I0490iljpIyR2u2KDELVt2kf7qGhhvK/OKHwJAKDVD6/yn79P\nSrz+UlJKQAiP+CJ9PwAUCc01rnhOBoAFz60m3ydTplGdPJPqg5Q7BRuLo+Zx\nwjt7VL1XYPAiDAp6C0sYbjpGY4QExVr+IHd/BTzXucq4wMVNxQFsLdi6cuRQ\n7Mxh+NZXIe9b8zoL2I44I+zcTA44iUFvgASmIOoVVWVj577ER4MJkgkH68QQ\nEOVA\r\n=VprA\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIH3QEqw/QJuGqANu4eKK8JwE0d5tjx1EcVtEWhgiRu3NAiEA+m1kKmYUalPUowniTdfaqeTqz0YY9GJny51ctDxIpGk="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.4-rc.3_1637746531054_0.8688860530176079"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.4":{"name":"ipfs-core-types","version":"0.8.4","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"6178708aedf5ea86bf537862c08db49f5b8ea20b","_id":"ipfs-core-types@0.8.4","_nodeVersion":"16.11.1","_npmVersion":"lerna/4.0.0/node@v16.11.1+x64 (darwin)","dist":{"integrity":"sha512-sbRZA1QX3xJ6ywTiVQZMOxhlhp4osAZX2SXx3azOLxAtxmGWDMkHYt722VV4nZ2GyJy8qyk5GHQIZ0uvQnpaTg==","shasum":"4d483dc6035714ea48a0b02e3f82b6c6d55c8525","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.4.tgz","fileCount":80,"unpackedSize":194834,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhngfkCRA9TVsSAnZWagAAgCkP/js+w00X0JyJmXsMxJa3\niQ3vw6gwMAw1cjvPqLpaoj4D5OCrdyhpokH9IKcPt2RF1n/3eNAjP4cIcyay\na9xGEjSyZwTwk3xdJm+TWhBfL0GmkqiUYoKIPbV+L3ohhOUMD++5Hr+iEp4T\nDOFlPzcv7ioO496zlXj8UDNCdQneDq/NMg1909By3ipjXuWOimAoSvWWPLnq\nQVcK98rG8jE9KFSREgCI+Vohcw+EHa/EO+Ysku/zBZBeRpzg/y7s7NOIgj+l\nUMmpN45fLqu6tVKmVeRLvTjsQpN4wD5Jpeq/2p2YsZyKcbya9QklpUQ5BAo9\nl2u6MOGDvM08x+lA9eTRb5wQ0i33PBhTCURmcrR0a1QbGScpInwwLyKwwpjL\n8ZGs7/s9tIoHsTPNexWqF17Eo6HhIwjandj8WxveXbVbnoFsuGEr0elnw3P0\no66Sqi7rNYyqfj30dsl2b/ZmQ8TW0dxlB49R00+GCuwfqg/itnK6jWyFRuB8\nLuy9zELhsA99y5Giq5KM4dGGdACnaElqA9LycWVN/2ttlIGS2J3YOJ5mg8Wc\nP9AGn5B01uQremamrWaXV+qI9ZJirXjXUbKOg9il1tWCidI/FvcM6fDhS9xY\nGlqKmLe5g3DcEiXVrvCsEI43LhDk3EgVUCP6SZ2L+J5QvZKE5IEac4wxlhN2\nJutO\r\n=EE/g\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICTiP/v06Cvb5/gzmfKdIAtwXdW1WzxqmvZklWWn3f1hAiEA4irk+gflJfrNqzAYGn38RSN9DndvutAJzRwdDjq2xG0="}]},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.4_1637746660688_0.21322021406754166"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.5-rc.0":{"name":"ipfs-core-types","version":"0.8.5-rc.0","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"6178708aedf5ea86bf537862c08db49f5b8ea20b","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.5-rc.0","_nodeVersion":"16.13.0","_npmVersion":"lerna/4.0.0/node@v16.13.0+x64 (linux)","dist":{"integrity":"sha512-yF8S7hKtuXBNrPUiEGkC0+hMoEc3k767i8lJ8OuNclCSJQmJqAU3vEIlSJzrneAt79/wFUTXuVSsRIRpwGhKeA==","shasum":"c1cd0811f7de5046011513f18c19e2cb56b0cdfb","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.5-rc.0.tgz","fileCount":80,"unpackedSize":194848,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhnghMCRA9TVsSAnZWagAAe5QP/3FC1jXsaDAjbkKbji1W\nuzaOVRKV1KU5h39G5D9c+9tiT7dahUo/CQtZvtLI0YsUJ3oFmPifeq8/htKo\n0yqjFsBGoBmkBf4Gu/Z+vTaFlwh8UQ0593oNe/e00nawlOFEEGZh+8xpl7dW\nbSXpFgibAR3sXOHUaiBWEYW3LNXH8DHeUZ4ZoBu0F7LOQkKNLICfRUflwr+1\nuA1LHnp6WLD8LDuhe9GH59JmxunrRhxmchFUxNiu/gG3+yi+qPROCeBUhjlQ\na0S95jEyQJ7zy1MVUOQ9Lfx3J9PiSn3byrFFjk4DTM6mHvuAe5AjOZxFwKfB\nU6NNctOpJqEFYhKOeWGfle0a7hqtTY27tupF6bFww2sBDnEGS7nLk+RUnpMF\nu+tx86HwZgWoUM2R/KhlEEDO2SsrWq6yNIQwjdS8rS4CQIzkHxRLW+Hohq/N\ngFjfRr7Ui1MK6R8rraqN585FPii0QZfAKLhdijnO5WoijwfYRh7JQt9Nljez\njxJGV/23gj3bilHJL4HMJWvOueao5sdVd/zLnEUmMMrW4Et62aMPLlgyo1hy\nw/qbmKf2wWcfypnxm16cgiu8kgGLN0LsWN1BS6MZFw8h8CLGPtGMw9B2THR/\nGuCRWcL8aS0/zY6zvsJOLdvkAWIW1pHxpRM8pBHE3yU8/p7SRckFcl1TXXjQ\n/djs\r\n=7rJm\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGtjxQEbrqGRRaRlvnfQgDljgIwh43pJvQtDAuxYInDKAiEAgiywfuOh72I4n3b6jwORJz+80V63WJZL33EFMX2z0NQ="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.5-rc.0_1637746764136_0.2372618154655486"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.5-rc.1":{"name":"ipfs-core-types","version":"0.8.5-rc.1","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"62d8ecbc723e693a2544e69172d99c576d187c23","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.5-rc.1","_nodeVersion":"16.13.0","_npmVersion":"lerna/4.0.0/node@v16.13.0+x64 (linux)","dist":{"integrity":"sha512-pL+gl6vniuABt9lHOnclqEiAgEGFOHClSke8+Cvg0SPOSOd9XJz56KVx/g2uBwVxIvbvAozcQYRBYp2yhELt7Q==","shasum":"7dab583d54fd9049976d099a29e1f4264bbfac4e","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.5-rc.1.tgz","fileCount":80,"unpackedSize":199221,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhqfbBCRA9TVsSAnZWagAAKP0P/REZUdWta+CFGR2OxSuf\nxDIIdfjvOlKcr2cQUc5NKMhYSyPypUdk2DfkW1+thDaEkrYt104kQqkSFt7R\nfPPAHUR2vS3DTIEwTQgGrJedlQrSkhxuc7ReAnqHNQrS07CglnyaqJOm/lwk\nd7jdu50Swfvz7+ETi8d/o/11yuwvE3L/kyvdN3OIzQdJdkkg8h5oquiiizr7\nLIEHCZQC1m7tyvzPxDQTcLK7uGZFqlXkJln5ScSBe9Y4bDnHuyNHtjNSLD56\nqkdFYY12GW7GJDALkLTKDqhU1nMwTHYtJddF78zNqp52BO2AEx7VhTzHJ75Y\nUOvGux26uJb0U1UbEgEfXYQPQg3p6VoILaJKD/Tzx3M9L2jakCLQayFufzys\nWr4IpbiXqFAwWpNHaSa2UTQOCVSwJCTd76MYcd61ihKrZqKphM9BY9aLE2Sy\ntDSABUirscbyssTIahXLmAvm3tyREk8U+QoURG8ZtWsaxVbsfb0ZTNxkvtwS\nf/QCryhadC2M+ltjZP1F5s4wiOs1FaY+0tQopwnddsq0aI1CrzJdKK5XrZUC\n5PEXczT2sIT/3bXKoLIIRjeCNgjvUC2wyM88nKOTEyqpJE7CGZSjK1oymNxb\nwJocjNVQnH5gsjTn95uFO+1R8T9au1Yz9abc1299AQPM604UbsRd/O73CUTN\nzqAL\r\n=LwkX\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBRu3sAAKJRa2jtynBNPNszxYv4G6Unebxy7ELpiJnj6AiAxG2AbFT4z21+/7yxq6NqZ+svktgvk3YLtYJdN0OO4YA=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.5-rc.1_1638528705208_0.5604670533102574"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.5-rc.2":{"name":"ipfs-core-types","version":"0.8.5-rc.2","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"0c269cf67a8f6b48809472e83c4c1cff156afe0b","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.5-rc.2","_nodeVersion":"16.13.0","_npmVersion":"lerna/4.0.0/node@v16.13.0+x64 (linux)","dist":{"integrity":"sha512-Ex2Jr8Z5XNtvRz0FL2+Q4e3Tt6H/yZhsWAk1uniAv1yBZwsAEeNu8h+kX7stmcJ7FZ4wkX/pgsz8OH7q7SFfjw==","shasum":"6c34e47efaed49f2172857a7e184c6623fb04aad","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.5-rc.2.tgz","fileCount":80,"unpackedSize":199396,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhqhr1CRA9TVsSAnZWagAAuXwP/2VZ8Z7MxxKbPXGPJ8vg\nhNBSzdgkiSDk3JBCyDSMOtkP5Q0aJ1H712EBVf2POQ9CJB/MfZepNIH7hpjm\n/wmy5GTwHMVz1NSyZOZCRuNt+GCsByaedvrxlBBol+0Bm6sbMlEdpR3clmhR\nimrhQfqNdjxOmbpeqHWM5mNEAeQwvJFfXRuPhLIv+hdjkWanAysjCKp4pju5\nwVeePMsG2JSArANlq2iQIOQZeT/zhF6rOk9R1W6093e8jZoHqOQTDQQIfZpo\nzQRopRoJkusXVLWSFlKJshVAXiPg2J+XRp10g2YNb7BasEXjnkmDm/PBmOn4\naTnftXN1D/oaW9nfNDyytcdw4CC2wK0X8tdyjFx9ql3sGuYN8rTSV3HoQ93z\nAstS3mPOs4GutkLiDPotipqt0qZgF/LvNDFFsHE7zNZexlq4S4A5q5rtaA3d\n9KY/6LbjG8SfUV46O02OCW1Y4e7aXDgPIVH9/qiq/qwg06SHyQtPjAcYuKLh\nSiTy/AG60MLa+TouAX7LmkRozjLI7V2uVqV8M/+9yav0VO8NXccuuDFyDiuP\n33o7uQB0PsRfI/qDS4s8KAFZZSLvjB6E9h9yszeRgF8m3AVl4OHFINHhWSq4\nBVJOyi6/+zdnnpQdYKT9c5K2L1bl+v7uZOU/vUGQU4eQffxPRJG7m+0IGRVb\nKeHO\r\n=cZYy\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCsOqzaRFz4jShcINE7laIge/SBc2RV2rD32W4z+UTTvwIgYrJDp8oU1aLHgDlPtTls7V+LLO1o2ivewOQgbG/WrxI="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.5-rc.2_1638537972869_0.7611206743514904"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.5-rc.3":{"name":"ipfs-core-types","version":"0.8.5-rc.3","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"38c01be03b4fd5f401cd9b698cfdb4237d835b01","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.5-rc.3","_nodeVersion":"16.13.0","_npmVersion":"lerna/4.0.0/node@v16.13.0+x64 (linux)","dist":{"integrity":"sha512-3VTqB0bNrNMuPuCyhRND+xkik9mFdoVbYuQm1ZRgfsknJkIAD/OwiY/LCfPEC0lm/XK2Rl0n5kxFpnKB+JEG9A==","shasum":"21103c35bc7b0ba32f4986973458f118572bfe69","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.5-rc.3.tgz","fileCount":80,"unpackedSize":199767,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhqiQeCRA9TVsSAnZWagAA+d4P/0ukYuDR7dvi97A1axiO\npJaEijPEPRxmwUAMKTMgZawP8FsIjErdP6O6eoCLhY2iHsDrTBzyRhbZ57/e\nT8AnFM5jxT7LeeJik9D2qovOCuTDUpwmL1fa2hLSBoPasqVUTV5irCVacWBL\nklKKuNnl8EZfAjlt0YE0ABQC//ynj2ltt3wSgo2KIJ35PDqoGCZXDXeRzU45\nNSqq3IoBkpf9+sWX7vviABQn5BlCZoiZsi9gNrxCXaK93PPL7FaF5waHJHo3\nFtzgL482LeLl0J5uqcm3VWnC92RmuygFWW2J+Oksg9qFJjZXTggXQjmdAO2k\ns8d0Almlr5LJlQ+lR1BJgM+pR3PmTBYxHiHXQWZ8eSsjrCSAw/McMmTbeN9l\nBi3/0TPjN2Z0iV1ypcKpODlYhgrl3V4XlYILStZx8mErPE7IzRbQqvyQfi1x\nsaO9MMyO82a/jkt9VDyuB/MmVWz+H4HtWrZKkXcysVrWS1GKaeozTD8r0Hbg\n6KYNubKhijZpUKKQEW6sIzeefDx3pyoiOgQeP5x9vszi40qMfVstZ3XXfIL7\nQ7DClk8B/IPtpeHmbRkLgnFDC/OZZQNKUwK8fdbJKzEs10GHNEDNUGjhmjL0\nKvV65/0JGM+Nk+s6LqviIPtPC8ua/5fad+6alwkNIIbgpe9vIHP+Jma8pGtD\ntEpx\r\n=uvxv\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEagVGWl76XWjX7loHIbR6lKXrOu2cQkaJ47y57WKrrWAiEAsIqbrifMxr8MQ7cnOkfTXLcA3eXO3DvdH5ujZNlFRg0="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.5-rc.3_1638540318553_0.5453215844554655"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.5-rc.4":{"name":"ipfs-core-types","version":"0.8.5-rc.4","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"9018432d5dbea466b8332b0a917a166942e40d29","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.5-rc.4","_nodeVersion":"16.13.0","_npmVersion":"lerna/4.0.0/node@v16.13.0+x64 (linux)","dist":{"integrity":"sha512-qJBaH3KNXt83lHKILFMSLeJPS6eVvGcSxRBJEmNt4jaIz7vUJlhY+Sjh/zG2NJKW9tKWITryM54Yef3eIJFUgA==","shasum":"076b20b08abfde5e87b71dee9513d828acb6d4f0","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.5-rc.4.tgz","fileCount":80,"unpackedSize":199767,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhqjFGCRA9TVsSAnZWagAAShEP/1C/FfCiYIl+qrXFdIci\n7QRnNaAagg6mVERr5bK7lEDyjWeNujQg6iCmBkxB6Gsb9tSR9bUyhk4QV2+Q\nmi+Dg1PVpttTtUdxOhyPYaOwGJTnebL75ZBD7C6eyLBw26CJFunrUaA34rrY\n0JMYO9uBMdPVirU28jEWdt2QPvElZLAyGzI99myqpRjvB+ZVKptBYq3pR5A3\nLLpxdz/u4HtO6elyQZknAgAktP0+OTgfPActUlAT7tlL+VzwGa4lBLm1GSU0\nYqpEpLD55e+XUckv/iD7n0UYbxN17T+fUd+FUgaMvgbA0rA76DxHNK+zq2Ii\nNXVkUsD2PBl1qUhbU/TlmGlzetvVhFHvJSXsQU/TZmTStgG6LMqMyk2SMjrk\nJjaysMO08/lUCCkTF7bsbpNzDiZ/OFJssUxDyJPNRsyfSbzaAR1DJ7t3/32Q\n0fjY7Z/LwwtlUU9U63tOoRmEAFiERl/FA6Slz5dbaLv20PRprEmncwoGnrUG\nirdx68J/pT8WcA67jnA0cQxpuwzFaIdXiMQQmHCqBeuCUYXFPDHy00PQF0ZV\nQfESrVD1W5z1Hg0c731svPBgCiPjvIqyYmbQ6RfuCjZ2/24LFtXrUDIPALul\n+h3wo2255CAg3mN6bqoXwKJlnll55dgrnqOBtWt4+HgyaJVYqvrEX7j+cMVU\nAaxg\r\n=7fn1\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCJfgVl/0PYf+r5xUuE2MmdG8Ra+Z7E068shRDCQTASkAIhANXhoooKKj9rA6PUbyNUEIDmC2M8Vnwm4XcvRXRvTQWS"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.5-rc.4_1638543685844_0.6840558266669672"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.5-rc.5":{"name":"ipfs-core-types","version":"0.8.5-rc.5","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"45ac9730d6484e8324acfbc3579fce052b8452d7","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.5-rc.5","_nodeVersion":"16.13.0","_npmVersion":"lerna/4.0.0/node@v16.13.0+x64 (linux)","dist":{"integrity":"sha512-PnLRFgyiBBc9RADM0kBLGHRe6YfxoV164rU6sXHnHHm5yjx3S9eTuDhjG1lQvgYzos6O3Yxlia25XIPAkxyWkg==","shasum":"892d639cd1f72c013810cf98b916df144ac54703","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.5-rc.5.tgz","fileCount":80,"unpackedSize":199767,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhrefyCRA9TVsSAnZWagAAQPwP/RMFHnJjt+oAfLcJfBlq\nLzaOCR1/jqw5uZ6ZX1rbLH0b9voNCMVrFx9VPrhmDFw2l6VcIQZiYsQSRVA0\n2xq+NptGflm0tFAT0nmmHZ4aF328SDs/qi/imsiOqOECxX0I3JDdT6hX99xY\nN1OHAdPjZvygPScumrbrFYbl8GNxxPOOMX5H6vbMAWdYCACYzAYHmBLuwG85\nIwt9DG5cUxp6/WFQHQ8wU4j9XZqc5Dn6CPmlNjfH9rK1eUqxlCs2Ajb4dus2\nA80TJGuxpWtZQfSfpQOD4GnShLbaeC5CgfHNK6b09LWkqFKs/XCzOQjLV++v\nPtyxirCEY2BSZe6o+XK1GjmuEwzOHQkHn2zf1iG8ssrZTt5gc+Zu8u9ywj5v\nSe4CcAh/C8KX+uTd1tkXGcGQf9YwRRRwdCTXz8TWrHLEYqxFC/Vah05vfBu/\nfkvwcWiad/I6JySZ5kJN6VvotBPjIp8X8n+xHZu0pbQDzf2mLMwV3CyxO+ol\nQsydIC55jKg5317K9irMeiMshvirytww1e3uGkwZvvld6lqWJdAyGTPT0xuN\nWuG1WuH3lX9/4pYwvJkw9jChv5X0fyKdxX2AmhSOISBoiwDOcMSDJJploBqm\nM1dY2dRMPmnP0pAFlixPIZ7bOn6OvMOzN2G4WoR3QyxFcMHrtYPBz3vWwJ13\nuDSU\r\n=KGbT\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDWPlV0rMMF3BJ80KVQx7pxVT1Q9y7dFyZUlIGCA5UKQAIhAN7s0Bb1GTY8B0LqQP1kym+NpD2oqmoYYT3sxG4xTbCW"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.5-rc.5_1638787057928_0.1710853895361364"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.5-rc.6":{"name":"ipfs-core-types","version":"0.8.5-rc.6","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"80ac58ca27cc9f21823a23d1e6357f738fdb6781","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.5-rc.6","_nodeVersion":"16.13.0","_npmVersion":"lerna/4.0.0/node@v16.13.0+x64 (linux)","dist":{"integrity":"sha512-NF7eFL2jCRpCutAjLahOqmoXM0yLwPYz5SIqepcSqh4iEmpz1sldHiUYCjKR55x2410FUiGjKX9aXVUxuSKytA==","shasum":"06ba7b42fba3479b5b810fc84d89af26c03c4fec","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.5-rc.6.tgz","fileCount":80,"unpackedSize":199767,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhrjo6CRA9TVsSAnZWagAAyJAP/j+kl1RSUa5pLkPV3ekW\n9mSN3mbV9vdCyrs6Cq7PHWaJ8t2FnZ6aL8Q3GqQn0GbMvRQSRkpTUrC8usGP\n0/OmOMkFlQKrKkyuJTGIFrNC3S2WJkNQO0Q7Ikh5SCFwdw00Lh+/OWEIV9fn\nGr82J0AAwI0G+DHdQDfVVs8ccmwBlSri7ibBMu0o9in+13Cz5VGkWuYIz72x\n9jDfsYjMj+POm6ETBgBobj99MYav4sgfFAJNrsuUq2bQQ6JKR/oaJuYJ9jTr\nbtb+TnBROed142CBf8A2YpCCP8D9ep3Zcy+9xUJwGufO9rhK69FK3vuTBfzM\n9kHOS6w9wNZy1debyRfoB7Pw3LQQ7t5WnuvV2JX1JH9pB8+oog/Ul4nPrukg\nbpdZcu+uVA0YLAbeqJCP/yeWO7k5QtB3in4AyxuMzkqs2FqxYvPWGw1/r8cx\n+jpOgSi0WGetkFMjMT34L8Y8wzdo+jAzHDM6/3mwq2YbXS1Z/5TlcBvLHDjg\n5wWbHSouJlGqLNNvjPO+85PeNIRKvnHh+GmNNFBorA0xXfYJPX1ua58q3K5B\nIAM/n3bwSbpA0889MUEvHcej44bIJ2+AsBTEOaRvD2l5kE0TFQ9k/urxJoBe\nAUufNd7WSj0LFxWj9YoBsLf/oqOWP8aDWDcQ5Ibn5y5cmCF4lNoPBQpkGol1\nR+kU\r\n=R9BF\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGvHgTuOFcOi1KXu54NzNh82nkjAb76aY/GXURs+u9ZMAiEAkES+H/oyoDy6RTzFnjxjzLHKeMQ8BvazzQ+R/MG2k6w="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.5-rc.6_1638808122256_0.6293367789206941"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.5-rc.7":{"name":"ipfs-core-types","version":"0.8.5-rc.7","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"c083645ee68aee2fd40f0bd63fc5b4d1395b5b33","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.5-rc.7","_nodeVersion":"16.13.0","_npmVersion":"lerna/4.0.0/node@v16.13.0+x64 (linux)","dist":{"integrity":"sha512-gUKDzSgal+xRc2kXbGk80q3GKBZZDVbhVTsls2ZLoEjybiPGV9f3EU2rynzQRBwMwVMEd5HiHV625HgjjA/LPA==","shasum":"e42fb6ba74251f8bb8522feac1dd4b56116527d1","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.5-rc.7.tgz","fileCount":80,"unpackedSize":199767,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhro1gCRA9TVsSAnZWagAAIokP/jraXaiQAmrvk6lTgCe1\nXRQbApkrN3wNk8Zdrxs4iN8cafc4rAZzePwHtY5D1sOGjIrVL2K5Ge2r1MGb\nmoYw0hGgZgOOEEN371xNYzkq2YlTBHgpG+4WCX0aO9JPK2eFBVKjyTOxCdpa\nKoq+xMzwgUxrGUlzW9tmJdCcsy9oFIU7xLEdTGYIC6+uu6hohtWAFgTmU071\nZh5bX3xvjrQYSVlCq6e3EaXoeSZ0v0RD/97I9X5OPHbBpLWOieLhT8ga7e0l\npqoO/JRdB79f0BhTODtSUPCFtSaEqm5Md60wVhbHU9yZRhH+vb2+lcwshprk\nPlRR4PWetUYaXzl7LU1kZJ27sH9AWxtowmGUmj4VI89AhYibUBkhUp9F+XQk\nCAMvd7wEfGccHoJTSfoJj+uBZxEP/CN/acHG/umnb/21pblfFEdzQdJEmdSt\nUdwRmATmUHUX7kqRvdACnUGcXqNVo+njyCDYCuswwCc5TRq2M3QHYiiA3XsR\njpUAr2WBmnUkIbCZ0DAnHg4pL7M8nue06jCy5dzxTpnVzzUfZY4iEUfvQdlB\nwwLXwtEhB4nYA03ZzIzmmpICG7oXMFubsbB51vD8Wt3ixRWLJ+AQYGcH7Cjm\nCb5J8e5IGOkpUR7mvQjG/PDO0p7hh8dT585erstflLj7A5dn509cGDugGBR9\n/d4O\r\n=qq12\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDrz3E5dBDVwhEW7tBk6zhuufnjC4ymsZnyh52+u2NPcwIhAJGDwvATiPi3nfjhmJJRZNJHACSOFpsgkZ2gLY6OjdVN"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.5-rc.7_1638829408711_0.4130941538160664"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.5-rc.8":{"name":"ipfs-core-types","version":"0.8.5-rc.8","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"dec9e4c87ca7829761ae6f63a4809783e53ae558","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.5-rc.8","_nodeVersion":"16.13.1","_npmVersion":"lerna/4.0.0/node@v16.13.1+x64 (linux)","dist":{"integrity":"sha512-2iB5wyEo5uuZxQtAM/62wfSLDmXdT42mBwHMF7iqiP161LKXvJnCqS7h9qat/dGYUycBOYS3gmRjlT/AYY/bNQ==","shasum":"1fc8d4592e6c5c50415c0b38b5f7b9c6dc572416","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.5-rc.8.tgz","fileCount":80,"unpackedSize":199767,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhty+9CRA9TVsSAnZWagAAZSsP/2jdp/mojnOca+KNdpwB\nfqRjeUmdVpr4O6o9J58jia3tJ47CH+Xte5c/3kWbHgrf4OCSzscv0DADKzOD\ngW23vUnG/lVjjrhzHb7qXW71PNM8MROrIj3xkkA72jYFfrZxL6AOa9gqLMCQ\nDGASffG+4COFy0f+oOgEuaBU4VcUkIdxMJzDIYVAMTSqGxFCBhdGSDcAEbo8\nqf66fLooDpaZO1JqoaArzvEvH2JJ2amYTu4kAgS+atV5J5Muw6YeTEkg8M0i\nYtQOkcd1wcaRVNJXG2cSy1kq12QFQMpQZxqLZ7YHEeEf//kKU98W0qH/aIs2\nVqb83drRjAmPWrpyPkHE6j+TchvFTqm6zKDSEtdR4xmkEhleHjylP9AWpX2W\n8eE1KEBye8d6sdOW/qOOdIcMm7nuPBtIDy3kPpwVJI/dvo2lZPF1KOFoq+hV\n2ybPgY2gm2pvWF25ypYba4q/tc+A1PRFPK2D3LIn/OZg1J+jhszIXWv//+Lv\nDPGDuys1kCbVtzq8qSD+MpDvIAXl8RypYQ/HZvEjMmhy6iQMbUzR7oT7zFU9\nEOtH9R/hUCyvgIL6v9dfFMMqqwjpTG3yTbTdHql44ErmiZe0VVQPyb+h092M\nUM+EFjhKUwVhoX2xVmVslVHHuAUV9zUjNu2Xkma9Ts3q6VWjidGnvK/YeYYQ\nxRHM\r\n=fDWH\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIC8kFhw3+ahx4tEVez/jJLE4In5Zh33mKDnkpxjIMFUHAiEA4+hZw454bsxHaJGVLNJUAXw0krWk0qJwYJoNBFO+494="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.5-rc.8_1639395261347_0.8828418273525107"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.5-rc.9":{"name":"ipfs-core-types","version":"0.8.5-rc.9","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"adde8c13ba433b81e76033c418607be389fb3d31","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.5-rc.9","_nodeVersion":"16.13.1","_npmVersion":"lerna/4.0.0/node@v16.13.1+x64 (linux)","dist":{"integrity":"sha512-v+FlfwQxL9wxOrqkb9jaWRRexQf0/PS3LjN7nYT5ri4ZoCkuHW7L0Z1vlTBi8eHOifgs06UzXeyehbqJWSf96g==","shasum":"7e09d3c4bc9d7cb005dcae49f075d462f136780c","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.5-rc.9.tgz","fileCount":80,"unpackedSize":199767,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhtzfrCRA9TVsSAnZWagAACNwQAJ1W7qezRUFPRZpxEb7G\n8QhxyhwMuZVXrcCXXRqrGEGlUosJ2xo2N6UNAhv+okvFXmo8ttkdxf0TedpU\nOsBxuFJlNtEDhkDd++6firDVE2DDUYWiCM5BxG0ZIxbsgIUW08EALQsEP+ki\njIrzeMsjy9+/7JRhTj23KFTYwtHtMuK3pL8DHYi44DlDIU6P3+I8QAhZQJii\nNJeTmjBy2x2spbvzED1So/moSpWA7vm6Z9IlS11Erb+TxwKlEIVk00l//2So\n1ruWT5NDr3AxZURt4LIT1cXzYC5la5BEVsGDPypqhRDIIdV6fhswHR8BwIwW\ng3cZT4r0XvNgUzhteuAUILq7Vh0IMDwY746KkOGGb08zsSlX8a89nEtIgCyp\nmvWiWyJRdnNxZv88TFn/dpveEsLwWJzvRUdyb9pgmHEVOq4za+k9ReqpmkX4\nGrVFTIZvn6wnp+XgMjBywSOM52Q0WVAoC++NBjZI5sA5s+UIjKz702b93ai5\nzVAx1fi1KzcECR1Cx0qPr65iUa011M5Qza8P1ryyYut2cEXt0vpsvbk0nhVE\n6p2OMS9ZfESs2n8qcEBp6TvfXJn5lTM7HFL8XD8nHDk/PjL3wUOdrW3Ib/5t\nRXXhrwDzi48J+mMSf54lJzqbz5kgcOzOGQPars1yeMkbuwL78lETNNG6qGOz\npXZL\r\n=3Vs+\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDEvjfhcwRqYjVDRH8DHOEy3xgXkud9sLxNJHYDF5oqQQIhAJcHRLGGez9WltYfwgoS1HSzT/3IlaCFDp2KtCF8gnuB"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.5-rc.9_1639397354978_0.8769230192661042"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.5-rc.11":{"name":"ipfs-core-types","version":"0.8.5-rc.11","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"33f1034a6fc257f1a87de7bb38d876925f61cb5f","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.5-rc.11","_nodeVersion":"16.13.1","_npmVersion":"lerna/4.0.0/node@v16.13.1+x64 (linux)","dist":{"integrity":"sha512-XuYqyR3NX4suLTIdCDH5BojH6jn/fi01n3AgP9/j1G/tGscUqKmfsfAEcybZ0Vb7YbHNDhDVEJ9Zy8THDUBNDw==","shasum":"4a86f17d7ae8fe268374ff38a33f2dd18f970587","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.5-rc.11.tgz","fileCount":80,"unpackedSize":199768,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhueSACRA9TVsSAnZWagAAdM4P/0mxioVRkvp6kRYG6BbO\nvnsd2PWySNr36VGXGXEwKmFN959ZwzjWISOR9DlOUav7/MykXHD4SxtVudvL\nKw5QOwqDsUQenHEX3HQsvX4a90eCABLtW4GwewdNACw3itVFf+kiVUOx+SvJ\nOJ5J2KGqWxxX1NEYkAG3to8LIdRVJx00AZ0JsGNbrXH1ZQpzztetCk2ILDth\nQlImZCgXjiNTZn2X63aeyWx+sQbfhyzcdvDvlkJf8AYYbU7u5WgrD+bVuhWE\nRu/BjdAQf5natWny3RTAc/9s0ZjVSasrn9uSC5y6e05/s+leseoTNHJJY+S5\nJfm+bANM7HF6HRekONKDzDLzPcmyRrQU+ZYORCK+nZNZsuFCnN7tjQ7XnLsa\nTvF6dNqLrrYnIEr/U7k+EGdHRX78b7e+J89uTz5nila7kxiNRNhXrH7WMuXN\nfGHQM5XfoCan69bLvtsPqKJF087NqPNxQWmzHwMtv8S71ZP/lfPEUrUk6suv\ngeXgyhgImGh6c/NJ3ldEss1onvjZsRo8iTvCI44VW8TA8LrKMJrR/oA7kCbz\nMzTipo1Qup8zZHMcSPXTN85+O4Qey/NsQcWUtSQgKbTYbJiaSaA/6o/WW5Z8\nbRiK5j6cb3GFUymfSaOc73EdZWVI6ZF+e5TjBZYjTveUwf7v3N2xKN1XEU1T\ntfeL\r\n=9bOF\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCW7HCzQ2R79lzDjplfDWcjMROxOB6a9JRUAsQEWUBzvQIgG5isOGF37/D3pHyIC5Yz+QmrRl7fsIAh5R+sfBStU7g="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.5-rc.11_1639572608693_0.9073838922219954"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.5-rc.10":{"name":"ipfs-core-types","version":"0.8.5-rc.10","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"73476f55e39ecfb01eb2b4880637aad658f51bc2","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.5-rc.10","_nodeVersion":"16.13.1","_npmVersion":"lerna/4.0.0/node@v16.13.1+x64 (linux)","dist":{"integrity":"sha512-0Pfr6iiKtI7t5z95DsRzuHLu4bLRa314j3EYupi8lsxlBeiAgNmXamkM/P3kjCD9/OXoYBdrtX2f5j+jgWiuqA==","shasum":"1c7daa65e0ad726b9c48688c880144bf46140642","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.5-rc.10.tgz","fileCount":80,"unpackedSize":199768,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhueSOCRA9TVsSAnZWagAAol4P+gNwqecG0E8lsc+Z7OyT\nl2o4BJig7k1BM2vozOr2KkAijT6IgYk2IVXdwvkPxyYGo3UKV8g+EFePimUP\nJ7Xq73xwZwNzgiPSvVRFvUMXBQfgNuagoBfU78k6VOpeaF7dHk6h1raCAoZ9\nKnCTqCrQrmZUYU+XTXcbBVsnlJcJB4rss/YPYqvclCcHktBELrpeXap8OkXe\nGYPs6TV84ChJ9mQNnEvo9H3i6knEkjjzwnrNC0dZPNFpmZJcWNqE/zmshP69\naCCq9h65W2VrmTZdNGzpJD48f2wkqpAha6/oGUfd7Ts7cN5WQNUPZ625BRI6\nQDyW5eARFve5FUr3Vemc5l5RgK2oRRi2iXTxkC+x2c9WCSMvBcZfF8xsy6Y/\neaX+lZGOrwZcHzLJq4iqB99/OXoYedYj0IRw+RlvUxVqrxaaHXXfXgB04HT/\nrhVBL6Mxu26TyVNwoX7KGWOwCMXTL2tJdtILwj2eDfM32Dx+9c+XkHs+1r5U\naIw67mU/52ZckrmKzDNmtN/D4aETccjU0jCheuib6K58tBoz9p3npt6g6SRR\nr+ExqCJzXlk5di8vPhUk2+Gm6Ssre6dyFBGHiotDtzoQWwi3Dj2gX5PvhQ1r\nTMn5Or0nkeQMxh4Wqk+Hp4+bt+h3yaRKiOdbuT7Yr+6onaQwAzAebq0dy++G\nw4LC\r\n=+wiB\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIELkNPp+HnBHNW2wyyuTx7aMW4aDxQzBhKVMsKh/IEQNAiEA45LyCUFD1DRzDEBZh5/Wv79J8cI7vNIkGZXYkPgKWL8="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.5-rc.10_1639572622725_0.017025556560828603"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.5-rc.12":{"name":"ipfs-core-types","version":"0.8.5-rc.12","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"6eeaca452c36fa13be42d704575c577e4ca938f1","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.5-rc.12","_nodeVersion":"16.13.1","_npmVersion":"lerna/4.0.0/node@v16.13.1+x64 (linux)","dist":{"integrity":"sha512-H31lj+tIU+Lo54Xkutr4IMFwsEvTkQ5O4s7l48mwKkdUCp8r55qx37mFkqNF7ohX/wrSES0M0OZDGRikQb0kag==","shasum":"e9b1f67a7531411c429a5d62ad5cc6cc6494c09c","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.5-rc.12.tgz","fileCount":80,"unpackedSize":199768,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhueUhCRA9TVsSAnZWagAAl1QQAJNL+ydcFEau+6WzPKlE\nVlumoAsX8h47WW0wP/Wp2XxSCw7EKJJOqDA5bIIbsq+82+/C6xAKIOOx/8Vp\nLDTwGOx3+3LQKJB0JsgMB8fSNVfNh4bmN3wyp9AdrvwRWaBzl2qrIFCEuK3s\nU8TT9CcctlALqFAN1eL+7Y6TwDrEHXsFGzQd+uafZX8cyrjUCKlfTgx7xFns\nGP9cP0DCPHu73CB802UK88G3x3lD3f3V4GsmAqg5vm39X6YYArM8gVZBsvzQ\n+Ho465VNeoqmk2EEhVUOs+Zh3eMpxrjY87zBsD8ZEuBjF20JOJp7WTYUqgek\nLlGmxzWZMz5bKMesZM3ckgcT1Tq7dnpHfAGPQjJH2UPBuLUTV9Mxz7rNwsWs\n4WBKPygkyVhweGslYpfcJ2EkXar6dt+K5qkjI2Ti4IGa+LTg9uF83BA9bUWG\nO8odQbofyc2EIfBCjTW9GbU8xQ1NhDqL8l1qu6CoG6TOR6xps/qfKVFHD7JE\ntB/Vtap8+ZI/43S3cfIbB7JWm4RRk4gkuJmqGsUjzNza+VkxBEpGaCjY2MsL\nykK4hiID9Yiizga4RUFS/nz84OgL4LbUhYDqE8XOrOIxvU7asC1Lgy4K2rbg\nff83RH0HZFYWkFktjn14Y+PYqrFXICeYtYdzMTH7ibad9lbBWdo7xfYxjK7m\nenFh\r\n=8oXm\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIANt/zog6IcT7yP9YJg1LBygvVSkI+Px9tF1EWaUjLvtAiBg64GKFxtt3hFygy8/FwGAh9FTJfLeYZ1C9PPCAqBYXQ=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.5-rc.12_1639572768983_0.5572694582015945"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.8.5-rc.13":{"name":"ipfs-core-types","version":"0.8.5-rc.13","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"d147494f362d38244bbeafbd6e7d76789c7c5020","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.8.5-rc.13","_nodeVersion":"16.13.1","_npmVersion":"lerna/4.0.0/node@v16.13.1+x64 (linux)","dist":{"integrity":"sha512-6Bf6V+zZLeSd/XGo+7LzU/xjqyBgTASzn8RpcV0rx6W2cfbaV5hUvAfRzMAbUk2BbCXaLN8LkFvcIL6+4Ualvg==","shasum":"355509005ceaa669c963aa3d36794b52b0ed0bdf","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.8.5-rc.13.tgz","fileCount":80,"unpackedSize":199768,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhujL7CRA9TVsSAnZWagAA2OcP/1OzCGZkJ/TChy9nEwpH\nzKUCE3vP5GBloM4nnULX2Wiw+lqoh5cuIe4N8De54XUKhLCUqYn7H8zG0ntr\n2u6JdvnhAz8k8kn7VVXkkrNR/KhdhQqwfBO107q1R26M6OfQ3bUkSRseKM0B\n1M+PcjrdhC+2/d9/kDq1kU6JqM6AIVoL2pNCOol1s0zKQZy7K4/8pdpD/zy/\naZw91wr/eU8yrRGXdyfSRDtO8sTXZyDJHDOgZX/MblPxVVSM4mVPC0z+XotA\nvssbYnUKhNeaCnFKd4hnIW2LckOAqHgKRBHn2z8sBBHiwomvZ8biIlIHftnw\neWFstBt8Tu50sJT9ryPRoJNprUuvv0GT3Qrqs22sCcgmyawnFiqOXpYtIzFD\n/nn3rOljYUtvtIEx55lFOzfeMbuBrRC7lL9sR+1UO/c3gqWYT4G1GFGgYlhI\nTYUazKZwZyclgGssyxrQShY13vfsAXuC+A89nH6iyueTHcDmk1ZrmTzZBqnj\nlAwaa3ZQW8+ubzVe/rrcwWBieA1vEwluY/MiNb3gFU13X2pOYNwwgqQdtpYm\nBlo4LC7VUxh8Y8X3ytmNBIX7VuA1T2ftgzr2mg9Nq18V4ujrlCwrDr77jYll\nY2Ms0n+iPdsUvoOtkXshdTeb2G82p6ZoX99/FSfZLSPZzx3OKH76qrg92tNd\nr7dh\r\n=I/P9\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDORknpIhMthKIrTs7XTT0GVfCrTles7xpQ5trtHoCtjgIgDFDLgs4QpsUGviZdmVACRlROMR5lnkRSnGunNxMNVvQ="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.8.5-rc.13_1639592698864_0.48741049517179613"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.9.0":{"name":"ipfs-core-types","version":"0.9.0","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"7375caa8805298fc671ed4080e1023aafe756151","_id":"ipfs-core-types@0.9.0","_nodeVersion":"16.13.0","_npmVersion":"lerna/4.0.0/node@v16.13.0+x64 (darwin)","dist":{"integrity":"sha512-VJ8vJSHvI1Zm7/SxsZo03T+zzpsg8pkgiIi5hfwSJlsrJ1E2v68QPlnLshGHUSYw89Oxq0IbETYl2pGTFHTWfg==","shasum":"cb201ff7a9470651ba14c4e7fae56661a55bf37e","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.9.0.tgz","fileCount":80,"unpackedSize":200510,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhuk+mCRA9TVsSAnZWagAA/LwP/3WUlU6S864EfphBsNuH\nzhMqQzNdkB5dyxGg3SaCPdVSSrrdxmT1e0A+MDEUrfY6azUgn2vH6o5srKoB\nB1m/PUvRgjOIFeerAjeN0I+3fDo7yYL73RFBbK2rAjldZfnrKdDtwyxtAwje\n/v1hydidOSS5JoWX//ngP0wNVlynHj5kScRht1yTsViNvznvODL/eQ4AclLQ\nWNL4Sq9JeLcQ3T72q28mQWdFPGwaTQ3x+SXJhmEwl4NnUMlpa3845Cy18bWN\nCUaD0cMKyYr/zExXekFxoD97fRBpui8q5FOB0x0f07S9NYbOg3ZVcxOmxjPf\n7J00VA7zLYuJGptnQ7RCSn0qyZToJaumqYmrDOgUwUB4CKs+NbmH/x1rqhr2\nlfgohHvxuc/eiX8nd5JR9cAG0iDIfw+7bILGnXGargmku+cplM1SvRd4NDzg\n+n9NTjab9chwxnUNDVTaRMJz+XXE3HppRRUgOJKUds9oPYpX8CRkmyNaDUYQ\nRzPkReMeWRVeI4koGFILjimKfSYqv0opyg+bi1hFtw+zAbNA2YiFztS4gq25\nuiT7xI1dMoSmXzMJN5fVh8SHai/a3zuUlOnRj0uflv3PIT1xwGWUqfwVlJ2b\n51tM6YbtwmwMF2v8wdjoinIgVtV01I4yuswHUbm1g2V0Jtmn7PJSbInvFav0\nBsSJ\r\n=0b9U\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQClz8J6zSMHZ/XKwyTUdN/BcqUvD/3hkY4+WOk1MKTnhwIhAKSIUHHBief8WwY4oEEtpCgZ9HDXRPP/R1L3pEts65CD"}]},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.9.0_1639600038463_0.9911501576749544"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.9.1-rc.0":{"name":"ipfs-core-types","version":"0.9.1-rc.0","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"7375caa8805298fc671ed4080e1023aafe756151","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.9.1-rc.0","_nodeVersion":"16.13.1","_npmVersion":"lerna/4.0.0/node@v16.13.1+x64 (linux)","dist":{"integrity":"sha512-ZQt9uTxSFq5UHcmZH124/P6Tw64vX5qcEGEI5yPPhtDtRjQfvqyGQnIq8pO/+SoMZI0qX7BHcEj9HIdXh/o1dw==","shasum":"8ed6c356f0225b27f22cc9d8d5672656ed289398","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.9.1-rc.0.tgz","fileCount":80,"unpackedSize":200524,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhulAxCRA9TVsSAnZWagAAnY4QAIvvDA8ijDMF8+ytsGRj\nTWALrn4wRa3Se2JtLZGUcRGHiTQpGYc6haOE7mW+0XIv2lMWVrbpgXcAffQJ\nxIEws+suyWTDEnr3f7yBIWrY9Tta/zXEEkoTPBxbzxTce7rUPq14Hy2pUuWL\n7buO1kadsJbZAg20gChBX+iYXVUyRISxldZG8WlKjTkisOM4XndFyjbF3bWQ\nZFSlaGYUjPoJdAA2Ez7529GsdmBNooP8307xeGMZDBgrVQCqeiOd3v0PjRTF\n9et2btDTXHhg+Y9eMCd0kCEpqMLoqFA2PUp09J7YXgxIV3heTnV2Tycb19Lt\nItikPH9Bqw+N5/UXHqUY79cc40m2HI21ca9igowKCR8iWa6zqwQ9JsB5m6Qo\n2s62pnbYDrXgxDfOlM+wuMYFT5lkNhpUeTH9GIOdkqzHo3rdEA5BuFEdjWLk\n5QcwWtHNkqwJirEQ1GSSdk7I/PhZ2ISe5wwLJ6MzNhh6P9CTheBLuMZ7h1CX\n1WNySmdD836443tYOOkry5DN6pLWPJxa8Or1s55d8uHzwaKAU3pTR4Go3dX1\nJdGA2vfUVaNYM/JYOhEyCBXYJw5rw9ptQNDOn6N+atVATbe2MDzd8PI15F9D\n7yLDRvwOS0mvHqveeP5Lnln7FhkKAXNFCzT/Y6uI/V/7EXQP1P7s624PqV5J\nH1j/\r\n=ercr\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICOSkHeTvc9+a9dsH1w8nUSNIjhGD9GvByzJi1UcibqDAiEA8lNqdU6eSnWYzeRaoWaL9CkeJBv3nCPgJbWHvHmeEgI="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.9.1-rc.0_1639600177607_0.8774266784197942"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.9.1-rc.1":{"name":"ipfs-core-types","version":"0.9.1-rc.1","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"880e47d98cd89d774d707d20bc4a3db8c0d3c5cc","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.9.1-rc.1","_nodeVersion":"16.13.1","_npmVersion":"lerna/4.0.0/node@v16.13.1+x64 (linux)","dist":{"integrity":"sha512-zwpfnLGOSRV2j+CId+jdk8SyTCIsOuq31yyJ3orrZUyOQR7LhaAqVjLubDzVlklljUEEaT9JBJben7DxReRIhg==","shasum":"2156e6f6445e3f1f147413a19e83f2c41641e12c","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.9.1-rc.1.tgz","fileCount":80,"unpackedSize":200524,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhuwGDCRA9TVsSAnZWagAADu8P/jT3QOIQMgaNCFk6h6YZ\nqwX7/JilVuIF51zG4QgZ88kNpslwX0hu7TA+j+ZI64MbXPGQjdwnT6oDBKX/\n//lDnuR0+RFbWd83HxUaPEdp9XtR2bo24PUE3dYTPaSXydQn4tBQERaW1+bS\nF+yyCBh5BGi0iphHYZ8UD2nFoHI9XkVavwd+ROALvnwS3SMkBY5777YIe6Q3\nsfHHCRlJy16NKLSC8JUZXPbSCQ+RdhWNhs4Gl5UZrFuxjSPM/dZq7CbcgeoJ\nl/MVLK4doBbNg0yle1HzYolh+k41zsknTuiIL7r6qsiRhVIZ/7KAis5p4YRT\nIctqbMAIShd9jN8+uNu6Ar/DwVPb2+gMOoaeaIh8UqDWmd18Pl9s0Y0fBg0K\nLIFfRnIUTpFNogpseHV5Sbb3imhxR8HUhQzIbO1mbFrftapeJ/MLIzHbmk9F\nIfrQ3GjjejA8OQXb+wEOfZ4FCtV42aGYf9qftwosZvDVUIrgXdCRPyT7mRF2\nemDFRg06N5flHFig85MYeBernKfM1pFGu35pZ7trK45Nc4rFvIz43P7JphBt\nrcmpk08XxKAGleoZCiNdX6ndnXw922jerQZqPacWIQdVNqT0ZbFoQArlt3cV\niSd5SQPH8ch2CfD8zX1KZUwkOPzs1fHjo5F/fLY5dLsPbinNhB+jA1ENJQld\nnM++\r\n=PWwX\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCjKBIL5M2ZmbmkYKlxKa/T5p7zRprBqpSSsSyXR3qR8wIhAN2w5dsAt+sFZk3wSCGO6huFjHO0tKazBfaE0we4y+UM"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.9.1-rc.1_1639645571235_0.40923013148581"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.9.1-rc.2":{"name":"ipfs-core-types","version":"0.9.1-rc.2","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"45d9baa7576a0ac924f3d01d49371bf1a4cf654c","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.9.1-rc.2","_nodeVersion":"16.13.1","_npmVersion":"lerna/4.0.0/node@v16.13.1+x64 (linux)","dist":{"integrity":"sha512-JU9ZeKc31yKaF+453c6je2JttLEB5leEJ1GVPcCz7/KNCpE+3HMwZ2sv9qdoQTPrkpVoNg+jVCSotvxCIogAhA==","shasum":"d4d08ba5cfe025ea7582454c73c21c77c416a365","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.9.1-rc.2.tgz","fileCount":80,"unpackedSize":200524,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhvF7tCRA9TVsSAnZWagAAhsYQAKQOLSrzSwZRBj61Ww1Y\nNmmICYH+tIAfbuVXCKP6vH0SHR6OhrmsqVKWKy+9aNuMxEWcNVdXtg+DdMq4\nK496ZxJeWW3jeYjCwcxTs5KZ9kUCXO7BLy1j8Lv3H5hUMOkNw5N4utWX4XNO\nLeDdvux8P+6SLeCQTVyXzJw5P3+SdCK4wcZE+QZaW9FAtnN9a7H/SPlHaIzg\nwKDxTnCpGZYwu1xP5rTOAEOJ9QziNjgfvGQwaTRTdS1VatWQpc28dncqPhzM\ny14Hk21dCOayAtD4EDPgEwryfETdcoH26R07Y3P3GMPlxpRkjUh+jf7FthR8\njNvcRN2bThN8XwlHmCWO2/W5ClmNBhFun8CKBEjnuUmujZnCQVSLqCXqD84+\nCV2mYOwNL8wmK0OAuoj4gSyG+S8x4BD18/K6bZqjmYVI3bPj+i0mlLq9xkTz\nQiWDt/s2pTXUbPf18jKovm31Oq9x2w37Yd2DrZJTwhvccHBNo2qx08cdIhO0\nEd4RUf0bM01kjTXcGSURTfrckhIXveHuyWqgZTmixLsbtd6uMUTywrOYSfQz\ndyafZpS7bC+nKh8OMkAXaI0p10BB9JiJckSbd7D799mc6aHqhFwXychEe4M2\nyupx/saTubzCwRbumnAsqlESd3LljUduaAbP0CP7Rrm7kberT9J7Sb72Nynp\nnfoE\r\n=GcER\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDU8uNqXz9i/sSzRZHEpG0SSF04bJ5NH+Jf+dJF5MTAxAIgGHZuFkgINg6p7dq//fyGBNGPI6kL8p91K9oS2CnWG/g="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.9.1-rc.2_1639735021154_0.8125365915431673"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.9.1-rc.3":{"name":"ipfs-core-types","version":"0.9.1-rc.3","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"67a8c47f7eb4ca93ea16defc24b1ebdcf4267971","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.9.1-rc.3","_nodeVersion":"16.13.2","_npmVersion":"lerna/4.0.0/node@v16.13.2+x64 (linux)","dist":{"integrity":"sha512-2GYrOF99Co4nQOjiTV9GtakZR6nN31b0FjOUye+tjqe88yit6B0vyKD8wJJsgeYJ/FHhIu+kKt15lsoTmNpFgw==","shasum":"e78632e60ebbc76a3347d5eef7e4ac401ff9eb8b","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.9.1-rc.3.tgz","fileCount":80,"unpackedSize":200524,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh4G/mCRA9TVsSAnZWagAAeNwP/RuO1yYgVg38hlbgACBA\nMzSxijOefWu/EXTvDTwRUSp3jyaSJScmliktqm9nIaoHkmETnuRZEsaWho8Q\nq5DbR0nPQa7HCFOVlVpg+rweosgzWBIGn7CV/GsNY4w8trTXzoQOK6uFfXu8\nYTRbNfwoZx1SKJ5RsCnB/FW/6UM2QUXieA/VyRL9GGp5poHWOeJoWwhNLEYm\nXkt4e9PL5GraM2ciwce1N0b22sJlOXbJs7TBP73VrcsLSI30w/HmP/DEiHl1\nTO3JhEn8HmIXwkHllavoUExIESyDk4OZs1SgFpe/NoXtPVlnlpOO+UnVKrSJ\nojtcsDERxYJR36kn9XTk529aVpxa2FiSoXcujng3Y3/7qJ8HY/L5lXb9ykoc\nO5f98PBD+MHbSU9HYybAwNjl7oOuFRsRj6JbVQL1/i8E3/aK6iQxm3+C+xEY\nYLKyF3UFovLVSYsAWA3azE7LBtPPOJZBRjnHuxX8HHdtdOVFlAERz5h3OAKG\nm7zl/bKuE3WO/N0IibXS/hSFLzDaacBLskbAgkw5oDiPNzj/78uTyDNPQtgL\nQytK8ED8spuSytmjhmHvmeD5XY/kFrQGDEsZauvjlI+gqUkfbAP7t09FfZUx\ncId2ZJ6qgH0INAp4r6yZ+c9slfHccBgahWhNfkgG8PHsbLGHBa7FijVt7XmG\nChaw\r\n=9hsL\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIF3iSllvSD6MYNFcgq8Zj92MD6dykfwYJIqPG8smVGgfAiEAryQTwOABEYrCG7CqLe1l9IpL1wfgFgwF6SUe1r1znlQ="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.9.1-rc.3_1642098662548_0.5695583214347719"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.9.1-rc.4":{"name":"ipfs-core-types","version":"0.9.1-rc.4","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"902e887e1acac87f607324fa7cb5ad4b14aefcf3","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.9.1-rc.4","_nodeVersion":"16.13.2","_npmVersion":"lerna/4.0.0/node@v16.13.2+x64 (linux)","dist":{"integrity":"sha512-ZltM6WHB1nouoL+Sc4nL0g6eVsj6Bus+XgyqJzVwGThWCkAKlWXD7LYDFskL1qRgtQp4u1U52MrARrEMo6ceBA==","shasum":"a7ceece6111c84c9eeed0c1655d388ee6436e438","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.9.1-rc.4.tgz","fileCount":80,"unpackedSize":200524,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh6XEJCRA9TVsSAnZWagAAugMP/i5zu97SdusYjCmh6bcK\nyXQK7J9h4kBpxLRyJRsPDyz1UfOcTKs0f11gb+1GfJtZVJHU5m4QI3yVQC0U\n/jc3mWPntI9Rki94fUseOQKkSV0XjHLLnbZe7BvO2kWvboV5IcxnoeFxUC6U\naPuAI2FmzOX9yKNpPBZZkw07nvSIP5LvgDuG2IKisictbWACNkpTXD+6K5eb\nTb7RkQo24+AywV3u3pbw17//ggOj92mZ0wLCVdC2a6XIuBL3DQxxnqBL4QUF\n5ZHHCE0gDG5a7oODrbO9EzAbG6Oewi94D3MkliPpVEf3UhB06mINMUSb4J8Z\n7ymCZRTokMTO3cAMu1T2npqHfG1+SO1L720GlvE3Qc5HR7hLSs8pPfbK12C0\ncPIwvjsGD6q6y7Kvg/fl8+abRNn4paUNY+VOtmucktqTubVuUTrjxpnB9X5j\nSKOa9dzu+38CmdeasyhyerEP4PRmWRMgKUiX8CvK72mDub5xceq2GMChFej1\nrGc5CRcJhN9hJYMSAeUXGNYocZ7TCO3LC/mq0TK9SPuXNzlKS6i7xrSmOi4U\nkYXnOl+1G0qmkFyyRkTELZYKufKpnYPT+1i5wRIwDsxjvDQrnrx7t+Wb+tWV\nnKE+pev7F3ueE+FVHfLlTNEbgRZnDCWKyehgiDlky2MGsBGZm+5goE9+Gt7h\nrXKr\r\n=R7s/\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGftqkS7k9ULdHlVOFSpb2uR9dBWcdMuzH7vDIAIoyI2AiEA4yy4L5QMGvaz+5O5QzszaXte1L7mN8H5Lj/+8piEdHk="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.9.1-rc.4_1642688776848_0.7053649573750209"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.9.1-rc.5":{"name":"ipfs-core-types","version":"0.9.1-rc.5","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"b9382bc5bc7341a2771a69b2386e5473b507caf1","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.9.1-rc.5","_nodeVersion":"16.13.2","_npmVersion":"lerna/4.0.0/node@v16.13.2+x64 (linux)","dist":{"integrity":"sha512-MJwVJapwoySfjADWJsy3YvtWekc1n57AtBIC+Jj54vrEhA3xmMEM1ewCD8v71Ed9aolBAGdmZx0+5lMXA1iRHg==","shasum":"f1149aeb9c3d78a88b0f8ba24d3e416b2512c514","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.9.1-rc.5.tgz","fileCount":80,"unpackedSize":200524,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh6tUvCRA9TVsSAnZWagAAZ5EP/2kLuxd95izBILR6AAsm\nY8DdW9Svbk1eq6ZQMwf5l1zupitWNNL1pULSlwS3p/e3inBTZi20QrhdmLsb\nuW0W9kuqiq/QRAnJz5vI3hPnN7y1kzCoyEnKhbdbjBnfnnDgJ8gj9TBg44ep\nRGWltsnKlMcUxfNR7FLBJHpoccMhrdv2BOfu1/IHtOMafHHuXTqmy3vbgHE1\n8kCC3D6jZsrz0ocovF+kEAj0dy2TbVbTGR7soPHeIyEAmps886x4FKYx6d12\nRZH1G0DUbWQ4a9FsX17P8gzTjFY4aqdZFvRe5WnMdYHZZALRIwAIifardetn\nz4048radifZMpTErM72sQGxewzk3bz1JeRy9d8wQRmOfT+MjbmTAegwb2a50\nS8X/A+P6I7mqSGga8SgTGVSbrGC4K1f0GcCBtdHBXp+beIQSySHslZJ57Ju5\nWsorUOKZihVQe+3QnTezzlrwO4yYdsxPSqj0kq265+9v0/mXs9LZgy6V3u2L\nCzCj4l8NSSqn00zOSV7wcqvrOHc6E8SBYC3VDrlpQP0LacK8Zwfztjuliihl\nT0lkXWLkE9bEJ4slYJZZR1XK8FThWxz7+37PlCydQ5hz85cOUYSiny5OCRBZ\n5mJ7VQfsRD47TekRWSpu5m3DRmsHxsH9EuRY+tMe/JAyzkoT+PQWNOvlMD7d\nkHup\r\n=LH4U\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEC2xPwNiOhNLn5BXDmInNILEndCaW5tIpCuooGLZBpfAiBthkDNzoF0Vpo1aZkqOLQaywGKi8cIQqRc6A+Lh1+gkw=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.9.1-rc.5_1642779951471_0.41266545388359566"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.9.1-7fe0da57f.0":{"name":"ipfs-core-types","version":"0.9.1-7fe0da57f.0","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.9.1-7fe0da57f.0","_nodeVersion":"16.13.0","_npmVersion":"lerna/4.0.0/node@v16.13.0+x64 (darwin)","dist":{"integrity":"sha512-8EsAb+LdUF4fyi+I3CGzifhkPLt0l1J0DmOAqQpdIoT4hhmZF2FXiY0jgiiofOBW6BUIh5TVwE9lYvXiajX2fQ==","shasum":"b8f9437d8d653a2870f11d30dfac0b8d8184920a","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.9.1-7fe0da57f.0.tgz","fileCount":80,"unpackedSize":200662,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh8TrwCRA9TVsSAnZWagAAMNcP/RnCWau+cB3RC8nnPw+G\nwWvYckGYlodD1zTbnwH9cZqs1TxrRa7fIFUaYAJxESs0Gn6UgsZ+ctWjqE/f\ngaJT6vdhjUJR+jUJR9Gai3bZeUEEJQygc0O2sd/96Zv4tTKX0LDt6NnWum28\nAG5cASMh5eJiKOlNJE7Y4wKjmMqiAH79XCpLUeqyuT9QUC/0+Ah9nL6UmaGB\nUZQf7lC4l9tGKG4pvmJhM3j7jRShNINK2z1iFONT0vrMYqqj8HzxU+qLaG6f\nkYl1n0NbbJF3Fvko0oTN+fIPp8Awo2ViGaSh4b6fmvdWdmGHdkgolqkKIM0I\nsov0w/Wi4AMa5fRtBlK66yuIMUFLOR12ziwjdVdPB2S0L/v6ObKuxdQ5tGcR\naQkdf7npLBgf6HLWZCQaO4+Y+aP9HW6wtmdf23EWlg+AzFnqraS5KccNkd0f\nZ3ZyZuvSsba3AN85ugfcZLHamU0TT7rGjp/HebDzvkp9GfmYpNmBE5M4ipFw\n1OAjEZ9xF76hEBMYnSWXYuV3jZM9mpBtX0PyK+kPqlQxgKzcSo8X+lHTLvw4\nIvIvuWU6igcWSTnqRPQ0JqXSioO6QlLPuzvb7KI3ssP7feLrG/oKuId4aYFc\nzLGhG3E4Ktlscw/HaNrF+bfrBvDzdiG4oP6dAuw0RtX6w1endbIHnUy+CPu5\nnWw9\r\n=B+aR\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBDhVDtTCu4PNHZNzwCQ1bKs9U7rGFNyzPXaeFsBaZ+uAiEA8aeNg0JNyjAd4aAB1Z6u4v+2uI5n4whY2ECfWyrag4c="}]},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.9.1-7fe0da57f.0_1643199216225_0.8383412852262582"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.9.1-5439a0e.0":{"name":"ipfs-core-types","version":"0.9.1-5439a0e.0","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.9.1-5439a0e.0","_nodeVersion":"16.13.2","_npmVersion":"lerna/4.0.0/node@v16.13.2+x64 (linux)","dist":{"integrity":"sha512-93o//fJhh7x/chr676E33rDpLQxYA3wti2UiCWQYwdqHAZRPB1/zAaE30W1N+hv3SDmpRZ3zdtcQ7AsMznDJcw==","shasum":"71d78afb8996c98c024cb5d8ad073a27e81a0de7","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.9.1-5439a0e.0.tgz","fileCount":80,"unpackedSize":200557,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh8UeGCRA9TVsSAnZWagAAOCMP/RRLQZ6kSgnrxdllGDR1\n7vDdrc85asmgU7PM3QXA1/leBdoLYbfoIaydGWtPHz6xEN++7Z4CWHuVO7wD\n40xW001/R290x6e8CGyxIR2uHG3h20V2RlO1WXAXlyzdeIGWp1IXSFShuyeo\ndz6Rrw+yahtj3NAHeqa+tgpI+j5xD/q98NkehBmIiw5GsPBDb2qkDheOvNEm\n8hQTMVecopc7vdCuKNlsTDKh5Fd8xWM/oC+/47ufhJv0eEXl5/rFe3HL8T/R\nxHO9hXKdDKwbvTuSwydpcnJjNGEu4pilNpsRAAEsCA+8raLQjsWx4j8PuPgi\nl8tBVFequ+KEPjiHTaymfjLniNFhIfRh4lmI7awH/QH0ykaXUkpgpPDRPjY/\nQOLRbquAaPzbIVLHmgGURGLwiB1bBXyPGRzkbdcKW/7wU267IXVpIi9xW8KW\n7lThxnjQwVBlYigdb07R9+c/QzWg9insWe8r70c+UBTcAcqotlSdPjYJJhNV\nM94kv3Nt/ZrpFVldIjhVpVR3fM+IJuGyqkNh6Oky4hHcSiytruXnvhImuYE4\nlodV1Qm3ZmW4GuyLRySw6VC8D6siK5k3NtnlcUCSsXuAG/fXduJrAuiXDa3l\ntdkowYmW/bZKAWJJLLQKs0s6v9xcLW0XdMFwlzUyI5RerjjvWY8CNos3Ny/C\nIMb+\r\n=f7kU\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHyaBVm2cCGj+4lwENPf8GcXKBE89QYy9dkNVokpbs80AiEAwEaxBOfnoyuf+VlJwVaiZ0nuIjBTYza4+FguIt/axVM="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.9.1-5439a0e.0_1643202438200_0.38732344121832263"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.9.1-a6b201af.0":{"name":"ipfs-core-types","version":"0.9.1-a6b201af.0","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.9.1-a6b201af.0","_nodeVersion":"16.13.2","_npmVersion":"lerna/4.0.0/node@v16.13.2+x64 (linux)","dist":{"integrity":"sha512-IEwQ+NtPe9TBi1xcvleDBAMQ5gMjzVncf14G8wKir1Q+ybtW4CpiZ/mxjIk6b2Low/Os2+3JCe9OS8odf5wNWA==","shasum":"854fd13b0a76da4ded84601733678fc02ecbdc5e","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.9.1-a6b201af.0.tgz","fileCount":80,"unpackedSize":200793,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh8rwoCRA9TVsSAnZWagAAUQoQAJ9Hp8s64LL7XLHuudjj\nM58LxHfJIvTY7B6ueGgtV6DS/MN+BqDUuLJXifvK4PQRQdzcw1IsHuLYtrU1\nmXzvdC7rd6itnzPgAlOcV+05s7bihyQulq6Fzlf3X2KqBlQcNdjT8Od1GIc1\nFx+NQBpkz+L211EMHZeKwGLrVWCwVMisI7G60f9I1GN+rdrvO6I72ze8bz8j\n4RchKgaQ2Q7p7DvTHXdd8zqiRG5eYiHnc5xoxyhIE6yg2m4cvLm8WMurU3sp\nXvjAHNwCikvEO9RxgaeV6ausOoz0eB9RxtW6dIgf7TnP1/HfhpS/h2ix+zwl\nzRNcp1wUCFvOKqDqjq8kDA8XG1IOVeEGk+woffqK0PP1vz0YjwEja8p1aWc4\nyGuNX5eTCKg3iJOljTac2jX4ADFuhHsUxXpiInQnp6/GQ9vAWUce9tTioZ+L\nAcpz+zbUwWSDiqqGTN6j7jrKAdru4oXpt3RH0AZx9uNGBmfMUS9Wbq48PsYn\nkSgo6eHRRVXd+W3gevlXKFPUqKZ6HFlO+99WnPkzaX0zOGqCYbZpxWIw4H/V\nlBv5MBh+T0KgLryfsmw/iiZrFc7jYckQL6nOkHo6VHQgUh079CF1ICA3Zama\nhC2S3gMRsvVBXzL9y2B5MgS8QnfPG28RG2w5hKPG9G3eygPqcQN6UjXrcIb0\nEb9c\r\n=IfQw\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDfKPOfC3kmpnqpFX5DOa4RaFJCKwqTPXpkBEmymbQ4ZAiA66tqZnCxdW42XCApX4Ysyoe/GbT2nKeSC5vYnN8qcfw=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.9.1-a6b201af.0_1643297831858_0.8428529384710821"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.9.1-fbe14923.0":{"name":"ipfs-core-types","version":"0.9.1-fbe14923.0","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.9.1-fbe14923.0","_nodeVersion":"16.13.2","_npmVersion":"lerna/4.0.0/node@v16.13.2+x64 (linux)","dist":{"integrity":"sha512-nMMS6QJbbIkJd0/ln21OZkmFf9SE02XQ1Fxm5iAxbNK8tSWSRVBlqycW+/B2AzXHhOKPWcG0bv51Av9TEi8x4w==","shasum":"14bc4e669f8a857a1b8dcb08e1a8ead0a9759d01","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.9.1-fbe14923.0.tgz","fileCount":80,"unpackedSize":200793,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh8uGnCRA9TVsSAnZWagAAHG8P/iRa9bSAVZnBkwi5dTIZ\nMDoLkpMUFYRcdFsbFt+lvUOkZafI8eQcnEWFMYrfox1HFp30zawvkYncXZWh\nQJgpKf9Ec4Qmrg1dlScfd4iErKkjRF/CKZ3BHpzfeD+q6BDvt2F+I07lwxRE\nPhsDR1kHJdNb4FwK89N7CdSnzSjzoHSLKaqxxFZhNib3Xk/R7U55EZd00M1c\nT14eX0w3ke62tzVPbhCDjb84eUzkG5iK2aXXF1RMRHh7xxzr0wpq11x81MNb\nUs+X8zVPAblHOusndXyuVGs/2acwlWNh7MyyffuJS+SfCU13NYb/khbRjMre\n4pLfN0hgi+5bnrU4h1+5sNlnRtFo6a9faLZrrBXNFGVwvRnTUCSgT3hTthuT\n+I1iAiOxmjxQZSzBQLaen/QhGGhGoVzmSezXPM6SWKTHg4M0btismZB++FRh\nRVEnmsqh+DNFXqVFKksrw69Yz75yb6D0+bI00D1TYqcwDrqhbNeuGyLEeauz\nAeZPGc2r1ayL6zJ38uoDeOM0vFIsseysYqh75a+ZZWWEfgrfDaV5IuZIBgR6\nAXpUBTXuhLdfkQ1GOAHrC5tzPB47i+/PXF9wUEEcpwszKMhLhoVdoxdC8d4+\nPiqbUvgIRfJm2HGxGKmnD886s9Z5ldBRNTfMfPQ3PVBD9CdAmxwbrtou+jMu\n0M8t\r\n=pPFK\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAygj67a/9qsSEiSIYp0MkjGtJO5m1EHrUQRzCkLeDVwAiEAxshn2VsPW8ju4C0SSZ+ubM7wJEhHV+eyky4cxTkVzXo="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.9.1-fbe14923.0_1643307430893_0.689757363068759"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.9.1-6cb3a87e.0":{"name":"ipfs-core-types","version":"0.9.1-6cb3a87e.0","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.9.1-6cb3a87e.0","_nodeVersion":"16.13.2","_npmVersion":"lerna/4.0.0/node@v16.13.2+x64 (linux)","dist":{"integrity":"sha512-Kc3j+zn2IIC2QaCVv6PeLYiv9OKy1zYU30BRTswkq0dnmDs4+dS2E7crarE1UloyJMtnQYa6OOW7vk5ckluNlw==","shasum":"69fe143ae7e33133822b43de4401760133026c98","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.9.1-6cb3a87e.0.tgz","fileCount":80,"unpackedSize":200561,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh8u6UCRA9TVsSAnZWagAAPpoP/RXEAAxUj28IO9hwiXFQ\njOEFIrXI4ghIF5cUWMQKOzPcTj88rift7NIZjPXCU3vEmFiX209v2ggQGjf5\nHVrNa4UY9zhC6CYUXBQ8m2hYbOur6hFqkPyV+42eNST1tDcJhidPIDVu5mKG\nC+lcg5X89bTix5DghBUmJmof/sXpK/Hc5K/1+0NS1wEmMrTQRHi7ws9RrvsO\nYTjKJwM35Taq2QixSDg59TCTQzb1bKCKZqMm30vWwbnBKyfT5YEAZI/w6Dvu\nGLwaIptJtm+Hd/vTYXlSUjP+ClEhUP2t3bg4o+Pya5cxadHlVDBRCY80jHyf\nEgkknGzOsIf1i6y3qb5mHxGWIyW556zYB8R3i6pr9SeR+u646jHSU84tWfkU\nhfNan6bhsZABL2lXJcwSd9dwZPq011OSns0pL5GHxvkPl682DCSeLyNNl4qx\n3GuRccEkI9DPyv3saosXmfHzkTM9Y+GPEDSeQrA3RfBQBfe3o56l1j8uK0mg\n7IXUqG4eZ/tXMmaIHQlGstT+3uilAOKzkJxKTV9wuLEiKW55lk/0yES3Hs1C\n9+NkFtsaWnf9K1wdMWdFNz4c6UIn9CkcRZcpIyZre6ZesAs2kJlYJNjNKdrY\na88PC7fwzi/9dzXTio009W01k5DSMmsSzLI0Add1OnAevxb3X7Y5GpceN0Fi\nQ/Dd\r\n=PkVh\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCZCu3wbMB9T7PIFPMfDusIJQOf3duUeC6N5lRciaXbGwIgWSOio2DB6jU01/3IvSrZy6Aunea+jSR0PPFLsPgP260="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.9.1-6cb3a87e.0_1643310740399_0.11580067513280135"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.10.1-2afef2eb.0":{"name":"ipfs-core-types","version":"0.10.1-2afef2eb.0","description":"IPFS interface definitions used by implementations for API compatibility.","leadMaintainer":"Alex Potsides ","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.10.1-2afef2eb.0","_nodeVersion":"16.13.2","_npmVersion":"lerna/4.0.0/node@v16.13.2+x64 (linux)","dist":{"integrity":"sha512-I4o/q/GsbdcCCxnwz1NVb3zf6nrVujcVzJCSh0NFAi8Kt+tvN4CzKnkfif2OZSTfUaAH7n2kiZFQPcnHH1OgYw==","shasum":"fdefd0bf86634b9d40a0cc73bac94b0bd9aa42dc","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.10.1-2afef2eb.0.tgz","fileCount":80,"unpackedSize":201206,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh8vvJCRA9TVsSAnZWagAAIQEP/Rq7Es8x1HfSlBpGhy5J\nSlUnjCI+ExIVMhwY/U/aKu+JUO+eZdkCLKjd83p3H1zpbcMX86ryV3UwTbAu\nUC4yBtYpmgF0tDLGuS6Ho+p49IrZ/7XOpP13aEiBz/TARf8pfSvlujN7ugOA\nFTMkPYSq9VSCtIOKHaJmJIUI24Nox7AaMSTC+/uhzh/sDb/tlpdvGYdatXqg\n8225r2Dnc6jDbnzfUcpU6XDiv1XkpBYDM2F6kMcRxom5IPAWXLp+7mo1+1D2\n5NBk51cE+TzrPAThCnYvJVlZ7O4+GDiBgRCsBdfIR5sQzBw08qJptjHPuoEq\n66CaYyJCufxwDv7axH1q5y69pvDJ8qhR0rgurgXwKGMKjddE0g8oK3muAskF\n7BLcaq+DAkQR45oHxWWlDCiJfTss8Rs9M9HowO2jI35pWX8HanMLHHAjdsWZ\nYRTWzqbD+2956F/Zo63llSSaNdMCt5fSM8MtwSxRdeaWe6kHFBCGV73ZK9s9\np+v0J4kfHhdQdh5dnzATW9WWtmxdp+tm9iGlXdRSD6n3s7ffonRmdBWVRfg3\nhlT1rhipDc8X+bdyl+cWA2ZLSN3D06AyLoM8+XRwDEBYaX6PgzlvUmjEHSB8\nrumChUktNraYq+uamP57pYw0SmD/DIqqZhwVknE27eIKbY13PK/GfXXNjqUW\nm9t+\r\n=6qnJ\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDqh5rxZ4CisvuQT0ugAVVo/MGUA3lscUK+RYdJ2vEkPwIhAIcEaSylb4jWcqpcgArtNDmI6G6NLY5IGnKwUdEKVNlc"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.10.1-2afef2eb.0_1643314121083_0.9391673962872096"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.10.1-3a5d61d4.0":{"name":"ipfs-core-types","version":"0.10.1-3a5d61d4.0","description":"IPFS interface definitions used by implementations for API compatibility.","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.10.1-3a5d61d4.0","_nodeVersion":"16.13.2","_npmVersion":"lerna/4.0.0/node@v16.13.2+x64 (linux)","dist":{"integrity":"sha512-xEMEB5IZPcFfC7qt7mPfhTezhUbM8U/O3Cq5n8pxRbW0wa6210hv2ZO4Sx5dju5Xc7S+PrCZDr+ZK3SOXDDDkg==","shasum":"0dfd260ecb88456fc3daf8d1ab3354b320244168","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.10.1-3a5d61d4.0.tgz","fileCount":80,"unpackedSize":201146,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh8w+mCRA9TVsSAnZWagAAjfQQAJMuamVGGA4CNKy8mqhu\nlY9CYr0G0wlMOCeaxjTdsJ0Xgb8xNfrtSgPR8YRK93F9PWcmj9R57eWNsF0Q\nWhPR04YsHtsb/uBFP8N6IdYqJemDDbUN1jNEjm3IkaLwJtZNMiiHodIlSMcG\nUImdq41HBZK+qIB1m8f8dHZUZN2lacnqlp7zquUP1xVU3cGB5Z1L3SLz4iaL\nu1wdJgwzJaYdCFwrijVyxYD6u7FFPCYsaeCjhOBgGVbo/LU06BEli7jow+5q\nwvbqMhMnGDZwFs6UJ+ZYhV9BF8z2Fw/Qit8IMVH26HRDjROU0GhSWlmhCuTT\nGaqEtBKqRXo6FaEkgeP64YmvNe1uzkL/nXV4gSBGRBGt/U3+i0U86vAkDeAn\nLCxxWf3gr9uDQfMkZ/3cXSyJ6+vHMd8O+oXVlhbzfzFrxTZJrfO7MkbAbgS4\n0GpDYIp/vnBHNl5u6FxL7+hxluliyi6+OpEbRnI6woCWbaKjEzW1BpPt64xA\nQ3MnTSe0oKwixk6RAoBh7GqTmiIv58R23h9DDyEDJLQExwZtDpELE2w1xKFM\n/ZE1AShdP98u86dd1EsH+KVU4bw3fD3TnUZOUUpUpwv8A20nbgboizEtRzya\n++MSzma+z6d1Z+qwFk/hB3kHrOIfdpiAagn+Vo3kRymj0ci3iBuhsmfZiBhq\nCNo/\r\n=7bQD\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHtvqDJnxeezCMMJr6carSiMEOeT/grsvBucty+S7+s7AiAObn3jXinW4t4tSoFvSNPn/9UcKYtkIBq44YK4SPt5mQ=="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.10.1-3a5d61d4.0_1643319206003_0.5345758876199855"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.9.1-cca6e321.0":{"name":"ipfs-core-types","version":"0.9.1-cca6e321.0","description":"IPFS interface definitions used by implementations for API compatibility.","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.9.1-cca6e321.0","_nodeVersion":"16.13.2","_npmVersion":"lerna/4.0.0/node@v16.13.2+x64 (linux)","dist":{"integrity":"sha512-q2ZhLqAln1djJv241vQE+XjvXX31hjPPfXRNbgSSpP8zdHm4odEVP3K/dDdEelLVJXCACX7oZDAUgAdmetaa8g==","shasum":"8dab7e2d632cd6ab9c9db0273b41b31ab70acb09","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.9.1-cca6e321.0.tgz","fileCount":80,"unpackedSize":200501,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh8yTCCRA9TVsSAnZWagAABU0QAI0iug+h8xfw1ypsVnOQ\ngOgiVb2YT+br1r+Hi2mBewBaHi5CD0UjM5ge1+otG6YQNUZznrVICQIvpgsQ\nvPE72wq0NTW0KD0792jAZoC7lnoz/UcK3A4wxZg3pQC1FvTDWBFHMy58lDHJ\ner9X4E7gN8pTRncpwQXZBPpktPxidVhMSU3n8sm21ChhLV1z0vQQPYmrMwSO\nAKZ6IiduXsY4xfBJOYqG6dFFXZMHdyJzdGI56un85vvhWeupUaJgqRs+MHnL\npWwgqPa29Et8bBdT1le6c1ds8pczpQrl8l1cXxVerHLQlYgRCk/wdHuQbPq3\nR7kTIaJQQRwL7PG24xxndxzWS2353dGJ3wKwMKa1vh3Kvt9Bg43MPec4Bq1f\n6j5Os9h6ing2dkZoSX2FIku2+92lFNfYohUPjCk7QAGhw9gudFYCovMvtXVg\nOR/HrxWy9mCNUyxlog27ducDRx/Q7Pyi/N/HMZMMRt5Ekk3p0MQaICqKvUHe\npY4aGxKwo/m1pRfU3xvCBwPKsanTwMLJvp/IGFMfqvqqEsTq1VTb/cNaRULJ\n0HiR6YalqmEhQEj++wwlKDssm+Y1o5u+BV9LHN580Xhq+EGV3U7Hzfq7zhkI\noEEXSc/n20XWYGcA6jFlQD1X9SRmjP/g3RIQHP/H+zD0DJ9Qi3CJscJwM1mg\nexIu\r\n=rZmq\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBFf8MSn/KyD3gYXMU0ERBIqEpF/lzgJZUQkSpYs//lmAiEAkwbba5QPUtto+qi7vcD+fRsIFEPvpCU6/7LCG9f/Eeg="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.9.1-cca6e321.0_1643324610732_0.7125728039187817"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.10.0":{"name":"ipfs-core-types","version":"0.10.0","description":"IPFS interface definitions used by implementations for API compatibility.","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"_id":"ipfs-core-types@0.10.0","_nodeVersion":"16.13.2","_npmVersion":"lerna/4.0.0/node@v16.13.2+x64 (linux)","dist":{"integrity":"sha512-mgPDqaHNu4ybGTa8Irj68+ZxE9pI8zWHRyI8T3EvBImPfD1fHIizGpIqKcdRXvgJfYifWKC9tqnoQBKTsBc/0Q==","shasum":"6a81d4c9c8f0d114b0206b128887dd0d9927c86c","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.10.0.tgz","fileCount":80,"unpackedSize":200492,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh8ygACRA9TVsSAnZWagAAOw0P/2ElXNwPw75YYzIu+sJk\nbPiYH+MY29sYdmkKM+OoQsKm7SVAOLoMgsiesNRavqCQx/G6dJ12HCjTk1+7\nP9VP8fqsdtOAThHzi7jCvbhzJfZMmjrWFF/HWBzP/52UJ8srNsy8l+zT4thv\nm0Qj+GbKS4Kp+6oQbJcDUjaJQ377Ei8mSqpduhqCTbAMvnSqtXEbchf2ywTI\nhMw88NFZaA+9sumRZvwlZxURu6fajpKePAoJa8bt2+fmWXZDksyMlCrEzEWT\ncVPT6NcRYOp739IQ2dAuZbzEv+uQXmNjsEhQwo9a28BjIdOag+jl4CPdZdQX\nWQ/IJ0cPSdkhQRo1irNXDE68cKQUfsOXG8fdBRytkOb39P1gtVeu4aYy9RLA\nBVPAaH+oClTxGfltaMb6mfo0LAAAhwH8e2KcCFojoVNnZNLdaeFiTGYsobsx\nCrPYSjV965+LRl0E3HzUzc0Cah57WVoORg+mg684M+W75w3GKrLQ/0uFBkKl\nO19ZCJ2MX7n9TNiule9Brn6plvsrdTUHc724MiTJKRuDRhZhv4jbfGEPSJQc\nw3osdY23KIEnw1+tnC5ibRPLrjLAq5HUWPMOA9oEz876edvPCkltzemw71kI\nj3JDYDEHmHuGxvZt1mzy0ufoAE1R++WjdPjVT/MmCVTv/TBWfpEaS/3sVtWT\nnJky\r\n=qQoa\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFwp/GPQRORbIUkRnj2Dr2HAS8SWtuWJjzLoqN4XiuY6AiEAjZHCpndU2Xrh1bLbHTWCjqKKMb/Rs9nOK2gJUPYdSN4="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.10.0_1643325440493_0.7440016019672842"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.10.1-8d260215.0":{"name":"ipfs-core-types","version":"0.10.1-8d260215.0","description":"IPFS interface definitions used by implementations for API compatibility.","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.10.1-8d260215.0","_nodeVersion":"16.13.2","_npmVersion":"lerna/4.0.0/node@v16.13.2+x64 (linux)","dist":{"integrity":"sha512-inqnJPNm8ATeEk4EFCOMtX8nPO5R1+9Gfth1K7IIlsxqu5ZEfHOg5iZF+F6/WJW7r17XeX6+VaNaIg6j/Z1MVQ==","shasum":"6134c4601fb5722c22d7ce396dd3fbcaa1e76041","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.10.1-8d260215.0.tgz","fileCount":80,"unpackedSize":201146,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh8zBICRA9TVsSAnZWagAAD18P/2nbbsxUaENKz479Z7uh\nOhnupoT5sUNCQ8i+6QVz1OrJGyXsYBz/lJH8rvd50nySVekFL0yrEbHN8u1p\n9gscbsvaaWgA0pLOCJedt5fdwybKS4/Pg7BucKw7ZzxJkr6quBijhAaEAmOQ\nKQ54XymKzAfpnPb8isL6JJeBHacPhlUDvjWXZjbwustGjlfWkTHMgMjznASr\ngcR/svzD2A3FJTmtiWJdmJQJv3a7A0tMbBZYcSU6bil/Y9b3hfl2hqLoY02f\nR7AfKEAseGGcVSvpfvUlRtPlnEKkkuNI2kkqbI66+QFmUD03Dw0nhlWTkGLb\nBlUF46TuSpdEIjowW14oaZSnM51yD5k3gHnEscV2OKUigc3cyCchxym/S+rj\nHKkt5cUt7f15YVwNwbmRhBXQdVYV5l9bOJjfLYYF3YmiMrrppx3gtpeLeLbB\nFyXbiJCslcQ2k9hmtaknRSsi9YkMu4wvpPOcBbcivaB9mbwuYnygAyt3/y2P\nzJQU3k9dJaUUjcXYJOz/TRjcdVCMBMBbYY4U8Rjlhvn7aJYkn5fSBOPk3DC2\nN6D83WV97ROIw1H4VbrY3l6YdvtdccnseA+V4YV7iXfhT8IeqR1tE/hH+x/D\nINRQnGx6nv8BNpaa4egkThw3hkytMCHaMcRSg6DjORPx+DV2xh2W0wZouyeb\n1zVt\r\n=/exN\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD/mM+M7Orl5L6iXXEKZA1VV5KUnpV7H81ne09uToYKxAIhAOs6ouYeCZ+DR7lhp5kn2bQ+BhwRIZP//CzqeSkOJq0O"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.10.1-8d260215.0_1643327560375_0.47506543691401215"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.10.1-2c8ec080.0":{"name":"ipfs-core-types","version":"0.10.1-2c8ec080.0","description":"IPFS interface definitions used by implementations for API compatibility.","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.4.13"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.10.1-2c8ec080.0","_nodeVersion":"16.13.2","_npmVersion":"lerna/4.0.0/node@v16.13.2+x64 (linux)","dist":{"integrity":"sha512-4n6OoihUJCZzuw+X4ji2vtC92Mt/Vl93o5P+NrOFKcGJneqroioXI9vhmi0tM2mnUagGeZf0N1HXuzFREBsNwQ==","shasum":"2e030ffc93166d0621ed33e8dfb19c74388facd2","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.10.1-2c8ec080.0.tgz","fileCount":80,"unpackedSize":201146,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh9AQKCRA9TVsSAnZWagAAEaYQAJWo/mH+98MZBzdh8Uxv\nvL2I+92s/2YQf3/L8Q+znvEAYqeCuwBtX1i1Mr5GKVjynnoSm9e9scE0J6jt\nAunErPYaxULCxyKzsP2Eku18ZCZe0DT+KaJ7Uu3KTbunQuGNwfSqepmEadAI\nNA5vN+7fRU4He3JVGryxgk2xOVIPbRlUccV0pqZYacXi/CjeUciu7jQViyDd\nkxrOE7opspzKABo9yuxdThF/sUQ4fzWDoneYVoKSl7X59yxDueHZUy78eF6j\nu77B8m+Sgpjp+BN5K1QPXXLZhpGNnhETnk1GShObp2F4sJFQ4voqWmADmiTH\nXFz2UvW6IguPAgiwYSOsMiu13sASa7tyfQ1/OyCh+qttsft1ca4xeBZ3J71S\nN44h3j4nFIhp0bh1Qe1qOjVonHobTYeUp5f9JYi/RKwynHU1nFl44+CFu8dX\nQ+QD+jDUrAseHm7pkJdzslP+/UE2H/+ns9/MtZXZAqiiLnAWOulX8ehuIoY1\noqb1OQYYtrCUIxOHOV5fe82joOvAOCYg9vGDjWAwAJmlfj3AEIZK0kR/gG6Z\nc7FVREYHJBVWw4aUFTOTldGx1yBfQ9dOWraiSFZkqXpasA1lIp9K3MmgyDzZ\n/a2z/kxCUu2t6sSQ2H4fM1qW13sTL485Or1PyzL8ltVgXnlTpcxFefDtOYie\n5buL\r\n=gfT+\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCa3LADksKUWs2aujXq1HtIosir65R1RICxU+bpLff4CAIhAIXq8DoiA09x7XxqEcW7R/h/Cpe5BzyepZ0LhoFg26pV"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.10.1-2c8ec080.0_1643381770478_0.9190853572021829"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.10.1-3a74c110.0":{"name":"ipfs-core-types","version":"0.10.1-3a74c110.0","description":"IPFS interface definitions used by implementations for API compatibility.","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.10.1-3a74c110.0","_nodeVersion":"16.13.2","_npmVersion":"lerna/4.0.0/node@v16.13.2+x64 (linux)","dist":{"integrity":"sha512-VMSr+a/6lMqICQ/aioKMEiChh3Y6RyT0R0MfZ4q8/yZTIO5hTACKvHr2tii/d3AeNiUG+Y8JbjhW8pRt+bT1+A==","shasum":"f89ce2b39273f0043d44dd3c28c1cc8dfa9d7b43","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.10.1-3a74c110.0.tgz","fileCount":80,"unpackedSize":201356,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh/VFwCRA9TVsSAnZWagAAX5cP/19g526ahCJZd8BQXuGv\nLFEuHAKLlh6ZSbCTYVVCtgbtGm8QXBks5gz7dH8NGvAxk+Bm9QMeDry5bzl0\n2fwx2vwVo2Qe3YoAGTQtSWN7JwMzQdjGJ9EhFJYvs5oT6GBA80hjxksCkDta\nojgCgQTLPOj+P0IwOxjHlVX2Rd2jiAfnxL7p8j8U4v/+tbpL6xXw5tQsKvu/\nUml7Pwv0NOlQI60GMuaLUvgG9Hj7MSfIfsLsS4YBh23C2+dcoiw0pJKcYY+2\nRSpBWV5BbpO6RpAdihZ5GdOPU3lJfKFOOdfJXdD//3jwaAE7zkoAzUXyzPT5\nuf01lqu0DkobXJl0oHE4xVff44VNl3A+mkntKoWTse1wcrSiGmCoFSs7xaOz\nmxJonf81Ux+pyvjyWC2S/DX5+eazUGzHcphuRiosUqlx1AD5j4+M4kMR5SFB\n9pETmsPEx0jVUQKEVkLO540EJ4gxC/NMnrmmDItmoRHMZH6tjX4s4AlBya3G\neUJSosKIFmRvVtrFvBPuEASwL0fEygiZThh5xAbpMhnJQdzIQ3rtNZHVod/E\nWG6zuOUr0y7F6TDuaqNtG4newwmm+qK4HwE95CAK8uQaQdeMfmaTsS2c17Ry\nXz6I4jMRrUYIODLo2xY+0buKby08IKBDF6IL+uOJbHGwuy2HzM6pC3fBPH3r\n+27F\r\n=xLXP\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDewngr9EKiZpm522H1mvsaheMhK3OarNqb9yn8aNf1hwIgcSvXMG/mX78uwLDWYkAgiwpLqMCJnsXaHrNQuARjvkM="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.10.1-3a74c110.0_1643991408625_0.38846045279843655"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.10.1-383dc07d.0":{"name":"ipfs-core-types","version":"0.10.1-383dc07d.0","description":"IPFS interface definitions used by implementations for API compatibility.","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.10.1-383dc07d.0","_nodeVersion":"16.13.2","_npmVersion":"lerna/4.0.0/node@v16.13.2+x64 (linux)","dist":{"integrity":"sha512-wZ++pgfDTHopdYhtjCkVKaNwmbM1x3VanCb4OwlKTbdEPUkOu0tq1JjAwefqDKwn68GRoR5T6Bdwy1zufyC21g==","shasum":"43baea3da233821f4b4ce53eb72731c4edc06218","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.10.1-383dc07d.0.tgz","fileCount":80,"unpackedSize":201356,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh/YUJCRA9TVsSAnZWagAAr4IP/2AEZuUTntbkzbnJUUr8\nUq90j4UoJfs+kzRR76bOM2sCzNOkMzkuT4qAiTbQ8FnDBj2ALaCjym4Qo6Wf\ndxFElJgKZMmj8zUnapF7uyI90q6jsJNnjLKklwk5ODU1aknAXS6iK03AaJ5Y\nPI86eZ0AG405+caeqoYiECYwO70zsYLR5qJV1pVRH8paMi9lWuNptsK7L9fX\nFGIZfowLPkjgzSLcngeEHKjFTZoaVcbXxQpxz1NDSHXvdqygRW2wV/mFbGVe\nYIPYdNqO5j2q9drDeYdHoTHITENdH05dtGVWtqnZVNPKPuS3fbD4JggkQSpQ\nnoP5EDs9RuCP3cZg+oVAgotoTe2BvBdtcPdHkoBOp4agoMqSXcNYOPLbhsiY\ntZnGohieyVP0mzBAhuswqOt1GtGPnz8pox2N6AmVzb3eOGJjtEQ0T1ezt1wN\nzU39VmxfMQPi/5u9MX+FxWbIHlR+rWo2y2q4nuoiuVjxq1bjdEi3/wz3pyB0\nW2S4iAbpKO9ZVcuisxZwU6OZbHQcWbUSkkjeHneMUKOx7UeG8qMnv1O+w32t\nYrDk+Iq7yYBpNt/AEfMFBXS2OYSOvBH3GfgsqNAHbeHyfjoR2M8RIe0Xe64J\nsI/VrRILPfMFSL3AQb9AUt6R13aHG7O8wbSSqlxZnjvZFYDX85cAZrrN6/nv\naLa9\r\n=CCsS\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDziz5aLolCmIygbYFaI8td5IFj3DyV5V3PsDNl5TIlhQIgb1pxBKh1YDFrM/ktCFB6Z2JLDKc4Vwhp3L4AkZsiBoA="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.10.1-383dc07d.0_1644004616892_0.3532460029910205"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.10.1-709831f6.0":{"name":"ipfs-core-types","version":"0.10.1-709831f6.0","description":"IPFS interface definitions used by implementations for API compatibility.","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.10.1-709831f6.0","_nodeVersion":"16.13.2","_npmVersion":"lerna/4.0.0/node@v16.13.2+x64 (linux)","dist":{"integrity":"sha512-+r41iIkLBBB5jUa8+oJ8U3Fm0YX1MXt/6mJY+WQnUcQHv8//IFBTMxR/HmBGLkYCOiDGYDSpJZND4er9zOS9Dw==","shasum":"bc69403e4cc900eed75a51c9ab45b9fb49985f16","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.10.1-709831f6.0.tgz","fileCount":80,"unpackedSize":201356,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh//E+CRA9TVsSAnZWagAA//YP+wSCfFuGI15Lgxlu2fmY\nusXs19PWGwJfi6YCjfuRWYDV+7q95LI0QF3sosWwDOjfaa41DTIDdLuoq72w\n78hQeituZp/yvQHO+Hl68nwxU6MBSCLoo2CpqnySooZCamqLUdEMXBYr5jlD\n8AVCQ15awa34Mn6I9DOxJ4H4fxghR/4qUsBHt+cu8TGY6fNiSkt4KZLVpoxU\nQa/595DFypVD+Uedu3N+9N9Zv4xvVYnutmf/5Idu0VsN4p8G2hF8qQWDxb2y\nbPP/4lS6lNCWn4OU37ws14xbr6DxLz1ppehRpM3D3eiYtyNR3LTJG7SHvrUW\nytCyhJdxOgM3Kgw3bopJI8x2Ezd2ntWkyyDtPYss9wK26kBa1xIN9Spwis31\nwFLefHlV6WisajopKXjtqfnodd04iwjpwbjaKjS7N7KeFnnIjFI9KPesA0Os\nTwX4WSd+fz4QsUgJ8mHMOdfohH/gn/TchkHuxAzRjwRkYwWxPjDTwjdlEGww\nB+F6/VWH6mRfcI78pOpbrG9VflFqE8xcw5GjXKKC5NH6jSTXw20LO6cgkCIp\nC5WvFl27f8lvVwbo8e1awOisS/pWLw6m9ZUwwGlCMx1TA48SU7MIqOKd9H4h\nyFa+XaZbTuY6nNt+7fw5NHBOXJ5CCTbSDWNDfaoFg5aDej7XB49AGk2FFWKp\nz03R\r\n=nhrE\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCjcpNUSv1An/+u1FV1Fbrh3FN2VNhUCbiIytnWnqhcUwIgPB1ZaglwyHrdPVPa7MZGe9KR5Kxv7WlCKkdsvpN7xk8="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.10.1-709831f6.0_1644163390508_0.3643091113638248"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.10.1":{"name":"ipfs-core-types","version":"0.10.1","description":"IPFS interface definitions used by implementations for API compatibility.","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"_id":"ipfs-core-types@0.10.1","_nodeVersion":"16.13.2","_npmVersion":"lerna/4.0.0/node@v16.13.2+x64 (linux)","dist":{"integrity":"sha512-s5+kXXcjkIdWPHblrE0TyiKxROQdL7zfkVI7FpEEwv5rtHCjpI0I4vKSzziZLLzLXf3a2F1qtscOnlaT0ruWBw==","shasum":"53c60f589e4e54c2d566f0c856c2fcf0ea4a5577","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.10.1.tgz","fileCount":80,"unpackedSize":200849,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJiAU4ACRA9TVsSAnZWagAAk0oP/0sIpsE06azm/TL26QwU\nR6Jcs51h2AomJ0BW6KMQZ6ky3cS9VnWhZpgoH82WXa8Q4gs1ICDO3+Fr6Nh0\ndrx5x3r63rbBoQWkNSb/Img2D1cfqd6EcVfMu0mmZCOP8ZlE/RkppFVHwWCH\nt1P1JskquBh3/11dYycKjc1vsPNasr8RqcSaET18eTI8lvwz0y2ftwnjb+s6\n2MH8PuJgja9aNF0w+Dm8ymGVLS2Vo7D6iQLlHeCWnSW21slCCre3kRbDILcR\n7SjM3Z07wAFIkV133WqE5e0glkXlLsFD1h9Lhi5fy+0N/8AQ6qj9MkYZRA3x\n8smUKHT2ZVr/EoRqdwCcVhcZFQk0WPu+Spo2hbL1sKg2g9M27MOzRteXjm/0\no5tVmjWdnXdEMj0bersS4ak4t1eFm8cYI/87xotr+tVycNpiP8lOzWN6iPsL\nUZMny1EY/noW6KkBknl3eiV/87OQfvztYkYV9yxv/5du2V/wxqLzTOynL0xC\nZ8gSBInKwYoX1cKC48lP59rpcrnOHdKCj/9eecWuyEqxEKXvOyHe4tu2N39I\nXxbQ+4J0sB5iyaxi2LvSwjnJ2BY6RMrTA/UUEsV2Rkxt98bJcMZWy67vuiar\nw4ADK/bHt8YhBImaPy0K+emZrWiNjvlwInq4+RN8lx73CFMzmj0I5dLoFxZp\nExs9\r\n=FqjW\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDUQVsR0M6HEuwO4Sw0CTH9PoCgBe2JABYZ1qMI1STRrgIhANFOnZXOX/TYfCXAvQ+ddR43MGrCjJGcExrrIw1XsZtf"}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.10.1_1644252671681_0.07096732142428364"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.10.2-1082fce9.0":{"name":"ipfs-core-types","version":"0.10.2-1082fce9.0","description":"IPFS interface definitions used by implementations for API compatibility.","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles src/* src/**/* package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.10.2-1082fce9.0","_nodeVersion":"16.14.0","_npmVersion":"lerna/4.0.0/node@v16.14.0+x64 (linux)","dist":{"integrity":"sha512-MY2EZXH+6M/tWcxFp8DgMj7kuXF1D39d3x6Dt1i0zlc9aHULUp9Z1sVLyc5cHkMikkDXkET0usfwt5YpdLW+Rw==","shasum":"bd07c1ddce98569cdd147d88b36b45769d0e5e33","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.10.2-1082fce9.0.tgz","fileCount":80,"unpackedSize":201714,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiD8X3ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqNDw/+OfLYC43MDlmb1yI5H2Rxc8FwGsjFIipVO2RK1vV0rtzZMBxi\r\nKdJ8LCG1PLhedGGSEfA8m81vcoq48VMH1DDP6ORC1dOtHe0rUFHlXlVK3pvx\r\nNB9vs/0yVwq3mn9eWVWohPB0kT0oh2CjZPXpkbhbtrh5ll3uKFOvNV2pPCil\r\nGixZfCQERDlw1o9Q1h9oBjrlhnB8e4eADlqYJjBLmFFPDjaErrF+d4SL7Mw/\r\nd00D04VtgpP6wT3NaMfTD/7CzpmbDrTLYYYtqGs1JEwc6yGAHVt7kB/SecB0\r\nhL1HXGbw1yLYUXMB6/J9kGZwceT4peZNyJcP9j3ldDNfk6pm8PgbOKr/7/qs\r\n29tqDfzdAybw/l/YfufL34tOq1NZLalttV5/LXhahCgI5ETU+MebBGv09pAH\r\niR9nIXHj8V+1LRs9dkk7wxsbcZimcGaiS0bleq4HxXQnwyk+s0F4WDXorTt0\r\nyDhhtRH9qpHfB/SVeMEI76/PV7xi2gVBwJMsnqmClJPP8ODZV9JrGOrBYaCg\r\noe8/NdAsiHqhnypG94mP23NlgLVsnA0/l8dyl16GsMWy8WnoRmXBn8PpT+KO\r\n5pw9KhaJWXmNmOuBWksW5pPwoPOrs/bp977DcuywxRrXIYQRgEXXU7KonMii\r\nAitsYsRBHKvTfkH3dnG2QtVKom7JvhUkZ3E=\r\n=B4cQ\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBAZtj7o9toE6e8ddAekCv0LJT8a9UAsuIo3b3Lq3y8fAiEAw+Hh062QXMz1Vnq0BVpYOF+EC5ATg87O8iNfQCuXBUU="}]},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.10.2-1082fce9.0_1645200887720_0.7838340557387165"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.10.2-125d42ba.0":{"name":"ipfs-core-types","version":"0.10.2-125d42ba.0","description":"IPFS interface definitions used by implementations for API compatibility.","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles 'src/**/*' package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"interface-datastore":"^6.0.2","multiaddr":"^10.0.0","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.10.2-125d42ba.0","_nodeVersion":"16.14.0","_npmVersion":"lerna/4.0.0/node@v16.14.0+x64 (linux)","dist":{"integrity":"sha512-8apqKdCZYEr1QIu4aNXsBSxxukXJdxmvy5UofiYK79CaXhiblE8rPi7JxuHW77zFsOU4vxlQEQdz02bk+wCT2A==","shasum":"91642a26793b49c4ae0480204a15351914a31390","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.10.2-125d42ba.0.tgz","fileCount":85,"unpackedSize":208457,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiHeuJACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpvtA//WWBzE8I1OmqujUx5LTym6CMjXOTpH9EjmEb3pDI7XYNe+aRw\r\nR0UfAnaT5XP8TTkGORxLWsKMuf7WWCmp0g0KrOsMmm3sdaZ9wGRBZHVZpgX4\r\ndSibrjkigWgdrHyF+3EHi27f9HupPxAXS4zN8U8d73/YIgKjeoVi70bil6+C\r\n3anB99N3InCIB/yF3yM9twKdLZ1Ebxq1DnZe09jzTBRVAyNQRrCHe7rXGwd1\r\ntZVHBl1Tp+F5G5e1tdzO3zyllfuEuXt7LN5dzFCLFqM4OXf0oLCDiF67kgRV\r\nfkan5N3OHdRGkz6Qs7V6EZTK3xztWJpE9gdzC++Ga30fdxnAk2InUKkj1iD5\r\n3pEK5HAIZ0/Aj5uVzH7BqtWfc2WjfpdK8p6MGoTuC0RVWqDsXkiWC0uzrG3Z\r\n5OmPdih0M4sEhoeYYuTZa//VGfDMmTh7MjTXlclezQTG1LZCxXuNlZFfUZx6\r\nVAuSgKjdBcVTvV0XbJE1m1yuKPYNnw1o2wqmKnRaTuv0HalSLrM5IpXINCw4\r\nvwjwBtro+15WxOWx0qMk+VM/RavF/K0tdfZM8RaeMuuwtQ92uNTQnTpIPaVc\r\nd5Of4AxhZQnq8eOwwSmvDvL3l+qeTT+cIgpYMBfOHmZaINWmvjrCpn5sDQWe\r\n97CRM5BexUlxdGiO4z7p7Ce8REPpM9LwBp4=\r\n=iYUt\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCqYbG73/IQ7uLZfc6D2leuzh8wvYwMtAZTI+NhS+aUBQIhAP8dkLmATcSjds0Ot/y2Z7wWp5FHdtsuFSSr3Zr//Qph"}]},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.10.2-125d42ba.0_1646128009750_0.7445830605508812"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.10.2-df1bd1bb.0":{"name":"ipfs-core-types","version":"0.10.2-df1bd1bb.0","description":"IPFS interface definitions used by implementations for API compatibility.","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles 'src/**/*' package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"@ipld/dag-pb":"^2.1.3","interface-datastore":"^6.0.2","ipfs-unixfs":"^6.0.3","multiaddr":"^10.0.0","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.10.2-df1bd1bb.0","_nodeVersion":"16.14.0","_npmVersion":"lerna/4.0.0/node@v16.14.0+x64 (linux)","dist":{"integrity":"sha512-3DmD5q+4UqMhVMiH02rPZ3ytEg/4nt9ycRvnks6z5GZBHlY5XG3D3JZD1awEap4uLuBtaPpsLvxHROt9OUJWEw==","shasum":"3823e6ec886752472ed864c34453c7ff1da06651","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.10.2-df1bd1bb.0.tgz","fileCount":85,"unpackedSize":208699,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiHf9IACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmr/og//e1y1VGRB9k6SDCmbnHwZFOllf6LiWevzFnVH24sweC6PiCJ1\r\np9MlaS+KKodYkWr3gyHY58TswxhoAFI9GGbDyMJ4ghsLCf3Kj5k2JOjwfCa0\r\nNt88CCqXDSQzTY3E7EU6Uw0UaTU1jEOOjwbjJ89zSWbHH2HAV0863O8bKX2q\r\nJIM8StPQB9eD7dvLlkL0bvYuwRVWi98OFoQERsgkCmK3xKjjZeNY7wp5VyqQ\r\nL5ESg/uuZ3SuPfDglD3WYyfaPAGFY1efqwzR9KM74BoNpHOBjVRs/3Sn+i0h\r\nJF6/1DUxZIMEX1BlBUnjMwISOAaJtBztaD6BEs/RpE8NCG96tuBBe7qvDazq\r\n+mMZAzTL1VR6MvjpMEi+bhOpGdyjCfisPsCjralTuFliikZBaLM5kqm4R4sH\r\nt9jwPoafWVDVjj1b7djMkCReVcRUSYQG1Nt3nZJ5aSviUj7pdoDuZQPXDSUc\r\na5kzuDkyHSpmfwsRkfSe+SIMgCen9m3Ttq7lAV/NXbAoOceO4m0T6LX8FySt\r\nEtpseKGgt+su/lHXjYIqPSKIStWnr7Iua9VsCJMmen6hOLkmTHkes/i2jtCI\r\nohqJUOwAUibKnOZrtqF+ziA1LeVwXY5CjbMBa6YIDM2LqjIRd/d0Q7FT6MuI\r\nfumLFfXMIE0vEU4LDsXvEZ+m5OwzLUopytE=\r\n=goMu\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICTgvp6qZkE91za1TFTE5Hwx/NCTJ6JSCQiCy2LgREzHAiAmWmzBuSoJUwifHG6Sr9RJWC+/KHAvMiYVlI46IkSmew=="}]},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.10.2-df1bd1bb.0_1646133064668_0.44083504868825085"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.10.2":{"name":"ipfs-core-types","version":"0.10.2","description":"IPFS interface definitions used by implementations for API compatibility.","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles 'src/**/*' package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"@ipld/dag-pb":"^2.1.3","interface-datastore":"^6.0.2","ipfs-unixfs":"^6.0.3","multiaddr":"^10.0.0","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"_id":"ipfs-core-types@0.10.2","_nodeVersion":"16.14.2","_npmVersion":"lerna/4.0.0/node@v16.14.2+x64 (linux)","dist":{"integrity":"sha512-IyPCAiiPiZ4qmmBFgh+wSS3aAQya5Ck+9lDYjBCw1+hK3SC3RzEP49CWqQMKQYbMnaa9pY1GsnGJkLC0TiE2vA==","shasum":"edd802e1ad0d3f6c2b577e2e334f05436d1a850f","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.10.2.tgz","fileCount":85,"unpackedSize":207993,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCKsfiOIklsRztOThS4AZqOkYeS9kSYL1fhAmwBt4VozAIgfg8CuGPh3/a/tiB20Xlzxn9knTOdAXWIN/0ZJAb5Bj8="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiTFvMACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmp/Rw/8D61Nw7iwZHSox05zPCz8opHwtSIVRmGJKu3csgB/tA4Lh30w\r\nKjyuVfzDybVQMImORHPcqWrQHpLi11THhgVwMcPt60Wyhm2woIYatCz8xTTJ\r\nNgN4Te4xRRsU4hDxYP9vxl2KyBwzl3V3sa6nkYWOmIBW+H2gz/K6z7DU9QN+\r\n5K5seJQC/AM9SnUfCoajcbx5rjRBVcCN3IOCKVawj6R58qA5qG3KPXbX9Nb4\r\n2KOy4326tSOXCW4z/HfFUGD57gaDKyM01anJPp8IIS+Hg0CfYaCFUL/JmGJ7\r\n9BZUQAfrAxGN73S/6aDlQnsrLZtV8taMIk+f2G7Tm9sTV/zS7VbXj7aky97l\r\n4IYIoF0Rbv/Q85CSD8O/BsOPmAc6I8OJQOWXumjdtThqFahZzSp/JdUhSont\r\nruk1gexaaaK2bCxzq73o0Vz1bg/1QQ/Dvzk48V1JwXQARxXquxPaPOBl8fbm\r\n9xKQPa+Bux0Ix+U6WtYh+WjdZpT5NRr9eM3cB0qpHHaVMATi9Je9okosaedF\r\nZJIrcmMdRjw+XI9Pi9IVbdvBP6EYrVojJ8YEue2gdFrslRaHkizTdXU41LrU\r\nAU03WwjkwqAWwW5Zy8Vln2WsC6xpMEF/XsVkIhJ2Nqi3zoRXJxk33cMZKHcy\r\nC9DBH4BI1a1Sd7hzlpKEQco5ZgPaxtg9LDU=\r\n=zmAw\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.10.2_1649171404480_0.5423822249873949"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.10.3-e90b8f13.0":{"name":"ipfs-core-types","version":"0.10.3-e90b8f13.0","description":"IPFS interface definitions used by implementations for API compatibility.","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles 'src/**/*' package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"@ipld/dag-pb":"^2.1.3","interface-datastore":"^6.0.2","ipfs-unixfs":"^6.0.3","multiaddr":"^10.0.0","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.10.3-e90b8f13.0","_nodeVersion":"16.14.2","_npmVersion":"lerna/4.0.0/node@v16.14.2+x64 (linux)","dist":{"integrity":"sha512-HKspZpq4e/uYvOBGDB20GXtqB7wZEwMgYP0lrjNzEnklpqFyOjHSzZRyvCNNvf7wN3eTOrAwpeLqu/aP/97EBw==","shasum":"4f9d068b626f985d545a170ca5ea43d1657cd71b","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.10.3-e90b8f13.0.tgz","fileCount":85,"unpackedSize":209557,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDTr8Y1dxGPh9+ZpPweyMXOHBnmxTgs++U8akrALDaMvQIhALIctmeJCDzmRy/XltCRQiCJIEbWzBF8FsDW6ErYePOn"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiTGnQACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoA+g/+IDyEs+o8u0vug17yIg73ncI94UAB+Rlfl1CGZs514cMEm4p9\r\nQM59/fEwzg0sg+dGcHo6MHgw93rstFFAYS9cTWo7Y5Pt7aWiq7qA8SkZmIal\r\nsakTyDLEgHycruWhX5gLUideeQnO1HvM6QNkxyAgdYVS8zv790zB9cAH65Rs\r\nhMu0xRe3cXPFmnHWbIVHbzah/FNNUidATGuuHjok154+YRDnfeSioHHnAebX\r\nWMRPyyBnfwVV++ibAIMW5VyvFCq25emtwwRdWRrYhtweHFafwix7ZfqhIZVw\r\nxvcKL3rCaJ9yeWjzaxjYib87WGd1v4O+P7MZhKbPCYc1/i2Pr0H+HqjGuxZZ\r\nmsmUgNkY+ZgcBG0kQvLNP1wnjihjufic31P3uEHaEFTqAAMJhUo6e3lGGvMi\r\ncJ4Tm/Lr+zJHQHUpZpNLvRrtRtieDzuxYLQ2fFgthtfANvE3IPjcpOHO/VSa\r\nfWP14kbvud2O3uDQnpjHA7nvZBgFimjVrEeL7MqSrIZUmmeLn6QrlUDtAzcZ\r\nX3fS/Zeswz7Fc2dfa7tWw2ew71aaESweao3PMcuCFWNxMkpJ7CHOMdsXLr7k\r\nbmpnwtBQUTAV787HEdncLUBcu6PhttmzHebzCJJ4n+6m78FahT3j2wVZubBL\r\n0S/Zyx0Wk1j1+z/Liz4AwFpbG5EMX+9SMF4=\r\n=1ap4\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.10.3-e90b8f13.0_1649174991887_0.1996187840815069"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.10.3-8f7ce23c.0":{"name":"ipfs-core-types","version":"0.10.3-8f7ce23c.0","description":"IPFS interface definitions used by implementations for API compatibility.","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles 'src/**/*' package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"@ipld/dag-pb":"^2.1.3","interface-datastore":"^6.0.2","ipfs-unixfs":"^6.0.3","multiaddr":"^10.0.0","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.10.3-8f7ce23c.0","_nodeVersion":"16.14.2","_npmVersion":"lerna/4.0.0/node@v16.14.2+x64 (linux)","dist":{"integrity":"sha512-fz0os60nNz46fdgCA1ztzW50Iktsdg21qOT+qN8Q9R+nwqK9++QpLWYuvFYUgZ4MSKnaNtrE6Lk5d+uMnQM0wg==","shasum":"d09f13f3c9f1f854426d71fd4487f97aaede206a","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.10.3-8f7ce23c.0.tgz","fileCount":85,"unpackedSize":209557,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCAaF/ybJXSTVakuwVMlQ1sv5mj4DrSQ3CHB0HaAQEMNAIhAJ3Z2H8O3Ik4ffA84eYw32fKnifo4USRdStNSHFAXCsL"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiX/8mACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpEtQ//e2SWJaYxEuYrm1kB4stfxZoUpkM+Ellw2G71DO0FdBBH5QBJ\r\nHFrEoor0i6K08ZgfGUK7VmTk6wQLOzOQ6R9xfoMH9K2g6+bChCiSf44Im0Zi\r\njK3BpQxEYiy8MX6f0aghU8tezCifMBCVwYXHEcSYSG5iiszzOc1Gb5NbFM2V\r\n0S+zzaJ1+nDR0KftlYhBgmm+JBVk4oSJkG9kblO7ujlvY92s6ssMU/8ZVYUb\r\nBr2Q23GqZON44Q/DwxLzW/HHn27ekFkfX2sAtN2+vmRcf4ElylG7VwCO7Boj\r\nyzceYNzQlTr7zPmcDL07NKg6JmjqtIFxVED7Vr0+LqEz9rPNVcJPPsyEcUVQ\r\nyH/FhpJwTT9cZnIMXbiuHT8A4A65RHKBEeE87DFi9b608+pQ0bOLVVD0EwKh\r\n3folF28WkLAAcvNumd/g49aBZDe14EDGuZtsI1WwMQP03+fmzFzZpoBRSBma\r\njcFB0GfFFmZ28n690J0P/QttRWCdNtm0W2suSwXdlvPKvWsNOzYFmRUTekQ7\r\n+uhvjCJi6HJMO1Xg0TVbarrx6y6SQQoOKsqWp4gU0Dybon3BE/XTkv/MFbEz\r\nBv8+yKoPRJOpRgafU9bxvwrHmYmKoi4F39qhNk4YvArVW+R9gIBo1NgHo5xV\r\nYgWDVEWxU6Cjn8S+DeR0o/WYtPDOSe6v2VA=\r\n=7OhS\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.10.3-8f7ce23c.0_1650458406038_0.7512252055927804"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.10.3":{"name":"ipfs-core-types","version":"0.10.3","description":"IPFS interface definitions used by implementations for API compatibility.","types":"types/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"rimraf ./dist","lint":"aegir ts -p check && aegir lint","build":"aegir build && copyfiles 'src/**/*' package.json README.md CHANGELOG.md COPYRIGHT LICENSE-APACHE LICENSE-MIT dist"},"typesVersions":{"*":{"src/*":["types/src/*","types/src/*/index"],"src/":["types/src/index"]}},"eslintConfig":{"extends":"ipfs"},"publishConfig":{"directory":"dist"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"@ipld/dag-pb":"^2.1.3","interface-datastore":"^6.0.2","ipfs-unixfs":"^6.0.3","multiaddr":"^10.0.0","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^36.0.1","copyfiles":"^2.4.1","rimraf":"^3.0.2"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"_id":"ipfs-core-types@0.10.3","_nodeVersion":"16.14.2","_npmVersion":"lerna/4.0.0/node@v16.14.2+x64 (linux)","dist":{"integrity":"sha512-GNid2lRBjR5qgScCglgk7w9Hk3TZAwPHQXxOLQx72wgyc0jF2U5NXRoKW0GRvX8NPbHmsrFszForIqxd23I1Gw==","shasum":"89ebe98199d4d829f2b20104bfa3299f808c80fe","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.10.3.tgz","fileCount":85,"unpackedSize":208424,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGmkJGLWKeSSz2uKDCQlYRJRdBEm2pkMyXiRH/NfwwqkAiEA/p5d+5oT6W611mF8kghOvnJyj/nkaIjSdxHAl22DU0g="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiZ5jnACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoGZg//XxnGyd+vBKvjbalX1pzdP8IiC86nMqgj0p/IkrU4UXmo3nLJ\r\nN8wC5OGGAumFRHztbsmbCWUvR3XoLpg0S9UYqZyrR9tIxWPASzjkZrLyIXcd\r\nihmSevu+Gmbvak93A/EfJD7zqnLmsQQRTBep1Hr/0NAX316e8NEL1J16bbtn\r\npDGArH2/jYVq32oddNgZhY4VhK+lVpLFyQO4emESNzr5R/p11uwNhgzImHJa\r\nxrnYRFVzIYNmJaWw5Xp9lwXVxyr/UctPzRuDBTgDkRbtV2MMrfpC7gZMqn0J\r\nW04+p6k6gTmfUMkFPFCS3ziP2lbJt1bVj1RzK99/Q37uDH3lADRV1meYIiqV\r\nGUfcHN4MswcdmP0OMG50b3muE1eD02hBoRPyvLmjhINiWWqTnjOyqZxH83i2\r\nuiC1FkgY/QLCtAkEb9ovoUcck9HYf5OgMnHYpdUr9Yu6gb38RaXa9EsYW5bQ\r\n655xxr02g4bHHPD1xbixE1ufU17h8ZpbKMy6+WJU2d55Af4wDs/kUYNLfW1L\r\n7fjAIO8Sn4X/582+2paxrtakjZyMLztMYxHl9M41c7iLQ8YFnsmjPdTLazNg\r\nkyDG6mTzQdFwkGBNsF04BRrOdjQ52g7wkCfYiLKYwchUaJqUWDM/2rxWPwXH\r\nO+6zNINUARGkpWIyVKcL0yRqkoF+JY/QHvY=\r\n=YuNO\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.10.3_1650956519075_0.353010320849789"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.10.4-7165bf71.0":{"name":"ipfs-core-types","version":"0.10.4-7165bf71.0","description":"IPFS interface definitions used by implementations for API compatibility.","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"typesVersions":{"*":{"*":["*","dist/*","dist/src/*","dist/src/*/index"],"src/*":["*","dist/*","dist/src/*","dist/src/*/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"@ipld/dag-pb":"^2.1.3","@multiformats/multiaddr":"^10.0.0","interface-datastore":"^6.0.2","ipfs-unixfs":"^6.0.3","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^37.0.11"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"0ef2fedb9b9cbed1b4855c48b5f03d343ceb573b","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.10.4-7165bf71.0","_nodeVersion":"16.15.0","_npmVersion":"lerna/4.0.0/node@v16.15.0+x64 (linux)","dist":{"integrity":"sha512-fCnSwicFHQhzck6en6xHDj0nsslR9g6KAA4ckqaz2zezCMyUT+z/LeIeblaMmfvkMkVsfnZawKGInZZLW0tNrw==","shasum":"d99594806fa765112c6ffc15755a55ebb4d81286","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.10.4-7165bf71.0.tgz","fileCount":81,"unpackedSize":195968,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDAREh7HskNjCbmB2gBHzQDTz9XZwS1ZwKZPallpPfTCgIgPNAK76b3COo1AEWDXySSSy+srpJxEb9UJRvJHEtYp4Q="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJigq8TACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqXhw//f7BUud2Daaw+mTFL9Ha+Dl0vGXeJbwCQSI3mu93+VuOPSRNK\r\nJSfl/JzndgTQiK2OeLm8/ZaBM9xwYd+j04f3ffZfVv7UrOV18+lb22a3pJYV\r\n9aZ/Pq0qhFOOeKgFN2AhnkMk9K3ATP7d1DPN8w3Z9kXom8GqcrHB52wXH2KT\r\nilAb51v9yUzg8hwo0Y8v7F1YUFpwTCKQhjrkT0TWn8BVszaiFOgbwuSSSlf0\r\nC4V4O2QKxQy9/yNt4Y584u2iOqpaIYR0OUTkAlvLZ1IAJbuClorzDifaH8SE\r\nnHrep5Wb+SWcUoJbM8VkNgSVdmET3jy5vLWgRccOpWdg/K67LUTRyV+xGUiS\r\nG0Fr8O32vUqFz43hxOs7Z4uRH4xnOX5HQlSauExIedhQsFVohU22tpJy2JPx\r\n/QopHl4311KTCIg+Hx9nUuMpSoYbpYes3+p4QiM7eN5zirGVciULiK5wMQi9\r\nFkpTaho5G/IIjQDKbPdwo1xa2Qfp6Mn+eCRDAQ91zBefy1jPDIr3WQxk/z0J\r\nVpXkJWmEFQBioMY6md1JT6vSQXSbSX9StnqJCVIohJOIW12uSIHLdd0QVKeP\r\n/Ih7Ohwo73Mpfj9lhu+uznFb5dLt73npK8gps+M37wNHyFXjD0/2NUi9rxj4\r\nCeHWUyhpDCJm3wgDvL5Iox0iFly0a2PulL8=\r\n=ghPh\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.10.4-7165bf71.0_1652731666926_0.5616433431792185"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.10.4-4e93dd5d.0":{"name":"ipfs-core-types","version":"0.10.4-4e93dd5d.0","description":"IPFS interface definitions used by implementations for API compatibility.","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"typesVersions":{"*":{"*":["*","dist/*","dist/src/*","dist/src/*/index"],"src/*":["*","dist/*","dist/src/*","dist/src/*/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"@ipld/dag-pb":"^2.1.3","@multiformats/multiaddr":"^10.0.0","interface-datastore":"^6.0.2","ipfs-unixfs":"^6.0.3","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^37.0.11"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"102f592858ec8237081913452cf185a3e44d2596","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.10.4-4e93dd5d.0","_nodeVersion":"16.15.0","_npmVersion":"lerna/4.0.0/node@v16.15.0+x64 (linux)","dist":{"integrity":"sha512-IMLTWJDs4+fumuBHslzwhOZM9+qCXvyRgJydrvHuhkD+Elz7FuyzFtp3cHF2MVKoVln4/bR+7hGmivSVM2gbXQ==","shasum":"c6408d959c69382b7dad255c8597bb4939462f69","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.10.4-4e93dd5d.0.tgz","fileCount":81,"unpackedSize":195968,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCP3R60bGIxbatxCdwq0jVygn5hAjOxpio4lyKtOeAVQgIgLSlIz+LwGMF74bWmgmnuB4STqzjBM6KPWppLE2va2bM="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJikNVhACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoJYA//dYrB2ct1ixS64Qxq01bXgPEjioVR55v7zu+IefdgJBiQCcbT\r\nscI4K0PmOq2ixqBibQvYaMevW3W3tuhP5kqGAW31Dkn/6jZ/ZzcaiD6nNDw6\r\nLWSzjCLXRCTBzBw2oVZh0FdM5X1SpsHzbktK2/O5LOfJjjlByRa7GPBcfsR+\r\nRoTRgasf+vp3mjLJeYpoL4OQV1tM+QKM26BP80IfdYM8vbCW+9aJPAj3Rquz\r\nIoQc4bj/zckjN0ApArVhQ9Wcohk8h0WZsVrsTJmC5O3cR6wotHQFr7gQB4zi\r\n2O7Jp69Wu20nFKuRNcZkEwT+Xwdj/ZUQ9VkdNX0UxjNaqCi3ZiYcrd3gEhu9\r\ncIPG6ZDpSbiWwHwCc4lbW/jKYFc4KH6UGJbwr+Q0KhiZh82xLmaWSqBTu49H\r\nYvGNG9BBrens/EEUG0muyAUfdxv24lS809aIoKFJN31wSO7c7OeTxtwxboLd\r\n1v4M/CnmV9KlOMaUg5LyR3bNBoeRBT/nPpHS+8OIUyABDgivDu9CHaxsCRxi\r\nT/drOOu3AXHiuvUC/seuZsdT5p2pRjfljfORtHU1RybXNbEsFSoEIHqKOABu\r\nITZbxppy/qjfuMClEkiWPS5BxCzAHDKChC+eHdbbTndOAlvjf+vBY49AcHzR\r\n05k3WUcWoeXMv5uJhir8FKak3+vxC9fOY7M=\r\n=0GzU\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.10.4-4e93dd5d.0_1653658977328_0.2594272799256043"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.10.4-919b27a8.0":{"name":"ipfs-core-types","version":"0.10.4-919b27a8.0","description":"IPFS interface definitions used by implementations for API compatibility.","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"typesVersions":{"*":{"*":["*","dist/*","dist/src/*","dist/src/*/index"],"src/*":["*","dist/*","dist/src/*","dist/src/*/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"@ipld/dag-pb":"^2.1.3","@multiformats/multiaddr":"^10.0.0","interface-datastore":"^6.0.2","ipfs-unixfs":"^6.0.9","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^37.0.11"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"b3b172fe34f542a72746b3af9351bcaf25bedda7","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.10.4-919b27a8.0","_nodeVersion":"16.15.0","_npmVersion":"lerna/4.0.0/node@v16.15.0+x64 (linux)","dist":{"integrity":"sha512-sJwiWJmaEGxLwVf28bEKNkl6o2v0x4Mgv/2og3wjkoyVm2wESwR4eOXBEeqbHthqFYeczqj/doL0DkOddY4QYQ==","shasum":"572efce6d76d1418e7e09305caeb3fc58f4a2ba0","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.10.4-919b27a8.0.tgz","fileCount":81,"unpackedSize":195968,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDbovli9PAfcODjveehkWYyTbf/Ls5n+c8iyIMm+JKFsQIgPhckP7CFhZ+6RmqyC7hl9+owANcpUlDVFGVq40ngY6Y="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJikPnUACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrIZQ/+NgmD5k+8p6cOZpoYOeueWxsqosZ2/S7jftFBBNszvhvHQ/GV\r\nB0QC+sghtIQHwyAxelgyDsXGs5tU18Se1F4qxmQuNkaJMYsqBrJWVrKJ2Qw2\r\n3Qm3+P4+Fv28A6vtqlnzcTL5HdizTcTHjihVr7iGH1bDOYGN+nPPvjIFnG7j\r\n73zz7s3Avpxl5Ram9sr3uebihkCDe8ztvftxcYrxDGRdCUPEcecOJEXSF+97\r\nflSQtrkELGGnL9Je0wsxHHhEkyS8Bj5cILw7AZwcQsYs/upy5dBR2ROYv2Kh\r\nwHDkdahkpzkS3fBn7yGAX+diFRK8EKR4Ij0x5ahO9z+uC7kFSPbPvfQpSFx6\r\nZ9APfj1RpsDctfvziOnpfG+AqHk79u4SIJ5AgV7rUi6gjUai1807jl5e2EG8\r\nqA2kpTJMaFn50hj5RrmaPavzYUhmaQxvfhDExlylbIBPOJbs3qJUA3UFCUW6\r\njy5g5RK2dfE8uyyJT3yGw9XQxtI4Zmi+xhkcAV5PG4H0QGfl45gMzIwIiP8a\r\ndRrA9uoKQqdb/B5clMfolxtxA01okJyz5IHm4J3oijl8ISDKIaXvGcsiRdwQ\r\nuTF78tabX95w4UiXjoFn6v2QPluXeMWKc4M8XEjUAvBCFSibFXF84oBJ5Jle\r\neDCKA7yIs9hxTNZSmX0flmM2vh989I9EQWc=\r\n=P1Lc\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.10.4-919b27a8.0_1653668308193_0.5120478164905695"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.11.0":{"name":"ipfs-core-types","version":"0.11.0","description":"IPFS interface definitions used by implementations for API compatibility.","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"typesVersions":{"*":{"*":["*","dist/*","dist/src/*","dist/src/*/index"],"src/*":["*","dist/*","dist/src/*","dist/src/*/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"@ipld/dag-pb":"^2.1.3","@multiformats/multiaddr":"^10.0.0","interface-datastore":"^6.0.2","ipfs-unixfs":"^6.0.9","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^37.0.11"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"38e78cc875309ba6316706b63865e399dbcd18c0","_id":"ipfs-core-types@0.11.0","_nodeVersion":"16.15.0","_npmVersion":"lerna/4.0.0/node@v16.15.0+x64 (linux)","dist":{"integrity":"sha512-HwhxvBEPKMNBGsD2PbvncwKynPKcZtEwSuBCEih6/tR7zCkV5YGi5WAj1fXVuDAfRU3Se41xqJ6FKU4KWrP4cw==","shasum":"1a39417954fb5678ef9dbd82283f392fd94639cf","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.11.0.tgz","fileCount":81,"unpackedSize":195957,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEtD+xCuX0dB8cRxJ5pPtU5oHzecIUihEpnPNM74FxPpAiEA7TlgsH42kDCLgCxn6B0WYxqP2Fa1DWOkDOSxxRu3TPQ="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJilRg5ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoATA/+KTTmZHQxXqafZ9Ia/oSL1Bq6hFdeXbIgwVMJNZs3nJsLHv5K\r\nH3/aOZG5PrLB9Pt2jaLk6HxvI1GCLDPMgN8BdT1yGeokX3c/xzt3jNIrj5+Z\r\nn3xLOT2oeUMLTJ3WcA7d23pr0AFOpLQ/Xz7MIIj1aaZXw8SafEKsTmsojLsh\r\n4bntHkijQvyUuUp6HjQqmn318RNs9nepntl4k4dyK+iADCbDDvHhThUiY678\r\n2kZklwWt8+tAkN8F4AFvUnYoijZIzDbgHDTQGQBpUzKa0SAyhW8kIIOl0w/J\r\nMq3ni9PfqpKTjLvbvzlUQPNxX2b5afYTqtbWGnhcf+BBpfCTjzMVqjg3toQR\r\nlj9iNqzljcFJ6o/eQNdsHrN/6j5AMbe3r6ZWfpat3T7Fe5o3apsZlrpQ4GUp\r\nl1i0O91xTf+cqsHfA1d73Uo/swaUsOjtFEOPb49LJZKFpNHRmW0s0a753ysn\r\nIrxWVScgSegVsKoX8NhpjewpNUK2ic95oa56/SJeCxx6zaG+oOC1x1hU57LB\r\nBNUobr3c6iTFKJ00CcitGUyhCor2kO2N8BXyzaXq16lEly9Fzhmf8cFYNeDG\r\nxBD2qULDiZUMhxuSPJvnsL30YQFb8VmRvrZjjPooJY2qQltLZmVlDCnzsLXn\r\nzQSNhks75NEjjOEkanX2ink2iXGDQarlZxU=\r\n=xY5h\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.11.0_1653938232904_0.6332006758960089"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.11.1-ddfb899f.0":{"name":"ipfs-core-types","version":"0.11.1-ddfb899f.0","description":"IPFS interface definitions used by implementations for API compatibility.","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"typesVersions":{"*":{"*":["*","dist/*","dist/src/*","dist/src/*/index"],"src/*":["*","dist/*","dist/src/*","dist/src/*/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"@ipld/dag-pb":"^2.1.3","@multiformats/multiaddr":"^10.0.0","interface-datastore":"^6.0.2","ipfs-unixfs":"^6.0.9","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^37.0.11"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"87fbbf38470547cf82ced4c9fd2679df026170bd","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.11.1-ddfb899f.0","_nodeVersion":"16.15.0","_npmVersion":"lerna/4.0.0/node@v16.15.0+x64 (linux)","dist":{"integrity":"sha512-DrV75tuQ3wDjtFbfJkrszv4YQnr/8KAcJ4+1hINlknM+Am9hv80o+mRH1IkcocBNT5IjSAR55pcqqmegz66MgA==","shasum":"635509478105e209cb2a703d5aec3432c46e603d","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.11.1-ddfb899f.0.tgz","fileCount":81,"unpackedSize":195968,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDGNmLafNBRC60lNdEtuxahFQMbD2lOzdupGErLTDergwIhAL3WkanRRsdwJp2RyI33FymHe6yr6ECyqj+yMqsFgVsv"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJilSGDACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrapA//R1enp9q73Cn/KPE3LSqgwx0t4x2Rw2W7l4vAP0IuD/4kxjmY\r\nvyFMco4j02LEayzTY7Xq+beqcvbz+Hln/sPYmO5BbH1vym394f2mbZDBeA1t\r\nDj9MTZvdCiusImzNX5oGWG+T2Y75Jgucazld84WQ4oKF0JVPO2NXq4ZGdn/Z\r\n6loteaW7Lc7YtPUYDBz36F+J/CAsTfKIcrG9149Oeky2ttIGXiJ83iAEzoDL\r\nxGzW6NuxY00OV3DMCIceGM8OSWOomqRNYdaR5WEcsKvDEW1gzYHaV/TYdeIy\r\nSdBaIFY64KLBn069jgN6FhvNGiM49MUGh1emV0xdaBEFTgbgufCx0V/gb626\r\nSfhHT/KsIWQeB9pOzlZijcQNyvNSqQdSDVDOeZjHtU3fglIq2oZgg+gwMrcb\r\n71+r/xOlIxBGo6CJH8PXB3Vtz6YXHC26ZRPOWFEIRq/McSKgaJCvZx8hUNZs\r\negmZb6cVGaCzPVUTkiALaETDU29rani/nt64BoPq3biksQSjXWqERK6yfHYU\r\nRoANdEDaQahBkkTr7b4Mk7IGDOrNkSAGhaAQiHNNCT4CFOOzvefZpWbNnwrr\r\nZ0ndU+B8GShzBTHbRDtrwnC/HVJQbxu1umVZuByM7SxnHjyWuYT8XPRVuDJ2\r\nskIEm+FWCc9XfYv3PWQX9eWjZdq6Vu8JdlA=\r\n=7PgL\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.11.1-ddfb899f.0_1653940611737_0.10850043455909919"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.11.1-764b4adc.0":{"name":"ipfs-core-types","version":"0.11.1-764b4adc.0","description":"IPFS interface definitions used by implementations for API compatibility.","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"typesVersions":{"*":{"*":["*","dist/*","dist/src/*","dist/src/*/index"],"src/*":["*","dist/*","dist/src/*","dist/src/*/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"@ipld/dag-pb":"^2.1.3","@multiformats/multiaddr":"^10.0.0","interface-datastore":"^6.0.2","ipfs-unixfs":"^6.0.9","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^37.0.11"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"e174046b9ececfd2fb7fffcd8f6ad6211adc7499","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.11.1-764b4adc.0","_nodeVersion":"16.15.0","_npmVersion":"lerna/4.0.0/node@v16.15.0+x64 (linux)","dist":{"integrity":"sha512-1jIAOlnhhe2M2PK+K60W9m59xQDp1+XN0RcvmlbIHrBk18lBKNjOu2PJRFaSws5G6OsRuCDkPKzlGblZNRU0yw==","shasum":"7b01f589d9c76bba924dbfd8ce83403e7ebf1a6c","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.11.1-764b4adc.0.tgz","fileCount":81,"unpackedSize":195968,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEQcnIEqi20rDjFhGmbpoj2IUUG2I+riEZ2AXYM9XZsRAiAYFzphjtZ4wxTn8oKZntI7YNHokcBdWNvc7aj79W3Ekw=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJil3cEACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmq4vw//X0T5L/OYLQcOe+klXBSsD2dPgz4BDq19Uhli3f2HOSu1v4wc\r\nwR7e7ommD+yksXiuFCCb/r5QLXY5bDn51ZfOzndh1JAk5z/eA2lWT1xcH+65\r\nHD6S8HYh51eRzGacSbc3B2lL1SFYKRBVfCZnpf60+UxcF9p3PLDTyf+LVeJ8\r\ndHR7TtjV44qguEQntG7q6E/ZH7gTZU3ckxwzignhbkGA4gq9XIdekPMVjvVR\r\n6pv9A0n638en4YHIOWxXYxKMOq0uyvidqeOjVlao/uihQYxv8EbHOqJCsW8j\r\nkVRKz1VKaXZJ/IfZnb68Rg+lcSwcVOA4AnXqHl2DfAdt0uKWp/SkDAgRellA\r\nz7P76CsBFbHp2E7j7ewsgShaj/0WUE2xthLryqFY1u7HMTd4lwQHtsLma5vK\r\nkNw9j+3N7uZYl4Nkr6tt/pV0v6auF/nZg3lzH+Qp9yrzpdP61pa5UYoRkoES\r\nrQ4xvvYQke4UVQAaBJls5xYpquUNZzfIfCEr5jfK2RP8CTb/Yt9jvMSByWD1\r\n1TXssSrR1ey4GHqvIUjXfsipSKazCL7EnVcDUOCdmd4zqP07E/FY58VRv05V\r\npwDC6JxvKtZXgrmjS8FOAMsue06qc17gFbte+pz6igXxBtWx1ujL3Q3bO+yv\r\neQSp0RmdQAa4EsUkpBRz7koAmWOPz6f0j4E=\r\n=m/4E\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.11.1-764b4adc.0_1654093572177_0.9207911301054417"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.11.1-be025c89.0":{"name":"ipfs-core-types","version":"0.11.1-be025c89.0","description":"IPFS interface definitions used by implementations for API compatibility.","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"typesVersions":{"*":{"*":["*","dist/*","dist/src/*","dist/src/*/index"],"src/*":["*","dist/*","dist/src/*","dist/src/*/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"@ipld/dag-pb":"^2.1.3","@multiformats/multiaddr":"^10.0.0","interface-datastore":"^6.0.2","ipfs-unixfs":"^6.0.9","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^37.0.11"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"624dbe983b6f235125107b73ccce5ca3e45cbe7d","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.11.1-be025c89.0","_nodeVersion":"16.15.0","_npmVersion":"lerna/4.0.0/node@v16.15.0+x64 (linux)","dist":{"integrity":"sha512-fvvLKHMmvb4aG3StuZ5MiZYMMP493gAMrDGkm1Fms0nJNdNetKGREjZkQ/sv6HWLi90UHo7qq9w0YAun49WF8A==","shasum":"6d649a522371b7d9543f1540999b4de44d21e6a1","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.11.1-be025c89.0.tgz","fileCount":81,"unpackedSize":195968,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCnN5+ttUZaBvUd5zXXjbl/pGax30HY+UvJtE0mqY6PkAIhAOPPw39ii6m8TssgD1GNKX9ZVchw87mV5AkOxwwPC9se"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJil3g6ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoiIQ//XUZmEDJu91B1sf5AdZ0gvV088uedH+ZA8+lOMMaYO871QHX1\r\nIo5VxRa+/Oab8h07A4XxBUv51OmaviqNh9jlaW4XiYWwPnDZKUamyjcfzR8i\r\nzQuLoe0olXNXkFMfe8u59zpRm4whxhsRYNbjLgnMtJFIRpah3JNT08t+tLrT\r\nnP/YQqIVqPXF2r7NNBZGTcLai7efX/LI49H4gDGxNxYScqYmOuQs0/XzRG1X\r\n2g2DyOCyrWCSZpNphRjZLS89FHBQpZ6lY5U23adw3PcM20sMF4W2Q2Oezp20\r\nbfWaJRnZn9wgNd9JaGMvnwL857MVph8hY1FUCHU1Xo8JXIRZvllU+5JIpTkC\r\nyafoheGpNxAE4GHN9e+VfgVBmgIXgLyWWCGZIbn4E7j4WZKkSnEzAJuewB/g\r\nwDX4+zVfIACf17uD14NkbnW/3XUwBp3XB4hr4eXZgb1eRh9zwbpozgRezx5r\r\nLVuk86ZFG+KjmK+zG16rVAvWycA2k/miXPtVrSjl28OZEUHg1UVwt7VzCVLs\r\nm5lpC5QQfD6g0NJj+MLn5f8XDMkXeBkQGXFh51rLDejno4DDLtCRQZ+ETSBV\r\nAlKDEh0nE0qv1ZYbdrclUemMfSHIs3Mw8W4ewyHfTEXWzwC0ptZbSx1qFJma\r\ng4QKfyu/jQu1zjOvIrltzHE3oWO0e/xhDwQ=\r\n=3lHp\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.11.1-be025c89.0_1654093882069_0.6069726212822724"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.11.1-87e00a69.0":{"name":"ipfs-core-types","version":"0.11.1-87e00a69.0","description":"IPFS interface definitions used by implementations for API compatibility.","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"typesVersions":{"*":{"*":["*","dist/*","dist/src/*","dist/src/*/index"],"src/*":["*","dist/*","dist/src/*","dist/src/*/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"@ipld/dag-pb":"^2.1.3","@multiformats/multiaddr":"^10.0.0","interface-datastore":"^6.0.2","ipfs-unixfs":"^6.0.9","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^37.0.11"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"4aa63330e4f3184df8f4d39cd0880c0ac903e795","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.11.1-87e00a69.0","_nodeVersion":"16.15.0","_npmVersion":"lerna/4.0.0/node@v16.15.0+x64 (linux)","dist":{"integrity":"sha512-+fkHdIVtCFUYX/3fXrtGXtzA0gZ4bcrsqyboDD08miCpgcVAyifr2aQms9DNraEO2miXg/HpstkSgY33m9ALkQ==","shasum":"bccc27d6c03d40be89e67ff9701ab915ddcd3f41","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.11.1-87e00a69.0.tgz","fileCount":81,"unpackedSize":195968,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCXC7vJRLpWh1teS3rDHr2Duazp/0wqcSn3SQGi77ylvAIgeXhyxyUVhbD+L8blSaHTvHFWT/wlK0ThILNET00lxI4="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJil3lSACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmrehw/+MQubHSJsieTjkDk5oazNYfgVtii+1pKncV0j3T+ZGsZ4FcM4\r\nyH4r+iZQUBvWrz0HZ8pLusfioij7dsHOy6ONgG6QwWKJJ51IryPFhn197QmJ\r\nMtpKZCTsLzESEDPY1k88VWc8yAaNtKiEng2bLNTjR6yKuRNUNWDYWjWsfLf3\r\nMWghgDccrhpRiijSr0cuotGgvwRlSO8nqggcwve936cl5ayrd++kTxFHcd2i\r\nznOmhKICIPPslc8I5rcrjyMX59NHsgO3MNy6U9imvprlNg9hephi8qYiTn7C\r\nekWic6TPv861VJ0kC2PjI+KcEmh/v7qi5IkyMuGxuKmSawkX+BHjrhIYJT8U\r\n96LEJnwEfJTJ+YI8OSIiGNB4/QOBGfDzBNHCeRIDxFcjPHNBDImrJhM9EpKC\r\ngOjzebkvBoBM/+PO5RPOerAaJ5oMG2NnLAtdrkGxj42iNiiRNHrrCl/5Glb5\r\nMLQwYityKFgaFlWkCoqTorD0Kes4hWRHAmBzyYLcfX1bvgCEXF4EeiPq3hqy\r\nH4ICpNLn3SOfEG8g85YVPqyXLk2+YTRn0/3zAztuxtNtmF9VgNULayo8TqYh\r\nqaUYv/KWJgX+bZYSeFXraIezvoOxUFYuWnYgVkgWq8qVwRHy0u+dwjDYLsrJ\r\nfspxW+Ent+jkG76x3zOaWUUEkFCZ07AojPM=\r\n=Y8Fq\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.11.1-87e00a69.0_1654094162486_0.004235124991895711"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.11.1-70e142ac.0":{"name":"ipfs-core-types","version":"0.11.1-70e142ac.0","description":"IPFS interface definitions used by implementations for API compatibility.","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"typesVersions":{"*":{"*":["*","dist/*","dist/src/*","dist/src/*/index"],"src/*":["*","dist/*","dist/src/*","dist/src/*/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"@ipld/dag-pb":"^2.1.3","@multiformats/multiaddr":"^10.0.0","interface-datastore":"^6.0.2","ipfs-unixfs":"^6.0.9","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^37.0.11"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"1a6e6bef85bf35b9328b61ce15d312f1961f5fef","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.11.1-70e142ac.0","_nodeVersion":"16.15.1","_npmVersion":"lerna/4.0.0/node@v16.15.1+x64 (linux)","dist":{"integrity":"sha512-eaFpuQGli9Kp8aY0Co7RSdB/SbN4b8CNqh9e3twc9hwDMeItOSQwKYF6RdrJGDZfu6fV8ZQFh7Rkt3mlZzh85w==","shasum":"4aac66a833c4087abd2c460a2284b7c42071f18b","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.11.1-70e142ac.0.tgz","fileCount":81,"unpackedSize":195033,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDIEpslIoGg6qVbO573tzq0u6UYgO4Gw7uIR0zjPyGiFwIgDwbiIEPd5MY3gFcZz6YeGoesESknSoXdc4OMpqA0xYA="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJip18ZACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmofSw/+L+mI92FAZwy6rAho5fQsb8cDnbxSPpIN2W6S6W8Ve0UhdzH9\r\no7uR+FGEWYD11cDfA1JFXAhlVchTOOYkVX6wcrjH4xcaI/pcArcffEZ8N5Uq\r\nCh7ygyAeI8ukHfmnmoEfuam2kGtrXW5MuL3JpoSjMT7RNkqW+P7SciJzTG1U\r\nbcVT3HOdjnN1XWCYhhCqAb9jASJJkEyftcaJNNYNWUf04w2IyDsvVzX+sw5+\r\nLFBHUhz6AzIxbydoDbUX0vJUmBCf1wYgdKqVqvQ2iaXw5jzNNj7H1r87j+us\r\nCQhRfKQ5xtJ9K8DgmjM2GEjhFrl0o+NeJL0O7KlQzD2DxSi/56l5bs9lZ7Y7\r\n7zRVMXpXkVXDXGrV+xRiphLA8dkl6oJrGYzyvNN4XeLQEEClLoJ4aDZ1ZzBh\r\nzjcjiS5aMg8VYEBwvJAQNSoJWfwdGTzpNrkozoAkQOpVTAm00LtFOE6OYOt0\r\nrhYrj7uoHz2rsr5xwjqTgZcSgQml4zsQIRLfi3j4NH92/sX9RVKYPpphVJJ6\r\nxYBfqteeEI4aLZLnh9+qTTyKj+ZHsnLKx9KWUMOhe0s5VZpVMan0S6SV2BTr\r\n8SnNiunbOs8gY0aYrXLtkB13tzBeoTMo7/NBgVJzFpXWro/96oaFOl4Yyb3m\r\nYsDTjPQshDuVn3p5VyeE7f57yoXZdYq96Zs=\r\n=9x6H\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.11.1-70e142ac.0_1655136025367_0.6614712612425655"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.11.1-7be50bd1.0":{"name":"ipfs-core-types","version":"0.11.1-7be50bd1.0","description":"IPFS interface definitions used by implementations for API compatibility.","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"typesVersions":{"*":{"*":["*","dist/*","dist/src/*","dist/src/*/index"],"src/*":["*","dist/*","dist/src/*","dist/src/*/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"@ipld/dag-pb":"^2.1.3","@multiformats/multiaddr":"^10.0.0","interface-datastore":"^6.1.1","ipfs-unixfs":"^6.0.9","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^37.0.11"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"8d1e141b6d72e6dca9162859d36425eab90d8b12","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.11.1-7be50bd1.0","_nodeVersion":"16.15.1","_npmVersion":"lerna/4.0.0/node@v16.15.1+x64 (linux)","dist":{"integrity":"sha512-L1ro8TBgkl7GBH4B7fXowBFy1qLO4JkKc96KL8bH9S75Oerf1jPuaDu6CjlJCxWUJI6/Dk6t9VRDfMP84+WL1w==","shasum":"3b49a64ea12ae4cd9afdba086ae393688c490bd1","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.11.1-7be50bd1.0.tgz","fileCount":81,"unpackedSize":195046,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIF6pWncCe+ug86pxDMLHP2lUJoJEi0z0ydu4zpoKonZvAiEAx1RS05II3Uvfw61MI51ZPiVmczBhbZSaBSgwyQz/oM4="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJis1XsACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmpt7A/+I5LFdi0kkdS4j6hwlA2QEUdZXp/CodF2NuLVviIpP3Ku9/9O\r\nFoJeTwlkmGM9+N68tOsxMAZQs6h1mSs5xly6+p+AlG9pQ0vjCxqO+lm4mT4f\r\n2YjKV9ePYJ1c85Npb2vlL+KtujpQj5Sc1FhJtGTJHKMHL7dMFtBdAPSFF956\r\naq6IQNprnrqCdo0YGL2QSaC9WZTbtl7d1eEpDMPaAh5KfR28n8rqZknPOzTm\r\nEl03p56ISGc4fyQpGt0Wu8EnDQoWeTYbBZxXI7Gu5JlNKNi5lOjs6ZRrcygB\r\n5LebhNibONJNCgNceNDA5TDxZWqTJeAHkMtg54Oohmmr2YLdyjFLRCkPW2Jt\r\npsgw1EJ7zv75fd4n+w9yKStIx1Vqp+e8dY6f7sTdrgBugcDflCtzh3le3FHR\r\njO29klONXCDUabX6AGiWYItq1wQq/Gykk8Zsb0Wa4xNYIB3fgforvHZkPYcP\r\nOrf0LP1Q/0Je5R0fegl67KHTF3Hf3cvnXBQKRn0VAag9CIstF9l7EwppU40Z\r\nqpkKSpcEgTeNJjobX1ST15pSsj4lQl9ru0wRRr40K/5GPwFUR2g/KInhIScE\r\nZGWGiDJA8rHobOtcigWxZxAEyADfptXNdx/pXFo0xK6YhF5r7CxGxVwma8zB\r\nrQ3LiVbzYvcySsnfM3MttyUSFibFwLk5VHE=\r\n=uag4\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.11.1-7be50bd1.0_1655920107963_0.7017178861353244"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.11.1":{"name":"ipfs-core-types","version":"0.11.1","description":"IPFS interface definitions used by implementations for API compatibility.","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"typesVersions":{"*":{"*":["*","dist/*","dist/src/*","dist/src/*/index"],"src/*":["*","dist/*","dist/src/*","dist/src/*/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"@ipld/dag-pb":"^2.1.3","@multiformats/multiaddr":"^10.0.0","interface-datastore":"^6.1.1","ipfs-unixfs":"^6.0.9","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^37.0.11"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"c1cbc810679405d5a5c0fcca0c5c7aaf023b2d22","_id":"ipfs-core-types@0.11.1","_nodeVersion":"16.15.1","_npmVersion":"lerna/4.0.0/node@v16.15.1+x64 (linux)","dist":{"integrity":"sha512-K7ZSx9EPEvT4At2kExKyMCqY4Jo3Nb/VnC/iSWqFKRaqb0MTB4IJgvWrwwDuN541tn+dvUnTfOp2wWQSov1UAw==","shasum":"fd73abe3197114fe6454551ead1dc883dd76559a","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.11.1.tgz","fileCount":81,"unpackedSize":195035,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIH85Tqaq+QUWto+tFNshxwGSnhz6gPpGTog2SmhKR2HQAiEAlkLV3cxFE3ykLzwwZ4H4Abydh3hRO+eLYYlh/wEbL4I="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJitFZ8ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqduA/9EbDxATHc8S4NVNCK2J649Y/IPhohm48ZdEt2B0w95ePV83sU\r\nCySlNVlQhTVLZdf7M6CxzyUJXRr75Z0wD13sOB6n5xThVTmKASbgUPakbKy3\r\nml4/wmQcEXmfwMF/xGX4sPRYeMHTTqvIQ4WkYNtJLaJv4Tb+sXETb0mB6giL\r\njGuQi6buAoCNnIi6mQj/ylo/lBqT7P4T2wKMDEfM6G6h16eUsmaAGtFdsvQ1\r\nuRdo0yACJ3lUo7xYM5CUPxPu20TfTTh+x4et07uVDIvMPDLxPigIUuSs9PFd\r\nraQB/wnyUBPWds7a6cLqntKw8SJu1IDfAvhhzFPU7uWkt/IUgvMY7A9ufm7W\r\ncBrNJJ5vFuLuU5JKo43Ndftc/F88WruufBLU113a6poE1t9j2+tAe+XT405P\r\nMqGYnTYz3eAZkUA/yLckQzjQDCEK17MLfQiG2uZVKqv3xtN3czpr2EqxXJLI\r\nVg1wd71YfLm9jMKhpxgyJhRb2WV57AuWFkck6cKHpFG35Eqp+JtyX/3oXd/u\r\nsmvuNqIErGdrhcZR2NI1fOoAZbAKg2d6Hn9unNnKcyb5EYHULshVLh6NxCaP\r\n5Us9hQGdUyzH2JX8mQAZnmrQJJ0xnLuHtLgdM70iXwoTY3lvN/+J8bhHu5AM\r\nXe++E1Qm2KD0XtWWMc0Fsg7ct5xIAd4lt1M=\r\n=vt66\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.11.1_1655985788452_0.2138794022762891"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.11.2-00bd3dd0.0":{"name":"ipfs-core-types","version":"0.11.2-00bd3dd0.0","description":"IPFS interface definitions used by implementations for API compatibility.","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"typesVersions":{"*":{"*":["*","dist/*","dist/src/*","dist/src/*/index"],"src/*":["*","dist/*","dist/src/*","dist/src/*/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"@ipld/dag-pb":"^2.1.3","@multiformats/multiaddr":"^10.0.0","interface-datastore":"^6.1.1","ipfs-unixfs":"^6.0.9","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^37.0.11"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"5e5669eefa320838c4810adf62356b0039209ed2","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.11.2-00bd3dd0.0","_nodeVersion":"16.15.1","_npmVersion":"lerna/4.0.0/node@v16.15.1+x64 (linux)","dist":{"integrity":"sha512-cbf4Aj6qXJqy35PWQtFxtGp+NE5S3eUE33n45y5nFSWpHjlzkkJvnPh86pAHna+PEZ3Xf9c9jHqj9szTX6JeNg==","shasum":"84f88a8949eac9c8c18fd0055a63ec89d201b3fd","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.11.2-00bd3dd0.0.tgz","fileCount":81,"unpackedSize":195046,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCMIjXgtYV5PvhdoiOfYB6PCQ3u5NI1y6e7NGMlZ94svgIhALewxfJgAPVDzkuzbVGD913M6e4wrPdYBTdnUPthELk+"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJitYQ/ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoNDg/+LOEs1yot4qVOFN47geQgzl5d6PF5aY9kyc1Lyq8FUzwFKE/o\r\nbVgCrspCBKEI+WP+3JqtFP/lsans42Pz8psABhBhYcG9ba3S6CNiVin/W5Zo\r\ny+JDHI9s7obfMFO7aAShB+h4ZKpLO7oPL6J4grzq1AwmlfZSzZtSkqQGPPR4\r\n33jwaENM4IcELEtxKey0otvxUFZ9MrMAsCMHAjnyUPzzZYose2uUCy/Cl2Xm\r\nZ+Yy/hCN5nn1I7NxOYX5B/qUczYgDHfNinE8dJ76pAZtdY2HN4Q8lz0Qvmls\r\nwNJxCqnVSfqd0qMxZMXPMD2Wy6GJ1crhMV+xspDsuPDekhqyqAb/GN2IVY0j\r\ncaVUm7cKSlCSBEcSAP3nNSSNd6QCiCzW1E0JzabylWe323KsDgvhfT7kxhbI\r\n2G2/WFxZMXEPD5/T8rLa+tbj5R93XOFQQK1Fwv2plPBI5W0tsiJwoQCP61s8\r\nIXKu8m8L415r6fBGZPV2KhC0z8LjH5u/YA0qHyyN9jBtwV1oShznw9+xTdHM\r\n/3fSLAzfKgRniH9meevDvHfRNFTB7CuJccQpiDOg0Qs+cC8xD8RuVYAhoqtS\r\nx5//PlyTSCey8QfgGDHr/ksBf6xof+eoo72CGQ21R62/TJG9QLIElTb8TQhL\r\nSbbJiKnKgZZWqNM2piRr2adnMs3DjprUMW8=\r\n=2JHf\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.11.2-00bd3dd0.0_1656063039628_0.03971991714090661"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.11.2-a05695fc.0":{"name":"ipfs-core-types","version":"0.11.2-a05695fc.0","description":"IPFS interface definitions used by implementations for API compatibility.","types":"dist/src/index.d.ts","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"typesVersions":{"*":{"*":["*","dist/*","dist/src/*","dist/src/*/index"],"src/*":["*","dist/*","dist/src/*","dist/src/*/index"]}},"eslintConfig":{"extends":"ipfs"},"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"keywords":["IPFS","types","interface","API"],"license":"(Apache-2.0 OR MIT)","dependencies":{"@ipld/dag-pb":"^2.1.3","@multiformats/multiaddr":"^10.0.0","interface-datastore":"^6.1.1","ipfs-unixfs":"^6.0.9","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^37.0.11"},"contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"gitHead":"06da5952a6d61e890ae37d305b99a5f174a1555d","readme":"# ipfs-core-types \n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/js-ipfs/status.svg?style=flat-square&path=packages/ipfs-core-types)](https://david-dm.org/ipfs/js-ipfs?path=packages/ipfs-core-types)\n\n> IPFS interface definitions used by implementations for API compatibility\n\n## Table of Contents \n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [Contribute](#contribute)\n - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n## Install\n\nIn JavaScript land:\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[![](https://github.com/ipfs/js-ipfs/raw/master/ipfs-core-types/img/badge.png)](https://github.com/ipfs/js-ipfs/tree/master/ipfs-core-types)\n","readmeFilename":"README.md","_id":"ipfs-core-types@0.11.2-a05695fc.0","_nodeVersion":"16.16.0","_npmVersion":"lerna/4.0.0/node@v16.16.0+x64 (linux)","dist":{"integrity":"sha512-79XXPfg/71lcSNUE72fTfBujOLB4uzBfxKBCzwhlU410Df4P2j61YnWH1t6/jxJ9+230caT1AZU+D+I3zHtkhA==","shasum":"720e17fe94cbb40f554e0bed9eeefe7cebd28e7f","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.11.2-a05695fc.0.tgz","fileCount":81,"unpackedSize":195046,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBkxuP6oe4yc9n2gdZo8xWeF0Z5L2Ah9aiOvRynjMNR1AiEAu+wDIus9kZ7JS+CokUDBeaTfffk2g6uMgt+tt/3SFEc="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJi2AGCACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmofFw//YsCcmYpPjGtgbw0BwZtm+JAsMU2MrRpb5lTNkx0TWnTiUs11\r\nytG2dFQLo0voFInzozMnoKRvgGCI6g7MHGt7DGILXYBejkHUxL9kyxlzFIvg\r\nzsiBHAzsSoZDJgc11jUwVfrn8GQmW03vhMcCqM+A3L4KR3iKjLsp/nGykpty\r\n4sfiDbHZO/4qKrUTa2tf9rNQwJ7tysxk6F6QUUZU/m/epIeVTdKhFCT84vY7\r\nS90ZaGPmQ3QVeTE1ABuSbwxxiNVRMffcd3iIMeTjyizlkbFhVCE03XtuFqHt\r\nJBzSNDYDFEeiTk4PS3B7g4laH541NVSTZ7fLW0iWMR6p1GxCiwe8a9A09HiM\r\nQthhUIycl48LYR4kq8jXeZhwLZVitW9mC57ZmFJWiOxfd7vZ1Cwt18Rd63fq\r\nbgCRVdz9HueZfGUnRyrzPjV5Q8jEoEhhXDbgQRg9d/61pE8F7ADjVjtY2wdc\r\noCCDzcjci5JCEKadvOukYdRS+JN/KcQ3ND7uFozHlbs5PSQb7jn8ToDuwEaJ\r\nNTq2J0rKU5G74mtaSjg707iVa4b/okggkBjtmfZ4vaudKrg8/RwF/SLzBlx4\r\ngJOIj0vkazDJmHbxv5zmF9VAQEghXgI6lYBZjSrMhQg05YioDm07hjfA1uxT\r\npudl7+Fr9BGhFbzE9a4LhAR+IcfJCqk5ySA=\r\n=Ayyt\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.11.2-a05695fc.0_1658323330635_0.8448023438919485"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.11.2-39dbf708.0":{"name":"ipfs-core-types","version":"0.11.2-39dbf708.0","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^2.1.3","@libp2p/interface-keychain":"^1.0.3","@libp2p/interface-peer-id":"^1.0.4","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^2.0.0","@multiformats/multiaddr":"^10.1.8","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^7.0.0","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^37.0.11"},"gitHead":"a2f1f57d7993d04b2d19c3d7ecbeecc95a54d2ae","readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","_id":"ipfs-core-types@0.11.2-39dbf708.0","_nodeVersion":"16.16.0","_npmVersion":"lerna/5.4.3/node@v16.16.0+x64 (linux)","dist":{"integrity":"sha512-Dbv/o7wc2mLgl29uCRnTsOy6ARLOv+onw7sGFCoaW3Eq4XUJIz9ikDm1YlfLtzX5GbZ2Ta7eVYYzdxa8iY70Lw==","shasum":"4c2b6420b3e822e8fe1063dde8a862f0451e08ac","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.11.2-39dbf708.0.tgz","fileCount":133,"unpackedSize":200752,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDys8lMle+JMqq760jdCeGQrSP/DOx3BSBIOx21WwfFZQIhAKaH8h4kITOZvD5PFduS1dnxMpJFTBdq5kCrvFsk9dDr"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJi/WDaACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmrm8g//csJMQKGbhzyEcUXXwonDJc1TR5F0Yf0ZNhC7CB0jX+x6Wlld\r\nMZ3/RK3i/gPGuNviqJpx34NVj3c8I4GolmwemCbZee2Y51E+ldPsj5FtwHnD\r\nEMIiE+2JqEzuQyVc/jWsaPziAyewEjs2fyUdviYj8XW8I4jQ+jojGjcz1UTa\r\n80x2dgUbezoPM+zNBypab89vgZWmd6VKsHP7R+sI7m5JPVsdkyxu95DkG2TR\r\nYwzKnYmrCaGn61pVecoH4WxXqYN5C06XF763E2LaSpUKUX8dDKHsjkBpnQHO\r\nc1UVOTMjnWBRKlE+O9ZEYUO09cpMKfmFupGcBqkWWB5YdyIi0lDf6WiwOt7C\r\n3ZoSZrs/cKBjRL4p6am+i5FAd+1bQrKfDKvNgnauKWaB74h9C4yK0W5K1U58\r\nFcF1fgTFcMXkG+0Rwo8vIDNu51wFgUHMqkfTEL5H33Hw2jocGh9Ye68ePfvX\r\nOURQl6KwUtets4iS73GUyzOzeYLsGkNvSElhAdTd3ImjffXVLAbBUgEBWD73\r\n+BLr76XoteIc4HkOh3LeZ5EEAkFmdwSJV4xBp734TRyMNXmP3IycB4aXNK8D\r\nwUuPoWgc4iaj/RJckJ7vsCpXM5/vs0L2TfBc3RnQUVTXXxr3pwZbbLVGBAe8\r\nC/zrAhBMnRwoAWB+uqkM7umbG6/rJX6XAKk=\r\n=7gp4\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.11.2-39dbf708.0_1660772570342_0.07314378151213408"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.11.2-8f351a89.0":{"name":"ipfs-core-types","version":"0.11.2-8f351a89.0","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^2.1.3","@libp2p/interface-keychain":"^1.0.3","@libp2p/interface-peer-id":"^1.0.4","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^2.0.0","@multiformats/multiaddr":"^10.1.8","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^7.0.0","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^37.0.11"},"gitHead":"59229f179fc680ee9075d2cc8deeceb7ff1b27d8","readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","_id":"ipfs-core-types@0.11.2-8f351a89.0","_nodeVersion":"16.16.0","_npmVersion":"lerna/5.4.3/node@v16.16.0+x64 (linux)","dist":{"integrity":"sha512-N8CniRGR69SwPuxw+Li3ROa/kC+xAM6xA8swhEdSucjyMJFyCPX/s0gSCikfweBiHEsjdbCEJcbSa5ULdc0srQ==","shasum":"ad38a76697ee34b77e90cc8a1e1097e6f4826bd0","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.11.2-8f351a89.0.tgz","fileCount":133,"unpackedSize":200758,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQC1XD53wW+ER37cfUxUFk/rbV9iQpdagN73BJdMEkHiyQIgX5jF33LKPhlzeXmFW2w3Vi9r66+vsPx+BPw3Sn5bb4o="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJi/XdTACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpwERAApMKoKLB9HX/lZf8UyDoRENcOLnUS5stDD8vHfI8TZmlnO3Tk\r\nVRTlOmL9wmB1hk1pEAWhh2YFIYMoxOW9uexGe6V3etDQ8SV1owbXX5LWlgVi\r\na2CC01RmulnvCKAyHp0w9vTTMVqEL4KzWtdJkV4KhK1KSCHOK6t5sx9AgeHK\r\ngkG4jgkSOLzlgwh3IZ6AVneSQFVUqhmSjwSzZazEiCziMV7xyCxNvHFL+wrf\r\nJgA1rPe7+P1GpAikBKRYlru66aQ/162zZVfPaqFczP38rvEJt7dvP/onWnP+\r\nbEda/XUfgucQAITfkEjvL/OKRaAho129I3w6AenDYa17EummC8F2OwANLVMw\r\n1z+/svVp52raiXc+wp96707sf+qOvCbUdRR2xrn38zWme48lsw5tLXwrcWJB\r\nSkuqcbvIdvmmC800y5avcR1TK5wSE526O1lFgbtdgSdRknmYXakmkQEnlfcv\r\nIHQRrKgwL1zUMivu/yfaAZYmV3GqhjoLhyimKMkMcan9z43d1oEJng6rtfVm\r\ntSOHwDTOWqMB8ag1UHTibjxHgtAcdtHv+Z4C5xQeV/y79QmM96SIDNUi4qbF\r\nbDNa/hFckSJAcEVCjrfyMkUTp0kD0y9hofUJysSX+Lagqq8UJ/Rzoh1svOf5\r\n4hKK7jjoMIOYWmiN9KqPxGCVeurnnh8VDuE=\r\n=Cmro\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.11.2-8f351a89.0_1660778323163_0.03951631172932757"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.11.2-83f9882e.0":{"name":"ipfs-core-types","version":"0.11.2-83f9882e.0","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^2.1.3","@libp2p/interface-keychain":"^1.0.3","@libp2p/interface-peer-id":"^1.0.4","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^2.0.0","@multiformats/multiaddr":"^10.1.8","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^7.0.0","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^37.0.11"},"gitHead":"368c95b50c87246f0c5b143b79deaa4329d0727a","readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","_id":"ipfs-core-types@0.11.2-83f9882e.0","_nodeVersion":"16.17.0","_npmVersion":"lerna/5.5.0/node@v16.17.0+x64 (linux)","dist":{"integrity":"sha512-LoXhS61wfRwqn0jN+C43jr3UDmUUvDPoMCJU3KeMqTbq4mHg/qRII2CBqVmperPFICHne7k1/HDroxzGHAK+wQ==","shasum":"bcd785752e39754da04eb26554f74c159745b4f5","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.11.2-83f9882e.0.tgz","fileCount":133,"unpackedSize":200758,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICa8/cnUSMZSqNB1Jtqmmtd5pt7WjKRRHhwRrK8KWyH0AiEA7uMykvMSJRKihDb9CPoxjoFf9JgubR8yFpWeNF8UM8U="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjFy9PACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrnlxAAlzJka2/C3jhN2m6xfrVOSMBjdeim3zR5+GBjC/f6t1PYZZR+\r\n3GdJYuvbufOi8y2Xo5RGhSfkLxe0LyVcVbugPr9HT4I5zDSWwaF3h068Htfr\r\ny2TujnJxchgH5LPzAkTfjhSWnMjXm2JYndX5NiB6fV3vfYBGhMsihoJqb72G\r\njKbKaeYmtCABq9D/8PZ+zIOeF9H8Z1tGujKgIwk7B163t0OOE6BN84NLul3f\r\n4fE487n34E+FhqFFqqw4bTwFXMbMAc3uAHNqE2KkuypCpU9hMwIEvgaa8COp\r\nVGTuRgz+eHWHUMt7ZBFxIIcqqKSIF7PnzKvqqX01SmisKpaefrWxkJ9GA5aA\r\n48m/uRI8tAMk4zal3mEK+xbtKWn8mAH3A+lONF3j/3ijzqM5ryHIcyRvrsQ9\r\n6YxSTxWF0z90KSraljJs4HRi0A8Q2amf7kOs7h5IwQHyKDmOvZuzj9KaGqzk\r\n5s/xULErIGPhW2lXZO6t1ePFOLxN4TnhtggnXXrOFhSZLBgMjf+3w/12efp9\r\nbsHf7bmq5Tkf/LDsoBdeyC+equxGof6+K3P9ygmvlMNaovAsyIFOE0Ep7AH5\r\n9Y2jv8Q6S5bSSW6COc0E30/zllZeIB2irrqomTjlzB2giokO5nElgzk6MPBB\r\ncwzy86XaWSd2PIBAphfo9A5KE40N+f/Ghww=\r\n=Eu6o\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.11.2-83f9882e.0_1662463823105_0.9004732685698342"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.11.2-051da161.0":{"name":"ipfs-core-types","version":"0.11.2-051da161.0","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^2.1.3","@libp2p/interface-keychain":"^1.0.3","@libp2p/interface-peer-id":"^1.0.4","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^2.0.0","@multiformats/multiaddr":"^10.4.0","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^7.0.0","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^37.0.11"},"gitHead":"262c2c4e56b8de0c602251e9ea0ac3546fd2e28c","readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","_id":"ipfs-core-types@0.11.2-051da161.0","_nodeVersion":"16.17.0","_npmVersion":"lerna/5.5.0/node@v16.17.0+x64 (linux)","dist":{"integrity":"sha512-EH6K8FA/kjTSzZCmF/VmqS1OC5eNmmX7kvD/LKwXM8k2NxufRaWIi1DNiYGfee24v2N3CKvkMeiM95UveT63vw==","shasum":"7815a3da7bcaf9b1c98a8329cd2a9e30192528af","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.11.2-051da161.0.tgz","fileCount":133,"unpackedSize":200758,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDQEVoWPq0CW5Hdg8S1IiFgbX1kRKfCyA7cMq9+XX6YZQIhAPC5x2U6QvL56zKsn4IR1ZcobZ3fFVcNpT2IRbb4P/YT"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjGJSzACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmovKg/+NfNtUn4Sofljv15a5TkQY9m5M1lZtFWSoGdpCvbrsEEEHZ/d\r\n0lcbrpGlTPRQH1UdWAp9686TeRrfHboeglKQ6C7eAiU0za3e3OTIIL93YWQS\r\n009Py9h8GqL3t9I2P4hk7CD656LWlOOKfpDDF/r6h2IF0DsQp5mYssrw5LtO\r\nqbBYSAKYJaM6FceLGPeIGHRnxJ2QnS/1UQ6pWSoWftp6BhjfKodOlDvhz9qv\r\nou9PZo1vlBeM4tdki4j5qHLYu+GfJ4C7z0RJG6vFV79zTsArvOuMQ8vvRlvr\r\n+Izei9GA8zRrqdhPagXgJhsMhuNy5U4p+o9JU6SBt3d8I7MC8jshd/6cEDRq\r\nOCeUrZeu7OpfoTtxCd7IPvCviz86xPclx0ahv5I16pTH20Quge6orOBTrPjV\r\n3u0wQcxHyzIShKNsm6MNbJngNCJd4M7I340ZAf9AVLElmrvwfH9r/OSXKIKv\r\nrb3ZVvyL+IqmoX1KAIjmNMlLutYWaq0Tmq/hmkgB5g0Ybu20+QOXE+7GzFYM\r\n9+4kfW97YivBCulLM7yJgvRhlfocvDWb5HC+fScNSLliAInL57VPqxkvjvv8\r\nq4u6HBs9MIinRefMVaSUfhhqschvHd4Jo+m5+rPOHsQHssqFhl09qdp3nLe4\r\notPwA6jsYkI1zyxuIBXoqiSUtygGzjlXVKU=\r\n=QT6z\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.11.2-051da161.0_1662555314890_0.13618319006899338"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.12.0":{"name":"ipfs-core-types","version":"0.12.0","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^2.1.3","@libp2p/interface-keychain":"^1.0.3","@libp2p/interface-peer-id":"^1.0.4","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^2.0.0","@multiformats/multiaddr":"^10.4.0","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^7.0.0","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^37.0.11"},"gitHead":"89aeaf8e25320276391653104981e37a73f29de9","_id":"ipfs-core-types@0.12.0","_nodeVersion":"16.17.0","_npmVersion":"lerna/5.5.0/node@v16.17.0+x64 (linux)","dist":{"integrity":"sha512-nHxlkMSPAA3VS7CxHbbyQlQpXLr/l57Q8Jmf7WZDLa5AN6p4cnJRUpnNh14QYIhUNJdcphPdI4LmuXXiX97cIw==","shasum":"3ae1b95638145e90bfb15ffd463e2098c44061c3","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.12.0.tgz","fileCount":133,"unpackedSize":200747,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDQ+7+m2nNpWLgbv+jIo7LHisqdwNgFgOSTh/1SLO5QjAiBRWQP4cID1GzXwW1SzJvxinKl8nfy9/qVwbauX3pUeVA=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjGJ6VACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmqhag//fo0056yirzG+yCvbUgtic64Y3ve4/Ok0qd4MaDcNy4pfFkQC\r\n+26hTgRaqhsL2Atbd0FzR1bBVy70sPfXC/fLewPRsCd5ZwpJj3wRypkX7VBo\r\niWrb/fnDUnYhAscEhn8KrBVP/h/VPUKEA0obYbdSq8o52f6bn5s2woDPbGHH\r\nvV7eJAK6FxR4x97IuHntIWwV1yOIEqfTqChGwc4N38uqWfih/oV+LWmu1K+J\r\n+8IMgFmNqi4RH6rZ91lERUKWN1BMmGgn1hvJNzMGHsraUgbdN7oSIc3Kzl4U\r\nf7efgnZz0hVuKot+iIjv/vJYXWHPBlhZaNGj9AkMJXLtsJjcTOe33g2cRMSV\r\nC9oHq1P5VgmIpTTPAmOIQGxg+ubzpQFyEBdw12oFHsFYt6DW3GWFWOM6P18V\r\nH5fhEH5tI/uG1gLcMwmmyBx2w0tlczpYrQuVl4ttYrNWa/pOm0wFnYiNmcxK\r\n2aP1VYL9cQnqjumGWXZTZkW1Ms1AXSenzoXQaX1s0hKuGDxgBU8A+p+uv1H4\r\n7BVpRmFy6JHJcgmdM9jv2mikX0jIogY1NcUoIhcFlrZMq41foWDGUx3dLczr\r\noOsiMU1ITIVph0Ahi4RUt3+Iv3oIgN1h3Zfep058uCkD+6hrylOQ1Uo4SQ4w\r\nNFDFgpE8mCHgnSbjH9l7PLAyBO/+7R1iMIA=\r\n=yfgJ\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.12.0_1662557845079_0.15959137418344538"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.12.1-b5456882.0":{"name":"ipfs-core-types","version":"0.12.1-b5456882.0","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^2.1.3","@libp2p/interface-keychain":"^1.0.3","@libp2p/interface-peer-id":"^1.0.4","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^2.0.0","@multiformats/multiaddr":"^10.4.0","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^7.0.0","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^37.0.11"},"gitHead":"bc139649f4cd3840696282fa6dc6b241b9ea1833","readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","_id":"ipfs-core-types@0.12.1-b5456882.0","_nodeVersion":"16.17.0","_npmVersion":"lerna/5.5.1/node@v16.17.0+x64 (linux)","dist":{"integrity":"sha512-Ke3uzNXP33+zfwB9haWNKC5p0Hszrz0pdol/J8El+eb+iKw2I788cbgeme3rutSr9wS54KxTVBilwPDDoRhCow==","shasum":"6b74faf830058f0c39076cd480297259b6aa918e","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.12.1-b5456882.0.tgz","fileCount":133,"unpackedSize":200758,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICSUHkYSZitY07z2yXlLALAi9QZZE4u7GTVq1xfOR7flAiEAlX0HCG8euGe7wMLg+yzMnUy8fza74YxrCz65VjRCxcI="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjJEC2ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpJfxAAjRUy11Cj9jlDs927QmuUuG6beLqVApuIgdeTx0Nv3sYrEVWe\r\nNwg/qiUZXmKBdYmIIjqt2nRfbcFSME5HEtYn5AT7dgACDhwjYnyHJs2RYyo2\r\nhIRNnE391VabWBR5hJFAeGnXFe5L1Mp+d0angs1ilacy451kLRcqoJ55RF6z\r\nwuV8XxskmxXcengAf8IUvuuCBclVGE5Q9c+AbxfuuxxhAovsuaMbl66/SRTR\r\ncOk9Lp2j54OFywGZm2bemwG14ErZ+Dz42iycELV6KpyQ0TN+x5UaV4SIvNP2\r\nQ/m42ucSFoiiYxKVFRmTzh1V7gJNofSp5wiBVFGGInM2hUkSj6xDUqdmBWRp\r\nUo4hVd1kUN2qBzc1mBdWuQ7RsUEFZPot7ReFZYmLTP+neXx1ZE2ekdJwLy4H\r\n9RToKoF2h+ecuqcG4sWO3FRQnZTRMfHhOjESCW2ILSBIEw5a9prBEMUwxdxD\r\n6FIHJCcOan4tnHuAv4wgJZtEa+Ocadrmt7xFXEvSifcRdf7f4Cib3vnAwdwE\r\nsvH8cq0awpdT+HlcBGCo9X45GCw21LeK4RgtnEKkpeeS3HA8on5axqnuF378\r\nGBJ1x331B2/27s0UfrjtAF0VWRKH6P7l9uS+3tCWvBzGwBxsa9Pv5fPyCB8v\r\npnbJ27lMp9khG+p+mW8Clr3IfSlVydFBuSM=\r\n=t/w1\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.12.1-b5456882.0_1663320246795_0.5616735605945116"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.12.1-7c676f63.0":{"name":"ipfs-core-types","version":"0.12.1-7c676f63.0","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^2.1.3","@libp2p/interface-keychain":"^1.0.3","@libp2p/interface-peer-id":"^1.0.4","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^2.0.0","@multiformats/multiaddr":"^11.0.0","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^7.0.0","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^37.0.11"},"gitHead":"90802df6c68ef286b155c31dc4f625a9f29ec7a7","readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","_id":"ipfs-core-types@0.12.1-7c676f63.0","_nodeVersion":"16.17.0","_npmVersion":"lerna/5.5.2/node@v16.17.0+x64 (linux)","dist":{"integrity":"sha512-+pxdM00jap/QFNh67ptifofHYib1D1k5+2qVgRcJewFU3lw0Da+wZVyA1AFJ4GaCBxLSmFBE48Zc0ynMrTx28w==","shasum":"138c81edd3857cc0f611f4fcffc47a9649c5380b","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.12.1-7c676f63.0.tgz","fileCount":133,"unpackedSize":200758,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC4nZeigCn7h1PtJQZIvKcca/fo5sD3UCwHaRZymL0RZwIhAMda7Zjg65CQE9JbQzB9g8k5KVfhl5yayoFm145xCHb0"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjK2MAACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoItA//TgDrMZjNXAQZ+ThlnjwiTLoebAESJqJkD7Ma0Vz94tun7n82\r\nB4pPgJGikDnrYisorF7Qo3655QFUnL5NqmnxHRUz0Kaa9HsERRMhZH+lsSkL\r\nJoIbLzluoqfaOxEy2Q74xVoe1FM5kneWaS7myVds7pTKG2ET5dzBwht8F/SQ\r\njdG07+wnvvRrozfe4k0QeY+w89isb3aATYWUcQDZ3aBlpqB1PSfPtvLH9CTU\r\nMc8ykkINaeUSsczPQafoaAQrlWqLA6A2/LQnq0i0X/WeA5FqZ6Tx6iwtvHkF\r\nMRCQdtzuX+p4k7PEhKrEND7S1JeZswBeepzcBNxdrov46I5uV7S0PlYUGc9G\r\nCQBX2HuK1eAcQjlbUqhjhp0yqXJRuMfXvcLAtgN1B1lgTiI894RSg2AtIdKf\r\nwer6awxzec4+ffKlVOjOtRKhENwxeqZbVNr8qia03jBRSWXuuVWyaqHZ8NKX\r\nknoIzG6iYpuDq/s8QtVS/Fz5J32zrYO3XMoMC3bKK3CUtFLbW9tr8fz3OW5Q\r\nDsrOtLS7/V4hsM1HrWLj+9AVfFPKoSHMkeM+5zw0SkXgk3aC4NGlrd5nPDC/\r\nmc5wMM0ueNL0PmRJnzQxB+WXURVKt2ipNAIz+2SKQiFVcs1uZuA0JUrixAsn\r\nG5/LpvtDtY79HfLHU6h9IeaIOJIO7nMDUgw=\r\n=+dgS\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.12.1-7c676f63.0_1663787775813_0.7503735767974493"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.12.1-2a830bf5.0":{"name":"ipfs-core-types","version":"0.12.1-2a830bf5.0","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^2.1.3","@libp2p/interface-keychain":"^1.0.3","@libp2p/interface-peer-id":"^1.0.4","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^2.0.0","@multiformats/multiaddr":"^11.0.0","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^7.0.0","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^37.0.11"},"gitHead":"ec3e046a48458e999e557f7adea92e304bd7b0e8","readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","_id":"ipfs-core-types@0.12.1-2a830bf5.0","_nodeVersion":"16.17.0","_npmVersion":"lerna/5.5.2/node@v16.17.0+x64 (linux)","dist":{"integrity":"sha512-WrngGg+a9em3IjXd9hxknZz9nBKTWnnJarfuJbgIEC0SBOatHIlioZ2POY3w9hrFApSyVwfveWjJs7UPwr0Xdg==","shasum":"9149176bfd5d9499f3ab9513e86e4ac7db6aacb5","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.12.1-2a830bf5.0.tgz","fileCount":133,"unpackedSize":200758,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIExVdWTUvEUSTLdV9Vb6MR96QJkPbimlDA809jNWAjv+AiEAj4NFmmnw40q4cR40CNg04n+OJ8C7KgGmiAjCvnItqLg="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjK3niACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmofOw/+IKwMrR5HgLDyA7Kr0tuVAywP5gNHttunlO4Irl1yjSikv09r\r\nMWhk4UtADGYMf8XHGuc1n03WJHMRT0PXTn79ZQkwsA9WnycJJdBmgugc+MQQ\r\nm4Wnd6dt6a1KiB5YDrxB/6ih8dZRPXNgeVH8rtxw7oI1Tm3VcCNWUuCmfxrv\r\no3DaNEsqHE4r/1tXmVEah/XPXMil2XMFL2J5srLSGGLUR/nk5ZlsbhAsquDi\r\nhmTe4ztxx3JfpwZXjRa0N2gDzkcWTYPavqh/kD2IkbqepqC11Oh7jayJVU7d\r\nxE56EXwHD4F28i+tT6Eo6b+j7pIlFzS37DwUnPk785ASgqUfJ8uwxkIeR/KM\r\nu6tLL+Ls8ElN0Mb1hhXgSzizhNxWUIKkX6wgcme4h3mOrpkgG3J0HD8eGKhO\r\niWBXxKynwBPuqymSqRSkO6xqzDIDrPcvVSUnbeLoRXxLaRQXw9elLODb/T6w\r\nG2fk8TuoiQD/E3X42YG+69mfdHq433xRSZ41LDEdysQKuEpu5dQcZvxnriiH\r\nnJxcAF0LcxQKsphj52VG6iaufkFU/bG1DpGxT+IR8AKxUwhuYBlXMxqBJDqF\r\nrNx/lcYHz19VUZzF+C7VdJdjqk33unTg6EvgULPdUVN95nRjDN5+ZDcKT9kw\r\nTtwQWuAl8xv/fIEsBo3omrmuZ18o0qbGBrE=\r\n=s8hw\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.12.1-2a830bf5.0_1663793634247_0.06405547794371347"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.12.1-7304a0f4.0":{"name":"ipfs-core-types","version":"0.12.1-7304a0f4.0","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^2.1.3","@libp2p/interface-keychain":"^1.0.3","@libp2p/interface-peer-id":"^1.0.4","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^2.0.0","@multiformats/multiaddr":"^11.0.0","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^7.0.0","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^37.0.11"},"gitHead":"95735ef611dd7b897d3d939e512b6229757532f3","readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","_id":"ipfs-core-types@0.12.1-7304a0f4.0","_nodeVersion":"16.17.0","_npmVersion":"lerna/5.5.2/node@v16.17.0+x64 (linux)","dist":{"integrity":"sha512-tyid/R+pGgpkfD9vIpGeedwPokc3cAb3h533FXDgLE0lSX+DQzFNw5fKSSts5SlIq+cs9tv0dm3omt9sEuYT7Q==","shasum":"04672b34ccd49368201fe58411ea70f42a3486bd","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.12.1-7304a0f4.0.tgz","fileCount":133,"unpackedSize":200758,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDMLD1QTR+MTt6X8KbNQ4XOVamPM909GSAFbMXo0BfO/QIhAKYizZUovEpZ9B6jhSKzMMplXju6OVOuUdSSLfLLAFnC"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjK3oOACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmp/oQ//WWtUTtCYshI7LKnJrhZh1+j5znJV2YpJ2TNpaR+cf7emx6/n\r\nMCEBBQZUqhFZQkZIExNOkRk7IUREiTMsBxboXkf9l1XDVw0QopoS24Fd/Qjz\r\nhcn91ZYP3noOZbmCvQ+N3UlBdSb/oHmfa1P59XmGatV9vfaQ4BD3srK5npHd\r\n55WS+nO3yzrLOBgGUMt7W4EMnk0P5yJkoSDRlP5oTvd+1RFYqELLNMtYvR2o\r\nVXsuPUZDKJ3zCfJqAwBF5eR980e2tsP69KNAvsNKOkznLHfiMZj0B4bvyx9o\r\nySvEmkmkg7Y51lhfiUsSLmE0jG2q4eAWBa0azJTwpEsFv6b98gKz2lklX8td\r\nyzDmYKxysx3XF9EwUE5JPWUCPK/X3tUBjGBKPcJr+EWIv+E6mJXiiV3G87f/\r\ndatGHWKcc3IH5yPNYHyDz3CKxXk3SirVm00Sgl/KUGFGnHijNANDQDhxeQia\r\nZca59UjSfxJV8uXYVoQtRYJ7SJ5Bn5NHorC8Xv+A9XZPdr4231AHkmvicUzE\r\nUXv9U1dND1Wg/KgRK8TRgwix2yxPBD5I1VHM4z5V8g59PTSAX5EuP05oVDPX\r\nZukOA2tsfTauMf6u1cVUw0tgMTAuOzk9xj3wfGTV4uxKLqn2Ms1GoiE6qqa/\r\ngfJar+j4uMU0UmWqveLDHI6dvUkKCkdFvyg=\r\n=O3tC\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.12.1-7304a0f4.0_1663793677841_0.4982444192206459"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.12.1":{"name":"ipfs-core-types","version":"0.12.1","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^2.1.3","@libp2p/interface-keychain":"^1.0.3","@libp2p/interface-peer-id":"^1.0.4","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^2.0.0","@multiformats/multiaddr":"^11.0.0","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^7.0.0","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^37.0.11"},"gitHead":"d1f1e75b2060c5c2e64d133a7a6bbabd2641e5ef","_id":"ipfs-core-types@0.12.1","_nodeVersion":"16.17.0","_npmVersion":"lerna/5.5.2/node@v16.17.0+x64 (linux)","dist":{"integrity":"sha512-MMCNlHN960kZ4Pxh85xmAGPzVkO2iVAdPQqHkxf/3179m6MwrMpaBdU8QGbjccRef4QKou2bIptKdweanvjmig==","shasum":"7342adb5553d7f66ad7cc6f326e32fd40a701d29","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.12.1.tgz","fileCount":133,"unpackedSize":200747,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFEi8rH1IOZBsYp+BJghEtGTzoE8CGHf6CxuCFZXKb2rAiEA601qL8I3Pq+se0W7kbqdg5AJxs8tpwiHVl8Txv0YQWI="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjK4gqACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmo9cRAAk2Z4kj2EO2VMfpxirDGzrg4Li6DuKLZ4NjtDERCknAmKSBS5\r\n/PAkB9kg+oxZVPh1EPNKtNOvLGMtlVc2MDJOcLSFouk7skbVCnHYwELXnm9E\r\nNIcYxb4MPrZ1/E5sIXKsuG/XQMdE5q5o1HoVtBalvsTvW1d7A05OSa97+A6G\r\nqGPQNVrjqWbA5SihYYQg908DchZNHFrISvZYmjoPkOJkMBrFBsHsKyV7kAGD\r\nrDKzJZ42b0hC8oXBz1BMWjbsH3InF0tJ7a6QbT/SvoDhjhw2EBL53cM4zDMD\r\n4zRI4hgkid0pO9ny7rKNrt6JE9IX/8JV8fZr8Sug+hq1mMI8BwebVQJuaonm\r\no98e4SuSuq/qalmDpjiVoHkdtm488RLuxdLLU844Z3NhWBzjZ8IdfW88f4qg\r\nOs1nwCuLXtOzKvzoMd/2J4UvQKn7ZRQn+1rtNmXFzILn2nrTgP8fOpPO/awR\r\nhxVERsMTe2zZGfspmju7XRnmm7bucOwAGwa/UcDpez4l3lFU77TBnLeifI1p\r\nhEDLiAfjfY1UjQ2B44AzwrIp9bku5ua0jwhgfowkMgrKOH2mb99xm4nuGekn\r\n5Sy/juIcmmnlm4Ap/ih5RHpQ2XB23kQF+6b6BSXd0bQ0j52OL1wUhuV0lTPd\r\nvdWpvwmyvZxXypAkIwGSCCtBL5R7eHNSkyo=\r\n=b2xt\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.12.1_1663797289951_0.09492307055219285"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.12.2-d75e0a39.0":{"name":"ipfs-core-types","version":"0.12.2-d75e0a39.0","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^2.1.3","@libp2p/interface-keychain":"^1.0.3","@libp2p/interface-peer-id":"^1.0.4","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^2.0.0","@multiformats/multiaddr":"^11.0.0","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^7.0.0","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^37.0.11"},"gitHead":"4233393ebc1f8526290235c1b52f4d459ff96e1b","readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","_id":"ipfs-core-types@0.12.2-d75e0a39.0","_nodeVersion":"16.17.0","_npmVersion":"lerna/5.5.2/node@v16.17.0+x64 (linux)","dist":{"integrity":"sha512-6DVtgvWE9VBZkFP641T3p3wNKPL8K40dugOV+tUFFL4MRbl/GCkDreftfHlq2UOjn7qUQCXaVCRUdvu2g7Oy7g==","shasum":"02d31d709e8255fd699a9847b4793c1115e0e47e","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.12.2-d75e0a39.0.tgz","fileCount":133,"unpackedSize":200758,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCUle6O8QMR+VRo7lYTJtkoRFhwvWB9rXnyOWQiL7TzdAIgWgj1TcVqEFMZSsxXQqhhWruo4773vpYZceG3rd+iJSM="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjLCIyACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmosLQ/+J4as3t45bJSNzkbOMRczRI6aovj8lfCRDJY3v3WK1SBYFiXq\r\nimaEcgS9lSWwWz37Nb9KL8vVugmC8SY2pEhJTnH+/Tz15Ks1eQ/H15Ua6Nme\r\nYdp7BNuJZFt6qfQCs71WB8OtrAkfWnOWsnFTo/aQusDukDgKCLSIPovFLslS\r\nCVQSuu3AwThCIm6hGTstIiVc8OCqaWNm+oA+uduPYNf9xZVbBjdHuGu+fNof\r\nveXjpIDg9AIzn5MgIj2sQ2GfFisXJftfBLxsB0oOLUkv2vKFUrMPF2hiQLMs\r\nZfBDIXLjTsiYkDoN+amzsJsd3TBuyUiPpVj4pWNM19cjwJusmpddEbuvE8Ib\r\n+z6iYl5N5yyMhBuL8Ckzq8adMJtMaevGr0cPc1bz4GLttaHOh/MX6dL749dR\r\n7uK9mplKNl9yrtmJC5mAPhjuXjg6Q0PdyQJtagJg/c2dqyfuj4PcUZjVWLbc\r\nQKs/gBj0BYfYSzP6RWT6IDYHk9utI1ZmpvxSUskL7i1Qd2w4kwCnFijHTx3c\r\n6B2yy7hY6fQHRQl+Ja7yF+L3kOhOe+kIPa70Xn7BU901zCk/LsPFbMsBUeV4\r\nlI9Aqsi2FSa10yvWQTK8P8PmPvESe/PpnSGucmZSVXZ5RBoY92MPOciiigsj\r\nw17Wi5+feS02x4Bfbda7JiZj4Ge4ZmxxK+I=\r\n=3XwQ\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.12.2-d75e0a39.0_1663836721802_0.8285697440853186"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.12.2-d1b0a8a7.0":{"name":"ipfs-core-types","version":"0.12.2-d1b0a8a7.0","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^2.1.3","@libp2p/interface-keychain":"^1.0.3","@libp2p/interface-peer-id":"^1.0.4","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^2.0.0","@multiformats/multiaddr":"^11.0.0","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^7.0.0","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^37.0.11"},"gitHead":"de2a2b2cb3fb26e858af2319c63296a1ca411c25","readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","_id":"ipfs-core-types@0.12.2-d1b0a8a7.0","_nodeVersion":"16.17.0","_npmVersion":"lerna/5.5.2/node@v16.17.0+x64 (linux)","dist":{"integrity":"sha512-p0ga1UPFxD4iQltwHYc0gw2meMSyPl+iCSoxwa63nL7q2hJZjOWhoC0ET6ts9rNcuDzkHuYEB+NGMBnWFlP55g==","shasum":"a3bf58ab268a6bf2826c0c2461c99ccac7d02a9a","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.12.2-d1b0a8a7.0.tgz","fileCount":133,"unpackedSize":200758,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFWdti0zqSgIpRuD0oVWrYwp2nYv8vJbtio8wX1nsLuIAiBBo+YbneIpHRixq9uLvW2GhIV5n7UetvwZVIMSiR9vUA=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjLDvhACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmr7qhAAmjKxZMZhcflS/cJZ67p2mQCNZu8RrubzFgN9BYeqQ4NqVmjE\r\nmf1S7NbP+II9XaqhB0ZyGdfDCh5cTy8Dut2/hyiEpSdrpPLun/AM0lnrp9Ov\r\nsgUSohDLPWjZzyKZynzKaN0WpNXtjBkFPPTLM6gZRHPWVrMb9ZvvD1Mm6au2\r\nH6x4yN39IZPBDislvzEzNTrI+LtmdXY3wbdYOnm0Xhu5VfMNIWMYAC16eTqQ\r\nh8OgZDI0DxAFqPuUSQ0xA33gyA4x9I301/5VjWtaG6khQ64htutdjyzEQmgF\r\ntC+NsvTtjD8GnBzH8wjMNi5JuW5mzOSzbH2DPoGb+fJ8TjqXa/NaTazb6mzv\r\nQoOrYWqw3giTG9JA9HoDOQNh9fXX7KHL8f8BlaugldCvARzHe3UIaGweydSh\r\nbYNyNBP1XPCphz9V4tV4cDjxTFFha1/55OUaE3Lw9q3EyYBj7ho17h4ZRpcb\r\nTsOSPwl0WG/KBN0O9DtjeOlO6LS2FNCzY/jo/ne1GvxRZThhEHp2DWj9cy37\r\nbRq8+dzor4WxqYGvD0grRPmFLC0/PrjllfzIKRl4GueW6gx4oykzxeP1DpJO\r\nHGus+zEby4n7YlCSQmjijwr6ZadcpAN9b269XExg/Ikj37H1MqEmHdlNoQ45\r\nGNT0LsEGLyZHB9hlWyO3mLqsR4KC3M7ytRE=\r\n=EjO+\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.12.2-d1b0a8a7.0_1663843297599_0.26524771918861245"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.12.2-acbc1c62.0":{"name":"ipfs-core-types","version":"0.12.2-acbc1c62.0","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^2.1.3","@libp2p/interface-keychain":"^1.0.3","@libp2p/interface-peer-id":"^1.0.4","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^2.0.0","@multiformats/multiaddr":"^11.0.0","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^7.0.0","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^37.0.11"},"gitHead":"60666473159284a7bf9067d10436033caafeef5c","readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","_id":"ipfs-core-types@0.12.2-acbc1c62.0","_nodeVersion":"16.17.0","_npmVersion":"lerna/5.5.2/node@v16.17.0+x64 (linux)","dist":{"integrity":"sha512-pooOUpT1GKrDhjWMhF+9d2CBVHz6dc7QDRTBzjwwAw/SKdJ3XNJXj91YP3YLo33HETVsT/W0oUplFslg8Zzyvw==","shasum":"f275d6c62d9ea0542382431ac12995ec32d7f717","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.12.2-acbc1c62.0.tgz","fileCount":133,"unpackedSize":200758,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIA31kaKMN+w9reRhrUuwYHVzrjzY3XTI2gEbG9A6vQhAAiEAm98Q6TqENwfsi/K7qDuvc0iQOxB+jVIY9QneNpjfGs8="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjLFxBACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmoxyg//d78icjpKJL0yy/ywoyol2+O5Zy9nCkFW79hs6dIqUUjHBVOR\r\nQKUFC43w77LUUcrFwJzctEeZ1/AbbLVq6YiBwR1H4yeKgObwZnkT+zVwGigk\r\nw+7frLe1XlV/Jyng1nZgd8qKXVT/SBovrii5fk+HF4G2DVHJgSAO+GQs1CtQ\r\nEWovLGlwDv9//k/v0bHW27egdbGul/DnWlnBZhktkZlGCNVR6JQAN+G9lT7S\r\nCSpQ6rJOAnHZ7G9uu6tuKzfGSQ1AypvwtN+tkCbJwW/e7oEdjG2g6kL6ctW3\r\nIOwppuFeGHBxyEyQYSINCGVFHvppy95vZycUyuuGS37zkoGnsI0FkYnHFxyM\r\nho5FmYMkTRCem4AmA0+V2fPcMWzzoTrMZh4s8ogCL+21frGoPG9iT0x2zGrG\r\nr9sefaoBL7mFk0VdlW3L8+8Yvb8oHDvgyDC4VvrFbKsXAqD9ZPEzcWIWCmmJ\r\nS2pmRz/DRL3XW6IhK6EWaj/ehBgabNZ4MXTDzIYsBMhu7e0S+rxtu/CZj3Us\r\nxUMkd5k+zOZkXL4FfxaSuIkCIB7gsF5L2//8P5MKuJY08WQZvSdhNTwp3Fon\r\n/iItH+TNbwFfVchDiQTJhH43SoqEZt3SUnmCav+Jgtyb7ePmd5BB7tnRdyuu\r\neY+teMVNv3SaX9TEkeiWi29JdptRNljn4dk=\r\n=VMJA\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.12.2-acbc1c62.0_1663851585266_0.350104328734961"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.12.2-dfc43d4e.0":{"name":"ipfs-core-types","version":"0.12.2-dfc43d4e.0","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^2.1.3","@libp2p/interface-keychain":"^1.0.3","@libp2p/interface-peer-id":"^1.0.4","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^2.0.0","@multiformats/multiaddr":"^11.0.0","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^7.0.0","multiformats":"^9.5.1"},"devDependencies":{"aegir":"^37.0.11"},"gitHead":"4eac92ae987d3ba6007c4742456913c865a06857","readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","_id":"ipfs-core-types@0.12.2-dfc43d4e.0","_nodeVersion":"16.17.0","_npmVersion":"lerna/5.5.2/node@v16.17.0+x64 (linux)","dist":{"integrity":"sha512-ahnkKo2xEfneRbxLmue7Nk4SV9ODW3A76CEw8FIUa/t/GIfVNzMyvBu1bU8ayOv07l0+G93pd7gkjTHek35GCQ==","shasum":"1eb039053e4d2847da9d1ab366b9c1ba56ebf86e","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.12.2-dfc43d4e.0.tgz","fileCount":133,"unpackedSize":200758,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDH1rgrJ0juTsSG3L2IPF91y/GBTCkbAXL/EBbqWudOtQIgNt3kaOQcPpjWMkxLXXqj9om2nzhx7vM5Q5ctfbnO1Lk="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjMbUbACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmphlxAAi3oz2N9JsdTN0EnMlLHcGzfcshgnGB+X0VvbKw1Pz3u6EaLF\r\nGmOHd31s4xBi4Osp2RscfUodFzj0IfWxbQ5jXGVDgAOpD/H7xBXTlO94QYbe\r\nm4Q10MXi6o8+6qserVvQgIVAX5163VxZZ2rkwETNSigXuAAILAr3Gqf4DuzC\r\n7rmU1+wRNx5uCZDhq+bcTgvgy7iGeoyhYgW7PeOtMo6ohaDnn26qc4SSqNBX\r\nZgDz8Nv02hcYJ6U7MwRWIVyASN6tRxcf2kErpaR0EJk7JNq3trvWXVMPYnJp\r\nBr5jOo+xFRLjwjnAE6lxNxHuZxRvnHQQh2yMOUmIhmusu/LiE+w+VQXlI/mh\r\nGz8Ee6z0U7ssmx2DSG9Hnc3efUy1rF+tIyGpmfgH0jBBsyqYKmwEDf3U6AZh\r\nu48+aSZUvP+EF5OPf7JqKQc4sFanU1nH8g2Bu8+wpLkPw6ThbFe6CfObVFzq\r\nNWn29IzmfKPgMLdGGf1AIjzsBdAoD9tS+MlDMU3lM4x3VE/fzEv9Azl/6hYE\r\nNY0g22dxBVwdlJa+UO1o77uMyy+A6llzbkFkUYACSVBSr2DLbAqWeAs+xpmB\r\nSWvijnMUSs0/nE14pzEtlQWpsE32drb2QOfJzDrVXavtq+0vHgpBULIiQI3D\r\nJKsJ7oyx45BGabS1l/VBKVJsq312YIbpXns=\r\n=DyTp\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.12.2-dfc43d4e.0_1664202011402_0.30567860580260264"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.12.2-0cee4a4c.0":{"name":"ipfs-core-types","version":"0.12.2-0cee4a4c.0","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^3.0.0","@libp2p/interface-keychain":"^1.0.3","@libp2p/interface-peer-id":"^1.0.4","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^3.0.0","@multiformats/multiaddr":"^11.0.0","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^8.0.0","multiformats":"^10.0.0"},"devDependencies":{"aegir":"^37.0.11"},"gitHead":"b44ea59fdb45d3e8532d6a2d5f670e2df46d36ef","readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","_id":"ipfs-core-types@0.12.2-0cee4a4c.0","_nodeVersion":"16.17.1","_npmVersion":"lerna/6.0.1/node@v16.17.1+x64 (linux)","dist":{"integrity":"sha512-GHbAia2MXYEa1OFqRuZrCWgmRPMjqNNC7d8nYysS/7CFpy6XGCNJvqagf/wtzraBvsfhTc11IXsqtDOBU9HBEw==","shasum":"18994608ea0b7ab8565e2419a9c4a62bb862bdca","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.12.2-0cee4a4c.0.tgz","fileCount":133,"unpackedSize":200887,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDOz2RpldeZomLMCGzYg7e6QcXW4McvWlLMdAROaQavcwIgcDIb0mQ+wGZBC2Anenv2gq28HmnNygQWMQ8t2iaFsFU="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjVlctACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpwSg//fG6+uVH7qIC4I6PdClK62zBiM2Pz+Z2fj/jzRMWsQm7mDifW\r\n5ENVDx+0Qk9oZB+SZnDExj8LxqkvfJjMl+jVCQBbZz93EUgov45de2c0H77H\r\nqTku+MAleqL6rSK4vC7I1oSvqhgn3xNjw2Rq7iFYJf4BknYCyCdpTPLIzsCB\r\nCJxVmX37R0l6PbrrZrjYjSZmi8ro9GCZnOf0ZkpMzRd04zWWBrF6pp83nk65\r\nO5T2e+E44oWxpsge5QKuH1cVUo38zXxSTZ96t2DSjLrUTETL6KYy+BIPgH7b\r\nwwSwBHZQoOoBZd43B3JTSGq9gS846cCd8XVKUQoHqXCdmMuaNoYOzJUaN51l\r\ncoBh20OSBW1AqCOoGuZfqOb+gT0KSYeJ1ClRJJJRxHgisGcN48WLfJtLJIrt\r\n4Y2PCL+9eg6dTQHeo7Ustpsa/KJiUouhaMcsElyvWOUNNj9S7/dtVvvYGuAO\r\n5af/H5mwUM9JlN5reHeQkhMRzaEb3b+QYwwN+O0hvFJggAIuREO70JkJkv9G\r\nU4opu2Td89nCv40cZpibPPU+B4YMw+WMsK+8haNz/4mDla2hWRcbar8Q/P/Q\r\nVTANuZPuCSD+jcpLQfpvylHpUt3UshD56KymKoRrLYExTHZovD9AiNHLzCs1\r\nhB1caf0j6JK7wPSysNcRMGjise5yJyMn8Cg=\r\n=GSOW\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.12.2-0cee4a4c.0_1666602797378_0.5043564781661174"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.13.0":{"name":"ipfs-core-types","version":"0.13.0","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^3.0.0","@libp2p/interface-keychain":"^1.0.3","@libp2p/interface-peer-id":"^1.0.4","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^3.0.0","@multiformats/multiaddr":"^11.0.0","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^8.0.0","multiformats":"^10.0.0"},"devDependencies":{"aegir":"^37.0.11"},"gitHead":"e8b7b66bfa98c2a1c0d0bfc19f698d7d00b6c888","_id":"ipfs-core-types@0.13.0","_nodeVersion":"16.17.1","_npmVersion":"lerna/6.0.1/node@v16.17.1+x64 (linux)","dist":{"integrity":"sha512-IIKS9v2D5KIqReZMbyuCStI4FRyIbRA9nD3fji1KgKJPiic1N3iGe2jL4hy4Y3FQ30VbheWJ9jAROwMyvqxYNA==","shasum":"eb2f27df7b91940e39b201b08affc9a65f63f503","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.13.0.tgz","fileCount":133,"unpackedSize":200876,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBnoBlHy1gktGc8RPNscbZLz4zxaUxQ6KQx8Ou+spQUsAiA33LiyD9jIct6dSrSLCVCMjumK7ioPokEejW4jg1tSuw=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjVm04ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrF3A//ctG159Am8eh9/MtqoU/whDu9XB/AnxAczIygLIIPJa3/1M8S\r\nZCpdmxN6obkv0XQZD2ZHqZMtA6xWi97aV7yek/eWXQOGVHLjrcneCcRKb7Do\r\nnqsgnKG5sOlPyatDsMsW7qogEFew+IDdB7KnhaFAyFge7tcDMSyD33eLqq/i\r\nyJ/goavB2xh1KkoCrmkrcyTinU/XIlm+rYXM9f9ewf2IEfu7+yCcOLv6MBC9\r\nP4SzAs/wNrtfRwiVA7hLBqd9Ys6UwCVUVQOkXJlehP+yPYdxBWlz7wv8xW4A\r\nN4UJ2qW+zZZXisyCLAH9PXG+5oskhvEEzPw2ATLZ9RRDJigRe12s8mAp2t7Y\r\nAgH72qg8aXv45Lk1WbUzjc+WX2Qz0VxkN/qYTj6vjQV1RkgO3HNU+E4W0jhs\r\nw9CpsbzGniJKvTe6HAMvrsgNz3TrAQwI4k5dCfW0zZJoM3JD03a+sbfNet8g\r\n+FqVY4OzSWocrInSpCeBsf379nO0NoCPwNUTOFOhAxhFq+yTIVRI1qmWt8wy\r\n48ZLCH0QyzDxkfNMTd6a+4wfOFA7tLNlGfd31wVrTkMX6VW/T1CszUbELZc/\r\nIMFb6zetLda8p+keEcbNEj0oUcKAR42wAoff6t7qS89q0o7rFp2BExR9u0S1\r\nuoSBVVo/z4vlcOuplurX64LqFdMR3HWkBAo=\r\n=Hb0u\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.13.0_1666608440172_0.5380152414862782"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.13.1-a77e40cc.0":{"name":"ipfs-core-types","version":"0.13.1-a77e40cc.0","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^3.0.0","@libp2p/interface-keychain":"^1.0.3","@libp2p/interface-peer-id":"^1.0.4","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^3.0.0","@multiformats/multiaddr":"^11.0.0","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^8.0.0","multiformats":"^10.0.0"},"devDependencies":{"aegir":"^37.0.11"},"gitHead":"a614528c55b8b22866bbdd2ffcde2e38eb5f578f","readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","_id":"ipfs-core-types@0.13.1-a77e40cc.0","_nodeVersion":"16.17.1","_npmVersion":"lerna/6.0.1/node@v16.17.1+x64 (linux)","dist":{"integrity":"sha512-pHbLMYmzenn7mWcXs/83p6Hiy0MFHY7naUX9pu0CELYL1OF6n4TTHl1QIyfrcYpr6hw5QpilwsQfGgU1OMtlMw==","shasum":"5ac3a0a97fcb0e2928c85969215dd52541355141","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.13.1-a77e40cc.0.tgz","fileCount":133,"unpackedSize":200887,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBA/Pd6HfWcR6o0oDPLfeQzO25Xbs1mKxSPlRMV+1hF2AiEArJI4V+wvLkcETTxB9rZsPl+Ac+9KfL8yWH+T3BKHdRk="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjV4wTACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpoERAAggze88QdVXmZYhnc9s6h3eyhrNpnmXC2c+yPYF5cHd7pAwW6\r\nE64edkK+SGSRyLhBcYsPY5DJuQuo3dXLWU891BiIQxAB8Lj+zUgZmOf7QsuT\r\n5ZK/72qEya2zCPkS+2j1D57pRJKbZY7t80CM4OKbJm2fT8K1djd140Vw8E2f\r\nptpumfdhHDP7es7wprFfA6yXqXH50u/tRhpw/FpBaXgUIcmm8ubHX3fPGP5U\r\n4tzvRf6td3B0KeyfQv1CnjOOEz3PVASMMwodzGO2pRW+bPHZDQR8eD+pFNdY\r\nQPlcP7bFrFtPGatOu/Jh5Z6rWEo3+owMLCOWBBKU7y1A++zblJ3aSWlqEW5P\r\nHHDGSmwBVcUZpGE5Btb3GX5FNJfXij0wFU5EjdsoFmrpftwKdVN/Lv8wmEaL\r\n0Itr+BIllbMJ0wxisML5sAKeBPSkZd8T1+6AUw8N8a5Qcrk8xPPKkzPfeCle\r\nubZU+Co9i47e+whDlRXZxGb/3SUY4CBw+35wh262JjDPjVJeV0Gd1Gvwec9O\r\n6kCYXTeFnEYmRoP41rkcsRH0Or7iDBnGlgiDjHC5H5BrMIov72a+gOtHTmaL\r\nF170m8lHwcdCADVnY2TRtPeiDhP9Yn/VKyxmLrdnjZE0+BrzUUYXZcyHM7D0\r\nsNhrdWieKK7/d/aC0tHuYOyGbS2Y3EhPrLY=\r\n=g3Cl\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.13.1-a77e40cc.0_1666681874918_0.03215113894102939"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.13.1-58e6f468.0":{"name":"ipfs-core-types","version":"0.13.1-58e6f468.0","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^3.0.0","@libp2p/interface-keychain":"^1.0.3","@libp2p/interface-peer-id":"^1.0.4","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^3.0.0","@multiformats/multiaddr":"^11.0.0","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^8.0.0","multiformats":"^10.0.0"},"devDependencies":{"aegir":"^37.0.11"},"gitHead":"2a13d94cabf2e6ca2f631dc9686f03de6aa42447","readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","_id":"ipfs-core-types@0.13.1-58e6f468.0","_nodeVersion":"16.17.1","_npmVersion":"lerna/6.0.1/node@v16.17.1+x64 (linux)","dist":{"integrity":"sha512-bNE6uNIt3YQH4/g7FAW5bkPNTyvVH55VdLYHNUeFVouo1LohJaa2WLJk1kH9AHNgPmMUtSf9IcN9oIWnf/KoLA==","shasum":"4ad84885fbd99372a0e4ef711afa67e63cca5620","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.13.1-58e6f468.0.tgz","fileCount":133,"unpackedSize":200887,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD/ZGNT5knjbLslfh7BiPiIcqziACxYnx4J9Vgfzyi37QIgY877RqpmWeEyb7vKGJuXhAh0o3GsXQSvLeRC4fOXZyI="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjV5slACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoN0A//cpKsDte8cCQDm+UnFJrGr3DS2BEKIjS66M7VCqP7BPGZ1R5w\r\neQjwmZATGL3f/5G9JUmf+wyoiCQ1ce24hp7Nz+jOsRtENBiOBsTzLdpKU58x\r\nnp3fMJ2WZqATJBr+CndiNZnIMyXwmMhwbPf7+LljJb8Bx0oM8qTaKiVTFF2J\r\nkDtjb3xQjsmF8k9Qn6d+9/ZLz6HMqnfbO9UKiruGF7eUjKJ5XVvGFV1U5pEb\r\ng2w/W3FKrB4UHJkM9WS9CKz13PJbOMoWVmMwBnxpoZ/hsrRFX7p/ZZkbMjf9\r\n+V6Lv89DviZqi79WH1Ac7ubiRJULNTMsnpvX0moJxSJ/itBCs9QRwNCXbRCF\r\n9aG//zFIeoA7h1vvqdOh0qR8GC3TippL+mFvasTZuBlqeXKUVb6npxVvFExV\r\nbuZnOERMO9v94ETsMBJynbAdjkUNAVjLOqj9M/Bvnc2Sgt6+aSHQ99EI21Ns\r\nUvwQDvWWalyDPBXM0eTWAWV6NYnGPLtlvJCsYJzuMF8vmc61gcctQ3q9xbhh\r\nmHTYN/jGOkipleldmBN5Hw23hF2s6qtQXbOuaUTvoK7mrDCLMdsW7OWHMWjp\r\nlsL8RfgmMzrKSLXl0Nfc+vJ0N5ZK6z3dwtF58iT2h/Mvr1B3qQg3t4YjW1lG\r\n5r8a2XdZvTA+rcpiXvZqHAYpgYwFr2Ov/zI=\r\n=eb7M\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.13.1-58e6f468.0_1666685732904_0.990895305597776"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.13.1-6ae5eb7d.0":{"name":"ipfs-core-types","version":"0.13.1-6ae5eb7d.0","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^3.0.0","@libp2p/interface-keychain":"^1.0.3","@libp2p/interface-peer-id":"^1.0.4","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^3.0.0","@multiformats/multiaddr":"^11.0.0","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^8.0.0","multiformats":"^10.0.0"},"devDependencies":{"aegir":"^37.0.11"},"gitHead":"848f64d53ffe001cdf63310c06e8f0ffe485278f","readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","_id":"ipfs-core-types@0.13.1-6ae5eb7d.0","_nodeVersion":"18.12.0","_npmVersion":"lerna/6.0.1/node@v18.12.0+x64 (linux)","dist":{"integrity":"sha512-dBBaWmTYJHw1GN7vYzATo46q9HADz4dxfoq1KKxn14PaR+Ztlt+Gb1FqiNIISg2JjWUJWb9FNBD6eEHOvxXHww==","shasum":"0e29a0a32bff3332c59359575d0e08f595c9cfc7","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.13.1-6ae5eb7d.0.tgz","fileCount":133,"unpackedSize":200887,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCuXScaY4F/NcwW5bbQZHwUCPdHVIs9Vfz9nMB6gFsQFAIhANMdnX/AskaQagNpfp6XNWwNSFtanrm8pAYBMKHQeSgC"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjW4TlACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoutQ//QK8qfwwjLNQWq4eb5OUXHWBeiDZQBWjWRP6SY0CWA0wjREsW\r\nC0zG/cNsNddYgBSro6Z7JJGwYeK74O6lupYzJHozaERrYKRKWIvm42f32+F4\r\nIDlbXe0zaKA9rlv4awuF6bxlTLiy5czNs176fDQ5mcdqzjK/NxpM8Q0j3DGR\r\nJcASeera/xpDOnKsPfyOz0oZ108qVVohj1T8mVclY3jt+EZIb/FGuDjE5oKI\r\nJWlLb6q3guwvhfnzocTbDjre9vPQStaVZZK0hpqvMxWYZXUSundgoEkqmN3j\r\nUDLeHg15Mf9LVsAmjJODLCrgUqMHJ/FKhS/H6JffKvvxzhjGneOVnl/A42Dt\r\nMUADcrSPgF7orH7P5K+Cf99nM1We/Yn16G0w1x1ACO9SyOp7O+Rm41zMV1yc\r\nRn+CNBO+xVbkMf/dgBKJUsNYD3qDnBODQeT61ScLjy3on/aUrlkEm/AV8hB2\r\nQIyxAcSm2R/kbYxG37shIE4X8DR3r8llbJbdSXSm1TXV1BC2K3LXpuRsr+Dr\r\nbvXaJGBhX6gzRRCPoHKZKGwNnD/LQvlWwUgWF9TPzVXUbR1sxcjH6b6tdR8W\r\nuEpe8qlSqLoxui1e29kPBJwdt0oZJy8jN1LqThDCK7ZcYZ9WRl9rHoYR4MqU\r\n0Q2ryTbjPeNG5kA0pFkMoDopdMBy77jbF7k=\r\n=EVLq\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.13.1-6ae5eb7d.0_1666942181576_0.9203918239335109"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.13.1-6be59068.0":{"name":"ipfs-core-types","version":"0.13.1-6be59068.0","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^3.0.0","@libp2p/interface-keychain":"^1.0.3","@libp2p/interface-peer-id":"^1.0.4","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^3.0.0","@multiformats/multiaddr":"^11.0.0","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^8.0.0","multiformats":"^10.0.0"},"devDependencies":{"aegir":"^37.0.11"},"gitHead":"81311d5fcc6a5512ed3414aa592bdc9e6c481b03","readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","_id":"ipfs-core-types@0.13.1-6be59068.0","_nodeVersion":"18.12.0","_npmVersion":"lerna/6.0.3/node@v18.12.0+x64 (linux)","dist":{"integrity":"sha512-6WOZBmweV1F2M3LH8v3z4xiwN+WAMedXPvc77ux6pu2jRA5y+CvazwQhWJL4DNW5IMKptrKL3KjCGeiOk0/Ypw==","shasum":"f0b2047417326773de0808db33e2d3bfeecce966","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.13.1-6be59068.0.tgz","fileCount":133,"unpackedSize":200823,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDecmOyanxfUIDjJN4qs6lGxMOCr4Z/TzFZwuH4Jgj+IAIhAPO/SIW5S6pVpEVm4GbVb01nXgqcprZoPnMTG0TbHs0X"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjdo/fACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrBlhAAlcVkzG8Zobd5ATXg43LxW1xl8UfOz9CPW80gTcifXzJxsc9r\r\nxsCI0fdrTr9FVM1SrstVnYCAHsawVJjiH9BEzKh2fohP6kwrJwjAf+HnP/st\r\nJLRvY58+Z4i001m91HnnfQ2AsvkXghJYyaX6kqa5/fIbJLjsDMn2vDqDYDOx\r\n44lprm4nRWKgWRgmE1TogMSZH2YRxW3xFkEYR2jFQtLjTf0leTEKPWQ6siP+\r\n38E5dm+Zg/HOnMHie9NITbVKOa7gf7SIn8YU23SlNKcgvFqGn3DI/w07lknT\r\nN6JUkBEWHIbv9mqMkgdNp8Zs53YDOgE4opk6TvispGcpFAJCLLmWBVQY3jNh\r\ndqpQmaG/B2VSkCO2bBsLTp1z4MM7E2VdTNOkCt3aDGFCDeUZ88yZ74V/xQp6\r\n6s8poL1AT5oknXR15v1WcXcgm9tdiuGAl2K5eMcd9YBvVN/ULKBkBGQQnnTV\r\nDhXk62SD8+JrFB1+IFBZDGdXu2OUDMUuLpGYZUhQdbpWWlqLipABpFNXOzT4\r\nFyEvtzF2m6Andh8Hb1IUYIzkoNKgIzgrgmX0cqXQw/15h6ChAXMr2B/YrfC3\r\ngm//MoTNZuREPyVPPSVE1M5K6XnVE7DHM2iURG54nLHXUUideJxg+OI4U2lo\r\nP1q7lh4oFj/CqH1Ro0YuEr3ioi1x+7EetLY=\r\n=53nV\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.13.1-6be59068.0_1668714463393_0.20243944916101597"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.0.1-563806f1.0":{"name":"ipfs-core-types","version":"0.0.1-563806f1.0","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^4.0.0","@libp2p/interface-keychain":"^2.0.0","@libp2p/interface-peer-id":"^2.0.0","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^3.0.0","@multiformats/multiaddr":"^11.0.0","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^9.0.0","multiformats":"^11.0.0"},"devDependencies":{"aegir":"^37.9.0"},"gitHead":"19b0474216e0a7dd7363dcd6733379790b68a1f4","readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","_id":"ipfs-core-types@0.0.1-563806f1.0","_nodeVersion":"18.12.1","_npmVersion":"lerna/6.4.0/node@v18.12.1+x64 (linux)","dist":{"integrity":"sha512-Mhl6UbFAPpPa9nuhhprYaSy3IHsd3UHkmfJizNgFsqXK1KjL8mz70DgIM1u5knspOUpRPGngi1/V9HE/sC1HSA==","shasum":"fb20f23436ce5becda0c87d1ab3efc6848c7b8b9","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.0.1-563806f1.0.tgz","fileCount":133,"unpackedSize":200821,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHgrTJwVPif4l3wt91M1p1FS5uMbPTGFhwkYgo2CcvuXAiEAhFp9ySKStZdfpPQa7kB6ZR8XbE51ZGA0BpZXL6kPSgs="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjvFifACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmp9SRAAgFMxmOK1k6J4CLrjl5N02dsSzoLJ+d0d6wp1zDHbcqDeWo+z\r\nKt+23/E37CfMtcvSRb+NmMCgE8kTChICIiAm8NTa2oOJcYOssjWkDZXlVyyr\r\n8monJ7RtCwV4Nyk+bBrysuk0/5BXrGy1J4QWt1qN6FpFfyS1Y72IOpVTHjlL\r\nvcQIkVbSUs1mvvGoJOBQZ4p8DG6ba2tXm9SMj1krJ3iCIQn+cmmzJ8lxwpEF\r\nTSB6W0VZErmjIpimhGt0uv+N52tvek+wdkjMX98OyWeWdL30ea6zaS8Zkiz8\r\nNZO7bnZusxRZYscfsw1Wo/hJQKYPLE5FnYbXxY97C4oyPKC0QRILUKN4CL4Y\r\nMHDo/b0Fm/xnzET4oPN6VyJrGAE4rvP20/ErYxZEynOGiRuPkhsWsbMbOhx/\r\n9c0hxt2u3hSQmlwqiZbsnleRspayElzm12bV6uTwKTJKelKM79mMCwkZ/tjz\r\nac9dCtgx/g5O+vtqg7w4cBZvCykbygd1fgVmWEzj/a/wgE9fhANEKmFN0Klo\r\nyE1KQyflOm55QvQ6/p6w3DPQqih7WiXyckm056/PKSfDU1AOK9/LZfnbOBhX\r\nrOy9ofyArDCmY3LTFkgWBKtAN2Eut54wSpyE4zsgMVhX0kKYlng+ld1klRKw\r\n2LE2xatFXmZjB3cwQDqq1B+Il12cnzOD9oY=\r\n=c9BU\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.0.1-563806f1.0_1673287839100_0.9890347938226718"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.0.1-e85e5b6e.0":{"name":"ipfs-core-types","version":"0.0.1-e85e5b6e.0","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^4.0.0","@libp2p/interface-keychain":"^2.0.0","@libp2p/interface-peer-id":"^2.0.0","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^3.0.0","@multiformats/multiaddr":"^11.0.0","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^9.0.0","multiformats":"^11.0.0"},"devDependencies":{"aegir":"^37.9.0"},"gitHead":"5d268429a92d15e22b1cbf7fafadca662b131420","readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","_id":"ipfs-core-types@0.0.1-e85e5b6e.0","_nodeVersion":"18.12.1","_npmVersion":"lerna/6.4.0/node@v18.12.1+x64 (linux)","dist":{"integrity":"sha512-SHw3e91rx6DEEma9fopkCGMGDoVP2Z3AFC2mulagHpW4hdjGOSAC4He1nVxc6qKo3HIJGgVIkXPZC+wP+TqCcg==","shasum":"14907a2d7b9d363f05301cf668ed309698e5f019","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.0.1-e85e5b6e.0.tgz","fileCount":133,"unpackedSize":200821,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFYpQbXyKfq7XrtrTruh5ooQJD0AFU5Zg9AkJ1JiTFp4AiEAhZGWTim2zlCkE8Zve3WE/9MDmzQ1LaSdCbo5rcm0Lko="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjvGfmACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmq/XQ/+K3oAW4964+JD6Til6A+774VkhmNraCsKnhy6hlCe/eeCGfI/\r\nORKhn87HmdQ0+E6EZyRk1vLsKd77RNSejRzWnENq8XlfiV9tYp6gs9QpmXdM\r\nucB/RcNvVQHlR9B+WXxFjeg6gNt3u+re/xB5W0v9rCIxVccUJArq6+wjQXQF\r\n4Sp/buKwLotb36qZ/GLnZ1dmn5ox35mgioW2LGPCzGghBxbKz2J8M1IG2mbK\r\nsajXbeLl84APyM1daj5LjGg8AbbpuoPjhw+K3jGfqkJzijijEgGs6yFIXYyA\r\n+vOnQyJslLH3G2IDA2T0A2u8EUPaCcYMiFOo9xFOXfOlbFnEPOTkHQzxlYpf\r\nz55wEEWWIMxxrZeDWood4gFQ5WGzv0CIgHdjsIjvmxDOSTd2s9qL826bD2Ss\r\njmm+K8COL7U3/k5jhHh+rFt0zMTAstRnFKzPA6RXj+HSYK3B7Od5B1Xw0oO4\r\n21b/xW2st8qocHI1E0Dv2yOXmJ1Kr43nKSRJjqjLujoaC/Oy5w2wV11DVhX+\r\nRh4aAI3reWLLqkfgYJyLxT3M6/wvDqm71sF5ZOA+4LWD5iDHd53GaAltoa6u\r\njDKLOm6RI575uY0G6sbLhhgwZxAsOY6bnsQXEQVJheh1HFLdzA5n/C/j2E6w\r\naLDjr8xNMnh1ZhRchtjM7Af7h9Ga7dV/5m4=\r\n=tH0F\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.0.1-e85e5b6e.0_1673291750736_0.37314584896741576"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.0.1-2a6fede5.0":{"name":"ipfs-core-types","version":"0.0.1-2a6fede5.0","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^4.0.0","@libp2p/interface-keychain":"^2.0.0","@libp2p/interface-peer-id":"^2.0.0","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^3.0.0","@multiformats/multiaddr":"^11.0.0","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^9.0.0","multiformats":"^11.0.0"},"devDependencies":{"aegir":"^37.9.0"},"gitHead":"12b210560953c0358e012a120d162b5f3f32d06c","readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","_id":"ipfs-core-types@0.0.1-2a6fede5.0","_nodeVersion":"18.12.1","_npmVersion":"lerna/6.4.0/node@v18.12.1+x64 (linux)","dist":{"integrity":"sha512-PdsSaFSgztj4MtUC/68gJlTEa07PS/TKGpG0O7hvwMub8RHf0Mof1hOvZnSiS27AXrFH3iKjoZuKHJLqRPV5IA==","shasum":"4a0b493f1d617fd5fd473aa317170acd8ed46600","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.0.1-2a6fede5.0.tgz","fileCount":133,"unpackedSize":200821,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHylEGwtr1iCDpHtSVKo2SEOOwgjuoKkFnSno220zVgcAiEAguQsUdpeMblgzJ7pBA4+aiB4GoJ6WHDJIDQJrqRE6dk="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjvTFmACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmp0SQ//fUR9pRIZutFl4EcEMYG8pv+yE2boXMAcK6z3OvRrYcqq1+4U\r\nyI9nFGy6G0HGtx7d5ebOuAkJi+hjyQW//5mHfHMpJQF+aO/xUSIGshFWrnFC\r\nbEhlTUODQzg6zoeC6mWooQVT2nCDulxvgzH8+hlUwCdWj1DvxnjTxvanmnI8\r\nW/HNFiboy/tqm33lwwLYNMJ2YajZDzSTXVf7tRhne3ywlCNsdSPA7BbWOg4L\r\nkGN4JswddS5pto8DFbUWd3NUHWWlld95rFt1WcxyUffukoTVzPs4mZL50Ggz\r\nqxrCmNgudYYvBTj9q8QVX9yFzYDXbbsRCsdefEZkUk+LAClvjOCPAzwhnXjV\r\nwvw6uQoZWlqJhqtpCNUkwh1pGPr032WrLwwMnuR0lJjNtWdzo27+W5FY2yYC\r\n2L1HetPcBJbgeqmOqg+fHt0wXqhE6ArlQbk/fHzZHKHSVCdwTObx5a7AkZbd\r\n6BUTyJJ8o/PqdHqy3VAHj5Enbo1qFSYbGUMdj9vp5nurmmjIr1qMz44+ax2/\r\nYAC/80PcRP20/LT1nVWEHul/j/2WMYMfLDw3ZCp/gGf18yMwEoaqjKfc4FKU\r\nc7YvNP3QVJ5kgSeAJdFUF+Oo+Nt6OzC5aAIcVnGeVxp7FsOjGgRJxKXq1Mpg\r\nOheBZhXbQfoZoiy52kuyWhWz4kDqo9pvzaY=\r\n=ceGB\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.0.1-2a6fede5.0_1673343334608_0.5126354745109696"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.13.0-5f73ecad":{"name":"ipfs-core-types","version":"0.13.0-5f73ecad","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^4.0.0","@libp2p/interface-keychain":"^2.0.0","@libp2p/interface-peer-id":"^2.0.0","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^3.0.0","@multiformats/multiaddr":"^11.0.0","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^9.0.0","multiformats":"^11.0.0"},"devDependencies":{"aegir":"^37.11.0"},"readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","gitHead":"5f73ecadd7d397029be8dd9bc0dcd82469f07359","_id":"ipfs-core-types@0.13.0-5f73ecad","_nodeVersion":"18.12.1","_npmVersion":"8.19.3","dist":{"integrity":"sha512-PdKOckIYhivjjPdVKPrIXDiHOcZi3GjYXHWduPo1qGlgJre7hJhT1KDW8/3fFRbnLvGFRo0867mOSeBfo5uF4w==","shasum":"7a5faf387fc66a77f8350154853de35b69a1b1a6","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.13.0-5f73ecad.tgz","fileCount":133,"unpackedSize":200764,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCYebQbAze5XfhoWBlNUlUJ1139BZEI+om8+kbUWw+kiwIhAJXWbV1efoXqTGbB8jlfewcdCwz3wytMsSy8k/bZMJYj"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjvZzyACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpmNRAAl4eGHKYvF3Hl38PhQfkH76Lm8Z0jgKf/4zGizAFN17eKW+Dm\r\nnAiTJsKeDd5P+PpfdVi3yvR+P8xt3I1II0SE8GOEPtMFcjmx1Bwp9Erq6KXS\r\n6jqjY6VULuEf+6k13p4kmkKj6BufqylFzeT3sHQQxFjfxn0C+pdMZ+Rqw/XU\r\nBYILMr838aoMTyfuoXhf9mmbeHDTCoTSrCwsimZ5lx/tClWFMHYlhLIG+HDo\r\nUgb9REm/EoD7pXX/yQk8lCZ4jke88LjMohMc2PzzXTNTrfXvwrFhEW+hucnS\r\ncyygGPpmDExUzCqbgrgMPZceS5CWzOEm9f2rJxLT5GX5DaS+v/cdbTvXDTMB\r\nWOKnx/I9sGx9S+Idhfp34rcaI9z0dYAZaRexwWytRit+s1v4EyrfWfPRgo5H\r\nMXbSw4YcDOSLzcGEl8ZcIV3aNyvH/ywX8Qz4mauOb9BtdGBjeLRo8oWEak4u\r\nVl1I49kieFc0lQY1kM+8N/prW9wUei4P8hIXwEI4AfJvr99GnuT7ks+GVN+v\r\nezfHMPbmXI5OldbuN5Gj0Bsoyzp/kIq7JAKy1wau1MQi6dSIso2WrqFfQuPb\r\nnMwTU9v63ElZKafReU7LH77sJH0+roy8Bhy2F+XTAfP7G9s5wFoID1ox1Ae7\r\nHJ0jgH44hJ4ilXCbjzr1F104YoaiVFsL07A=\r\n=DB3r\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.13.0-5f73ecad_1673370866180_0.4528462896944647"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.13.0-4b4c124c":{"name":"ipfs-core-types","version":"0.13.0-4b4c124c","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^4.0.0","@libp2p/interface-keychain":"^2.0.0","@libp2p/interface-peer-id":"^2.0.0","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^3.0.0","@multiformats/multiaddr":"^11.0.0","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^9.0.0","multiformats":"^11.0.0"},"devDependencies":{"aegir":"^37.11.0"},"readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","gitHead":"4b4c124c4c49b1c60a68b4b8e24f1f00dd7f0517","_id":"ipfs-core-types@0.13.0-4b4c124c","_nodeVersion":"18.12.1","_npmVersion":"8.19.3","dist":{"integrity":"sha512-vCAam6ofbm99UgEGvoBUpVEZ7WwN1td4tDJxVVEjfsLBx6985fI8UXvVnq9Okvrc18FQZ3UX3sbtzMBXwxvsjA==","shasum":"351f9a800df6264214e6463b06dc9c8df95f176c","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.13.0-4b4c124c.tgz","fileCount":133,"unpackedSize":200764,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDX6eumjvrHIZyO4CYSiztSXoCrhZJroyEeApLD3QZjeAiBF1LUJn4dbNiiOBDhdsDfixVdMNdkhR6rPCSLDgV0OZg=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjvt5SACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmq2bQ//UBSsLmLbDYiK+Yx1xL4kZHGdws+i2FTSfSf8rKJbob35uSLd\r\nWehQ2BeqjvU59Iw/b/M4rfqXXAhTQSPc2BZJoZOlwXRhLs3FXcBcg2k7+NxW\r\nhQk1sULeBy4Ub9ji4KNbBAes1HFxB4RaEPsyk6XqHxRX5LR8iTXhNgFYzWFU\r\nb6C8e1qgLNhPm7eI/00boET46ntZyQy+S+wkLTO51y6iY1Jbbs4hs91CTOjR\r\nkXLhLrGjZrsgdt7yzkn89ojGLqM84UatIyruM+lWwSW3zdC2A3eXY3t+eBS0\r\nS3t9chk8AOY7UU6YhBbJcE+9Z5p4DF/RlgIOv0M8tSAON0wfPCYtiySzwgz7\r\nJ+SV2cgg4mNCETd/FH/52PxErvDgI1fS0M7iLiPK334CgpYOwVUA4n3tAczb\r\nMs6Ifhh/7G7JiMyHSfTyNkqY9r7qjqXf40YTBTzkteOrcPjIZIKy8KCrs2Ry\r\ng+20B+jNJp0L7W9+erNKRBmPiUrMqsi9Bt7GVCFk7AmgkRRZi+bz58f4AE66\r\nMGZjPi3QF2Al8LMqZx9ya62HCSAacBtoinxOeeiPbH6ZCSQX9uJML5wHvzhH\r\nA5f0KAmmq6ypFBRniTwg9Asb6Tn8wVcnKXO880v1G9KETPwt+JYYugepDvh7\r\nA25UKFWZD1AhUoU3F9UpCMg9YHjlOJM+oRI=\r\n=GHoj\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.13.0-4b4c124c_1673453137737_0.6722429916305261"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.13.0-789ee585":{"name":"ipfs-core-types","version":"0.13.0-789ee585","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^4.0.0","@libp2p/interface-keychain":"^2.0.0","@libp2p/interface-peer-id":"^2.0.0","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^3.0.0","@multiformats/multiaddr":"^11.0.0","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^9.0.0","multiformats":"^11.0.0"},"devDependencies":{"aegir":"^37.11.0"},"readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","gitHead":"789ee58556083ef71a4ef44e3358f86c5be101fb","_id":"ipfs-core-types@0.13.0-789ee585","_nodeVersion":"18.12.1","_npmVersion":"8.19.3","dist":{"integrity":"sha512-8/5OJIx6mM80He+ysyb2Y5FV8LsF6/6eoLsrplgFo3BFMoPgb56uEwZEfqvF1Gz2HKk0U3Fu34HuOgi0hOjHPw==","shasum":"a629f75606c24378e85d401f67e755bf5df342c0","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.13.0-789ee585.tgz","fileCount":133,"unpackedSize":200764,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDu/axxhmwUqCuPplTuA/bkzzuCw5m88DUeuvG3+o43bQIgZ/WGpETWyupEscDz8sCZhHN89K+5fLd/yol025eliW8="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjvuxUACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrNuxAAkT3QqwDjSHY8ySmJgc8qBvtn62o7xWdP/btn0h8YAY8fSllp\r\n+2alkRSq8EyPm/Da7GSSA7kT/chOs2reuF71rPr5lgW/EPC8P3xAZdPIMy/o\r\nORafSbfmTzkBPQt3lyYmEVYo1WN0/5hqoedbgAiQwI67RPbhvkZY2lSAu0oz\r\ngSydh/wvsD9bryQsU9gX358jDvS9TpK+noNQz1injZTnRR0QaRckhF6QxvA2\r\nKs2hb8J3BZ1YwvkhR792yqaiZGCLhDPGtkpFA2rZL5eFD4FoNsd9WEm1jXv1\r\nRhd6fxloAvTj3rU7EsQGP5bPT4JmHdw61idUZra20oTUVhqU4kv0g+jnBiZ/\r\njuRWpsmAx4aCwfggosG0CU0RxUa9uml9Q43uv4Sh6L4WMTpwCP/4TRkW3ZwV\r\n1UwJGhmD9MR9lC6TN0PPRdxUssAdVJLHPij7r82dpp4oIs9lfgBSTdjjNYSu\r\nejm/VUk0sV7qpKN+8bbTkhhakowFYW7m3mMHR8cEGW5jIbQUtahamRWnyrDm\r\najfBYeEtinz4Akw1d0y6n48ttufyOJxRMpopa/l7X5+HJJT8O8vlo6a+xHK5\r\nJ4uoZuduefjy2Ejm5xmhqlG4xRNWHFJ2P7wm1AUo+cpy6UdmS8RwgOIm7rT8\r\nbo/eavOg207a4QTOPqyYI/6dE0Rh5RGCKk0=\r\n=x8pt\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.13.0-789ee585_1673456724308_0.7985241445980498"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.13.0-fa578bac":{"name":"ipfs-core-types","version":"0.13.0-fa578bac","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^4.0.0","@libp2p/interface-keychain":"^2.0.0","@libp2p/interface-peer-id":"^2.0.0","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^3.0.0","@multiformats/multiaddr":"^11.0.0","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^9.0.0","multiformats":"^11.0.0"},"devDependencies":{"aegir":"^37.11.0"},"readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","gitHead":"fa578bace93e459849a0ffcebbd6f222dc05652d","_id":"ipfs-core-types@0.13.0-fa578bac","_nodeVersion":"18.12.1","_npmVersion":"8.19.3","dist":{"integrity":"sha512-nFhkZ5IsADJpV+klhtuqAHQuUvjP/zr7VNxww+kMyM6/BrUqH8/4PdaaensDZmSq2mPHj6Bt9sdAGSK5fLkEyw==","shasum":"204b37d8d4842f14e3447ac7b98137ec9d79e88e","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.13.0-fa578bac.tgz","fileCount":133,"unpackedSize":200764,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDoFE0uacKvjlkSHZ6+pRWBk7+sn9LvEPBRKNBdDHeEtQIgTkBYRJ8B4SCQ+2rMp9xo5Gryip4t/AcEFDkCqGekdJM="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjvvbMACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmr2qA/+NLOCLGyq6qrm336ONZ8odU6NvG2MDxqIMIJfoeiajeTBxKZX\r\nUlw43IMsZ9rZTwFvrtAQTNBQ18iQO7WmmYBwj7fKCJDZjkUwcmpIAWl2qvrz\r\ne0zvyBHxh5VufW+rOrwOYvybwGjvXwW+/l6tl2jtkAswCrVEUpRY+i7+87L2\r\nkk3Vbp+5FYnmkcukCCWlwgylxiX+WkrRJ2bii9txJaBdOGY1Zx2CAnhgXVVH\r\ntnlE6ALLK/7tUwLkHHSNCbyxi3gryXaQyRdx82jfTh2ZFzvIM1A4sXGV56xk\r\nwQtg7fLGrlCeX7p2WHKWHtIqpklDboElRf57XAyZweD1hHX8YwVNr1cWO9Rb\r\nUFvb+c97KWM+YdM+2ILJR6tuvKHzO2JHhSuBbrilGQ6XXMp4/7+48JMV439x\r\n9Mj1y8hbZp7TCTBo5wPwDmjROGrH8n6CDpkJAp0DY8McCgNPAx2pvJKTjIfu\r\n/On4z1dwlCZc0VgaYtKL+ZFs+jCdswzrhHhy5LtzkPdcp8F60Io9TZU2vFaN\r\n//TurJjbVx46uSPiec8vESemHE8L9ww1HFe7bDVC3vTP1L6I6aFhHKdGGFZY\r\nVnzK4YM9Pm2pTHIGHVFoYSsJNFDlNDWZlHwljKxUXv7GetA6Sb7XXNxxnWYL\r\npv5hBCMcPURscEvqrWGrMhUZQJ4ZoBNxcEg=\r\n=mGY0\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.13.0-fa578bac_1673459404226_0.38280871492769575"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.13.0-d1c3abb3":{"name":"ipfs-core-types","version":"0.13.0-d1c3abb3","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^4.0.0","@libp2p/interface-keychain":"^2.0.0","@libp2p/interface-peer-id":"^2.0.0","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^3.0.0","@multiformats/multiaddr":"^11.0.0","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^9.0.0","multiformats":"^11.0.0"},"devDependencies":{"aegir":"^37.11.0"},"readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","gitHead":"d1c3abb32b57379b5446d5eda232d7750a2ecff0","_id":"ipfs-core-types@0.13.0-d1c3abb3","_nodeVersion":"18.12.1","_npmVersion":"8.19.3","dist":{"integrity":"sha512-8yYBdkwAnJuJCUM7lKZEMxd6YT+/uuVZwFdyR0DAIBJD4hs912MNonbmJG8He877iXTENMMscmG2GbgcXxnrZA==","shasum":"ed869cdcf76e5f4e95d44a9de1e6cdd7c0974a8c","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.13.0-d1c3abb3.tgz","fileCount":133,"unpackedSize":200764,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCUEQHQWvxKKvwpRh5ULF7d/3RAMXjQPDeDED6xgCrN1wIhANxETcDL5kM18lCdevKz2X7BWvqA7fnvLeoNzxg1DJjB"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjvvsvACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmptPw/8CA2nfH6ofAiKoadkXzpDGqVJuyhjySVFUsbITT1SeE2uNxij\r\n/qBfWF9TeezPKHa4grfW9Cf1NR06MMLvUQaouP/CjKKcRw+g9N+LirHwykbI\r\nVqU3WeZhsJua+bEBLzSh+809nSfPj5hCYCwkJfWiISXQRczL6jB+6bWijcHM\r\nMFuzAZSJRn3CHo2JB5UyIR9ap4aa/ZbADNG/hgngFLGAc5gHchJ3fyMUIJLn\r\nmkzjX0TwamfPTpVVNPq0reoMDyDpn901qqseNUaSSQDDmKPj8bGxZUGhg7Fs\r\n6VYLv4XYIsp1lhoZs9TjCyaBN1V9iQ3JxN8/Nw/KZ1IlyccFyZjJ408dz6+r\r\n4NpYUjgJeqBd67+H1q5xOLZ1Wib3BeZRG3IN60BzCtpeYv6Q7H7nTqZE/RkX\r\nk6Fv2+aAV9XU5NOzf5CyQzCwlCcxEhzkFqml+jZLmjr33XEddntDZMOt/gsw\r\nAFWGqGtl2IXLtMrF9Wm2U6e0QBl5EQDzbRalczFs6Bh25fQbmRGArYeGfGLx\r\nN0kYJqYerN/U2qGXR3jmA8yKVrabGsIH3HozfO+eXmj8oxwXs54HAkfEPIW6\r\nokFODAaCP2uX3J9PjX4s9q866VY8sZEvXjwPf/RdKNmquTB4Q9Ok2h0oVMBD\r\nMmDZrl9bQT/j2LzrEeffn3sl+7mhypK/5Vw=\r\n=c9fN\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.13.0-d1c3abb3_1673460527451_0.1848612428429861"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.14.0":{"name":"ipfs-core-types","version":"0.14.0","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^4.0.0","@libp2p/interface-keychain":"^2.0.0","@libp2p/interface-peer-id":"^2.0.0","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^3.0.0","@multiformats/multiaddr":"^11.0.0","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^9.0.0","multiformats":"^11.0.0"},"devDependencies":{"aegir":"^37.11.0"},"gitHead":"6e940670681859682d41ca1339744955c9ee20bf","_id":"ipfs-core-types@0.14.0","_nodeVersion":"18.13.0","_npmVersion":"8.19.3","dist":{"integrity":"sha512-qO1xVO3n5m7scTXXtMz8hDTLdwXInnwqadIDQpXC446BIlaYyRWUvLcFQ2bOjQql9/CPNTaPHzjzr5Y1XxqpJw==","shasum":"a301d534f5261aad2254da393cb09f9cd36b6742","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.14.0.tgz","fileCount":133,"unpackedSize":200755,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFhEVbRLI30FS/AOourm73gHgTZOMjlMtLfnqp4uMZQRAiEA+muuNNBmmg3NDhgm8nlsMFdIcKl5DjQINKNIX3lfL5I="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjv/CyACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmqb5g//SW34tYHqNaQsHmmnuO2s6HB00h3R5b/qDzoM7esqCBO64YBL\r\nY5mqeWYtrXU7zSgswEsq+tr2w2tQEae5Q3WSTA+r8csOzVFXy+7D7GwIiYI7\r\nCzfuF7yFJd6klmpdRzRbruomxLOD+hyxAGJ8hjF42kSF6KKQ2YdPfV3w2Ptt\r\nY614lX/OlCBHIDaWkxj5XJtEHubCmPqt5sMYLAQqhjTgmXL3j+QGDB8yiTv+\r\n0wjOc2EvjzPMd0U3iLDlUCA4e88GBzIcn6PfBd512FvoTUp/FgAEd/urDgxO\r\nllLphmpgTzuFic8d4y15fQyxW+Hd5HKFuAa1i38d6tuNX49cU14uUcG2RAQi\r\ng5C0qV9d8cLo3a+1pODqyNkJSoGm4QoLuLlYDTQBL+PYkRtQOQn3YuDwcPZx\r\npariOsOKD2NwKWfBiDsHacvj7Y0MueFIoFNioDwrtMU1wmDtFvxDMHFn4kSJ\r\nibatGICPhV/M1UaTL+fk0vBQpu1FwDtzn8U/JAPm4wPw5fCOozU6uf4c+MkP\r\n3CpomCvss6YuyANfEzUsZmcnAPa5hCl0hXt9207wDmb/wv58kTgw8RKpiSiN\r\nP4ZvgOTTANiT8aI1H+vjU/ppo0s3FvUYs+6P92NLwCkoHde9sZT+L9ecIyJu\r\nKN2NqsiHUYLeXHxoZdgQxYeEgqjaNgwIOZU=\r\n=gxDs\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.14.0_1673523378259_0.8235671735882211"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.14.0-6eeb1be5":{"name":"ipfs-core-types","version":"0.14.0-6eeb1be5","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^4.0.0","@libp2p/interface-keychain":"^2.0.0","@libp2p/interface-peer-id":"^2.0.0","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^3.0.0","@multiformats/multiaddr":"^11.0.0","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^9.0.0","multiformats":"^11.0.0"},"devDependencies":{"aegir":"^37.11.0"},"readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","gitHead":"6eeb1be57c8366b82351030e49a5886d1aff8bf6","_id":"ipfs-core-types@0.14.0-6eeb1be5","_nodeVersion":"18.13.0","_npmVersion":"8.19.3","dist":{"integrity":"sha512-GfKVAyCz7f4K+7Imtlc5QF3D6GpUBZZ0wVpBnfm+vg2ULkz3idBx6LW1g5avRrpVxO0P2fyb8UkcTf29NuykMQ==","shasum":"93986401cf291920991b06e7de6efc89b3166658","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.14.0-6eeb1be5.tgz","fileCount":133,"unpackedSize":200764,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIElxbYNQ0O/sD2ZfxKydu2oynwMKrIXbwMWpAFIlzKUhAiEAoN6D5Ft6JnIKPsajK+iWeXXvQZnVPscreIBQwSliWdc="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjwaDdACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpNXQ/+KEBMbv5oZxnrTR3By13x2Hhy9Glup+L/r4WGxwWAS0Mt2jRB\r\nbXaqY7xhRtjmRHfDhESQTlye6zhZZGfpphes0PGaPyDqF5iywjWw9smoZoqH\r\nkTwSHRE82BsoVVcAo5rR8PoYQaRqRLOy19RF0XkSgGCwmf7u2IY5DLbvUEE/\r\nbeQaBGQnPuwckVtvcLgkIQ+u0zICLzyRvDy0J59fBJ/DLTLOnrK1615aWp3Q\r\n0VfjCJQLWLZKGTym/JOINmfgziOyAgpEHgiaiboPhQTsrnNlmc2d0Ui6ulU+\r\nDaRzCcE0KfDVKzAy4ItUu9EdndXfDRYte3CN9wt8GB05Vfm6CaBX18C+VZ6O\r\n1KXjGQVeHudne4zTVi5o4TJX1aX7IBhzAkCKOTdGuWH4xT3iOyeEJ6LJ+Wna\r\npuyl0aeW/0Vm5mFmtwU0qMGqmG4KG9FFQzCjIlGf9BpX8jUh4OmAzR4A/xo1\r\nLt6f8CnZfyB7Uyf27pl+scTRAhS06xhgdv3LophzfYAIYzxHewFk1lmtFSRZ\r\n56JhBpxMcMpRR7u8puD2remuI1R7JvduRwQPkIYBY6Xy0+OSKPY+YZDoooxS\r\nbvZn1LLUODS/aDByNI5iHxTTslvIT56+W/bUB6Fci+gMuQpMTabpELiv9Ay9\r\nRiTFEKfNy1vlMtzvQ3EVqCZoctw/n7stVQY=\r\n=l6sr\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.14.0-6eeb1be5_1673634012840_0.008903818266737584"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.14.0-ab02e8f8":{"name":"ipfs-core-types","version":"0.14.0-ab02e8f8","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^4.0.0","@libp2p/interface-keychain":"^2.0.0","@libp2p/interface-peer-id":"^2.0.0","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^3.0.0","@multiformats/multiaddr":"^11.1.5","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^9.0.0","multiformats":"^11.0.0"},"devDependencies":{"aegir":"^37.11.0"},"readme":"# ipfs-core-types \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/js-test-and-release.yml?branch=master\\&style=flat-square)](https://github.com/ipfs/js-ipfs/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)\n\n> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","gitHead":"ab02e8f8b3cf8f4eeb9991fef3b0104728ced675","_id":"ipfs-core-types@0.14.0-ab02e8f8","_nodeVersion":"18.13.0","_npmVersion":"8.19.3","dist":{"integrity":"sha512-YvEYCC/VpO6pFZoztJjuobNH2F0huE2jAPDYLN/jcXawDmPUHc0sjaXqWAOiXRjutQqTERaiaJsJx27BvzqC4w==","shasum":"69862bd63b3f615285cbca40f41fb446d8f9df9c","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.14.0-ab02e8f8.tgz","fileCount":134,"unpackedSize":201326,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGMUVWxUjZdIZT/gAX6aJ679KNmFQb2Cp3MPUYLeOzAkAiEA9Z5eeCc0sRh2LlJiwzQTj7FJI2Zn19fcNR/f4k83Bow="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjxpNYACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmp+rg//bFi5PlSr2Cu5houPm6zc3eMxbBMc3MHujVSUu2rDTbOTj98R\r\n7YPJzPsaifbrFjezqiq76oipadSmUFkk+kXxqaRZIhUPG9y6iKxz8bjVuj9J\r\nPvjK58PfERxcR8OCcaYUJ5PX81C5gBUAJqeIesjKP0U04bFqof2GZCevtP3r\r\nrOQTEuC3Rhdg0N9yDrxMKpjsteRiNsVRNWfryDFwbOCN+jRfCPQA6Y7NLAeu\r\npsgxxwXeEaKUcgEEXTrgzoohe/58chYfs4hULnutzIai4mDc9G7rH6Eibn8T\r\nTU3gCBz5W4qbyl5RV7F8FPqigWMxjBw4N7BJB1tEKB5rjkjkW2i4FiQCiMCk\r\nGLbNd1lXNRTBut62dR1DPNdM9+n0RPoQerGWj4ZHaQxGXE2wffuza/0wJrvv\r\nLHMN1ARbh/NViiVjnaxrqvrIiDysCNEnX/IFKzko+CVGl+oJWwff0g0NX4H3\r\nHtf2KtmcaHx4YvuHeHaZOfE2A+/xTsVQTcvaaUpSp6vYV9llifu8ihz/yfA4\r\nY8U9nS2Z1/4+nBEzhWRSKrH6G60BRMO2bgIxG4hOOsScdJeeV3oJHjc6YRUh\r\nO1pQ/8vz4bpvG9ijStS4BXcQrao53946hMfg0nWG2iSXGeNfj6qAu031YTLL\r\nzBGHd3+Qgkdk0QDHVgfMvKkBKUw9kMk0Z/E=\r\n=vfjN\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.14.0-ab02e8f8_1673958232587_0.6470475844572225"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.14.0-3bcabe38":{"name":"ipfs-core-types","version":"0.14.0-3bcabe38","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^4.0.0","@libp2p/interface-keychain":"^2.0.0","@libp2p/interface-peer-id":"^2.0.0","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^3.0.0","@multiformats/multiaddr":"^11.1.5","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^9.0.0","multiformats":"^11.0.0"},"devDependencies":{"aegir":"^37.11.0"},"readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","gitHead":"3bcabe3818ce8bbbafe0cbb68749b286d8a7edd9","_id":"ipfs-core-types@0.14.0-3bcabe38","_nodeVersion":"18.13.0","_npmVersion":"8.19.3","dist":{"integrity":"sha512-Jx/2g2WpdZQUBOICKmu1E+2PL6N9XvwpOJAM5k4sR5i+prMMllvD3CG1nLNZMoWLvxq4zXoi3vB5oQ72cE4gMA==","shasum":"4f4234191274921033e3db594ce0fff7ec3300ce","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.14.0-3bcabe38.tgz","fileCount":134,"unpackedSize":201296,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQC1eLSeyEGIonAPAq13QT9kox61oHuNz7Vnbw2pPcSDUAIgF/QKJYMgRqtces1n5/dOk/QDZkMhuboROtomOdE7LNM="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjxr8OACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqhTw//XJrH02ATb13mqUjF31WGmMsBtNLvNAZkcdtYX1RJxc1UaQxS\r\nVeFdSdqj0JwUxK9PYwa6LtNSAP/ye2lhdtph4QcT35YvT5gItuaRwJ/2VWcl\r\nb+7Yr2em1uefADQ3Yxh0gKJ0Db7eTPC/qLmXBAd82kXIooyMLGye3TmZX3eH\r\nLokcM+HdgILCIYIF8UTNLV29u62VOwucoWoUHLTNJdexUMxKaokrA2UVv0Gg\r\njWJMb2V4M/zQO07Rd/hZ99SAzFMLaXCgLyjLeVge/jazpR/85Ohp4w4oga0h\r\nI+WkJU67PXzXUuU02qxJz14XRnY/o4pm5oC1WJnvP1PJzarbthk4gE97lAGU\r\n5pBackjnDK0pIUkAkHzj7ah7vfhrGRTuyAqPwrXXXWhCyw5s34snW9eyUA6P\r\n/sq//ItDCcrZihh+Sq4NgjzSGqBXca9OCscgLfxzTQw1ZMGGcosVehno0u5n\r\n1E3ZsCF0xycIB1tXPvT6IiRYLqekzx4azeXcgZEbcUcw6piEXnOqb0Z3+WG8\r\ntaKHNu0H02pFweYBKlIkydj834gu+AHL8Xk5Ry2geLQQtguCMA48DqB4FazV\r\ncN9U30Q8AaBL21I9eJVa0bk1hzSUPaU+lWZ/eS+0QCjC3tS8t0ptim9GBv12\r\n35PN5XxouWUgdMDUvxLd7ookaTzQZe26R1Q=\r\n=Jam5\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.14.0-3bcabe38_1673969422082_0.6776260280384394"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.14.0-b64d4af0":{"name":"ipfs-core-types","version":"0.14.0-b64d4af0","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^4.0.0","@libp2p/interface-keychain":"^2.0.0","@libp2p/interface-peer-id":"^2.0.0","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^3.0.0","@multiformats/multiaddr":"^11.1.5","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^9.0.0","multiformats":"^11.0.0"},"devDependencies":{"aegir":"^37.11.0"},"readme":"# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","gitHead":"b64d4af034f27aa7204e57e6a79f95461095502c","_id":"ipfs-core-types@0.14.0-b64d4af0","_nodeVersion":"18.13.0","_npmVersion":"8.19.3","dist":{"integrity":"sha512-uv36w+Jl0TyZ9VMcAlEup8Bbewa1WFmUOdSX/nbzZH+053daA8UGdpgb896TR71isbhA4DLwI+Ud9vbOJUwTOA==","shasum":"37dd908389399b39a090bcc1584e4d9b350b4ce9","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.14.0-b64d4af0.tgz","fileCount":134,"unpackedSize":201296,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGm5J7eXIxGh08AkI6m1U3EJ1O3lUZs+v7IVnp0hhFlTAiEAtQ2i5WcHZ7tK8dp+uCxUBjF7MnrazHuKBblbATRNt1I="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJj2kviACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrD2A/9HTyKutsO+bzN0qlxQ5qLM+jsSt4lq7YkEp/rYPKqSHpI7pQ5\r\npbVqNIn9wOm1tAJTNmWOtlPTLMV83LwDPvLbFbQMsbc/GMS1J+FwoN+jMSfc\r\naDd13sn/vCYmzK/DVmqHPahdiS+V/ocp3vVJsCBZiAQy4TLFQEuvdD7r9sjC\r\nnn1NwduFWDIJ8GBhpbmH1dKaNCpkztIVY5ICJYW/IT6HB5YT5MIMpUzv/EDt\r\niFc9Y28xWnfz5rpERBBz5DA2gCr5n19/aCTzZ0dB25rp4SgsAgwmpACMh+us\r\nCbLSaddzLgWTfkW80bzMys+c4086F/V41+W0IvrF9ADbc1NO/tHL3sguRhM4\r\nd9Cp2WWhYLfW1rr+2gVyEceBoTWCyLS/NkRYlOZ7cc7tSFb2T6IkW4qTrh5Q\r\n22ypsQ2rNKIl7NAO5PFsn4CoffLQhimC5bm0rGyxl+HzOrDS4G/39Wj5Ci6d\r\nnuo4mLlDBQmESP2lBjc0BQjpibHo4Q6AJP3Z50LTWyi3xHnSB51DNryMirS6\r\nZlk2m8nueLZ3gzQf1a5qNpRbNBiVSswIS5ErEFNJtoAAROZbbeu5RJ7RdlJ4\r\nGXsmZab8iGY96fotztGeDxJ6PQDKNCWl8SO90e7jByavNQiPdk5+rYl2CBrE\r\nA6AGQucOFLa6yM5Hm4JfYhVwgprT/s4erRo=\r\n=kzOk\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.14.0-b64d4af0_1675250658454_0.919541688866484"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.14.0-e64813f6":{"name":"ipfs-core-types","version":"0.14.0-e64813f6","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^4.0.0","@libp2p/interface-keychain":"^2.0.0","@libp2p/interface-peer-id":"^2.0.0","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^3.0.0","@multiformats/multiaddr":"^11.1.5","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^9.0.0","multiformats":"^11.0.0"},"devDependencies":{"aegir":"^37.11.0"},"readme":"> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia)\n>\n> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS)\n>\n> ⚠️ If you continue using this repo, please note that security fixes will not be provided\n\n# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","gitHead":"e64813f6fdc681328da7cb893c93e1f4f70bfc99","_id":"ipfs-core-types@0.14.0-e64813f6","_nodeVersion":"18.16.0","_npmVersion":"8.19.4","dist":{"integrity":"sha512-6pObdzbrCDBHRz5dwGBC1j5wTSF14YzCRdqzGSCqo6ZKZboLn5UPGhflXYtCUNbnGaAGLUmcLo6bHgsciVv0Sg==","shasum":"df544d4afd6aca5189aad4e9fb937af1296982b9","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.14.0-e64813f6.tgz","fileCount":134,"unpackedSize":201691,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDu4EIHmRQhnHs91ccz1XYkgEM2n1TBEorG3NIhXMf7uQIgb09e4pHSJs0c0L3hsusRB/bpcCpDmtJAjs9DP44o1lE="}]},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.14.0-e64813f6_1684953932094_0.5566280758304987"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.14.0-4694e806":{"name":"ipfs-core-types","version":"0.14.0-4694e806","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^4.0.0","@libp2p/interface-keychain":"^2.0.0","@libp2p/interface-peer-id":"^2.0.0","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^3.0.0","@multiformats/multiaddr":"^11.1.5","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^9.0.0","multiformats":"^11.0.0"},"devDependencies":{"aegir":"^37.11.0"},"readme":"> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia)\n>\n> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS)\n>\n> ⚠️ If you continue using this repo, please note that security fixes will not be provided\n\n# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","gitHead":"4694e806aea15c66db32e3b4be81c0a5e2fb8ade","_id":"ipfs-core-types@0.14.0-4694e806","_nodeVersion":"18.16.0","_npmVersion":"8.19.4","dist":{"integrity":"sha512-x7QM3NGnVg71kybQSbr9VwDcdniUegP0h0MyjRLE5hLJvmbGbx1TOKoQRM+A//OhIxd+1jwonx7CKqK74AjNFg==","shasum":"f45343a83ec0ad5cb3a495d10694694275210735","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.14.0-4694e806.tgz","fileCount":134,"unpackedSize":201691,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDYZplZ/cUks8YiKJ6P4y6sFw/G/K7pB2A9TzvGv0ND5AIgLYprEAiuLR+w4wEE4JgDjY1YkaKf8Mr9688w6pt2Lu8="}]},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.14.0-4694e806_1685014292057_0.6817977646666995"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.14.0-6d95ce08":{"name":"ipfs-core-types","version":"0.14.0-6d95ce08","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^4.0.0","@libp2p/interface-keychain":"^2.0.0","@libp2p/interface-peer-id":"^2.0.0","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^3.0.0","@multiformats/multiaddr":"^11.1.5","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^9.0.0","multiformats":"^11.0.0"},"devDependencies":{"aegir":"^37.11.0"},"readme":"> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia)\n>\n> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS)\n>\n> ⚠️ If you continue using this repo, please note that security fixes will not be provided\n\n# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","gitHead":"6d95ce0864055e5236ac88c0999460ebc5075c10","_id":"ipfs-core-types@0.14.0-6d95ce08","_nodeVersion":"18.16.0","_npmVersion":"8.19.4","dist":{"integrity":"sha512-pDoFVW3y0ykPBQm8fk4Y4ZaFbd58FtLXpa44PhuNqB3kWUtYd2JoxLTpanoZji7/3+n0gRPiWBBGbJdcAASU4A==","shasum":"20152970040a96b95b32ccaeaed7d40581d7252c","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.14.0-6d95ce08.tgz","fileCount":134,"unpackedSize":201691,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBIjiiopHl2u9KgV9Il7y4EdfRymezXDKoMBVXpwzzNnAiEA4vfPheClIDsJsiXnhqNFucBNKZ4I/HL7USdeMeYLBy4="}]},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.14.0-6d95ce08_1685016621606_0.2148736146707606"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.14.0-7b79c1b8":{"name":"ipfs-core-types","version":"0.14.0-7b79c1b8","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^4.0.0","@libp2p/interface-keychain":"^2.0.0","@libp2p/interface-peer-id":"^2.0.0","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^3.0.0","@multiformats/multiaddr":"^11.1.5","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^9.0.0","multiformats":"^11.0.0"},"devDependencies":{"aegir":"^37.11.0"},"readme":"> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia)\n>\n> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS)\n>\n> ⚠️ If you continue using this repo, please note that security fixes will not be provided\n\n# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","gitHead":"7b79c1b8df5c818dc124b346ea28330455732d5c","_id":"ipfs-core-types@0.14.0-7b79c1b8","_nodeVersion":"18.16.0","_npmVersion":"8.19.4","dist":{"integrity":"sha512-pSCwZPMvDyuBIiGFIE5ZtbhRBskWOfKsUR0zZERSYmRm9rNA5pK9BsmPeGrpwrnOXZ2P/Oem8qg/23FI9U2d9A==","shasum":"5486eaeccfba0b33f719a7cb8a5b194aaa7aa957","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.14.0-7b79c1b8.tgz","fileCount":134,"unpackedSize":201691,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDmN0Doyz621AAtGlShixwyE5xfMYxToq3XJ9OA8Ac2kwIgaXpmRPxHdon2gp2wNUfJ4L5HkupUZjPaKPxv840gPKk="}]},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.14.0-7b79c1b8_1685018766396_0.7307124448647233"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"},"0.14.1":{"name":"ipfs-core-types","version":"0.14.1","description":"IPFS interface definitions used by implementations for API compatibility.","license":"Apache-2.0 OR MIT","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"keywords":["API","IPFS","interface","types"],"engines":{"node":">=16.0.0","npm":">=7.0.0"},"type":"module","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"scripts":{"clean":"aegir clean","lint":"aegir lint","build":"aegir build"},"dependencies":{"@ipld/dag-pb":"^4.0.0","@libp2p/interface-keychain":"^2.0.0","@libp2p/interface-peer-id":"^2.0.0","@libp2p/interface-peer-info":"^1.0.2","@libp2p/interface-pubsub":"^3.0.0","@multiformats/multiaddr":"^11.1.5","@types/node":"^18.0.0","interface-datastore":"^7.0.0","ipfs-unixfs":"^9.0.0","multiformats":"^11.0.0"},"devDependencies":{"aegir":"^37.11.0"},"gitHead":"bf1bc8b18d750d5591bdd575a6d0f4c067d61d0a","_id":"ipfs-core-types@0.14.1","_nodeVersion":"18.16.0","_npmVersion":"8.19.4","dist":{"integrity":"sha512-4ujF8NlM9bYi2I6AIqPP9wfGGX0x/gRCkMoFdOQfxxrFg6HcAdfS+0/irK8mp4e7znOHWReOHeWqCGw+dAPwsw==","shasum":"c69f4dd873324e975ef43c391c0692b96863b13c","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.14.1.tgz","fileCount":134,"unpackedSize":201682,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBC/Df0xozBs5fOTR4exmlsz9zJ5oxG61Yc1S9qGYAmIAiEA918+9L6Ikx3Kp0RjFTuwrRnAa3sc1B9V1KOuL8c11Xw="}]},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"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"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipfs-core-types_0.14.1_1685026762357_0.643164609679413"},"_hasShrinkwrap":false,"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details"}},"time":{"created":"2020-12-16T17:56:12.050Z","0.0.0":"2020-12-16T17:56:12.167Z","modified":"2023-05-26T11:09:45.912Z","0.1.1-rc.5956":"2020-12-18T16:15:30.111Z","0.1.1-rc.5957":"2020-12-18T17:46:41.367Z","0.1.1-rc.5958":"2021-01-13T12:26:02.307Z","0.1.1-rc.5959":"2021-01-15T08:51:07.605Z","0.2.0":"2021-01-15T11:42:35.019Z","0.2.1":"2021-01-22T12:04:03.378Z","0.2.2-rc.3":"2021-01-30T08:08:58.037Z","0.3.0":"2021-02-01T11:36:33.897Z","0.3.1-rc.13":"2021-02-21T09:15:58.710Z","0.3.1-rc.14":"2021-02-22T16:41:37.288Z","0.3.1":"2021-03-09T10:47:18.722Z","0.3.2-rc.6":"2021-03-31T15:16:03.602Z","0.3.2-rc.14":"2021-04-28T12:16:14.563Z","0.3.2-rc.17":"2021-04-28T17:12:51.129Z","0.3.2-rc.20":"2021-04-29T16:56:25.179Z","0.3.2-rc.21":"2021-04-30T09:24:26.104Z","0.3.2-rc.22":"2021-04-30T17:04:46.584Z","0.3.2-rc.23":"2021-05-01T17:52:46.902Z","0.3.2-rc.24":"2021-05-02T09:00:27.209Z","0.3.2-rc.25":"2021-05-04T07:45:00.249Z","0.3.2-rc.27":"2021-05-04T10:56:49.947Z","0.3.2-rc.28":"2021-05-04T11:19:09.276Z","0.3.2-rc.29":"2021-05-04T13:55:43.247Z","0.3.2-rc.30":"2021-05-06T11:42:56.569Z","0.3.2-rc.31":"2021-05-06T14:17:47.067Z","0.3.2-rc.32":"2021-05-07T11:59:05.558Z","0.3.2-rc.33":"2021-05-07T13:39:36.916Z","0.3.2-rc.34":"2021-05-10T11:57:37.194Z","0.3.2-rc.35":"2021-05-10T12:21:01.694Z","0.4.0":"2021-05-10T14:52:45.518Z","0.4.1-rc.1":"2021-05-11T06:09:36.675Z","0.4.1-rc.5":"2021-05-11T20:27:11.388Z","0.4.1-rc.6":"2021-05-13T18:06:45.520Z","0.4.1-rc.7":"2021-05-25T14:40:03.589Z","0.4.1-rc.11":"2021-05-25T16:06:18.684Z","0.5.0":"2021-05-26T09:32:47.525Z","0.5.1-rc.1":"2021-05-26T12:24:55.960Z","0.5.1-rc.3":"2021-06-01T20:39:12.197Z","0.5.1-rc.4":"2021-06-05T06:17:16.881Z","0.5.1":"2021-06-05T06:32:42.017Z","0.5.2-rc.1":"2021-06-10T09:26:36.907Z","0.5.2-rc.2":"2021-06-15T16:49:00.935Z","0.5.2-rc.3":"2021-06-18T08:11:20.696Z","0.5.2-rc.4":"2021-06-18T09:20:58.812Z","0.5.2":"2021-06-18T11:15:47.557Z","0.5.3-rc.1":"2021-06-18T15:57:59.063Z","0.5.3-rc.2":"2021-06-25T15:13:48.251Z","0.5.3-rc.3":"2021-07-01T16:05:40.054Z","0.5.3-rc.6":"2021-07-19T15:31:25.105Z","0.5.3-rc.8":"2021-07-27T09:28:43.474Z","0.5.3-rc.9":"2021-07-27T10:01:12.956Z","0.5.3-rc.11":"2021-07-27T10:38:53.117Z","0.5.3-rc.14":"2021-07-27T12:20:05.690Z","0.5.3-rc.17":"2021-07-27T14:23:40.104Z","0.6.0":"2021-07-27T15:07:47.971Z","0.6.1-rc.1":"2021-07-28T11:30:04.074Z","0.6.1-rc.2":"2021-07-28T12:25:24.212Z","0.6.1-rc.5":"2021-07-28T16:56:36.831Z","0.6.1":"2021-07-30T17:08:18.869Z","0.6.1-rc.7":"2021-07-30T17:30:51.457Z","0.6.2-rc.1":"2021-07-30T18:57:13.366Z","0.6.2-rc.2":"2021-08-04T13:52:37.984Z","0.6.2-rc.3":"2021-08-05T11:48:08.019Z","0.6.2-rc.6":"2021-08-09T16:32:19.410Z","0.6.2-rc.8":"2021-08-10T07:19:19.658Z","0.6.2-rc.10":"2021-08-10T09:09:43.142Z","0.6.2-rc.11":"2021-08-11T09:22:37.502Z","0.7.0":"2021-08-11T15:11:34.944Z","0.7.1-rc.4":"2021-08-12T10:50:49.348Z","0.7.1-rc.5":"2021-08-12T11:07:07.479Z","0.7.1-rc.6":"2021-08-12T14:10:45.331Z","0.7.1-rc.7":"2021-08-16T15:47:09.435Z","0.7.1-rc.9":"2021-08-17T10:52:03.153Z","0.7.1-rc.10":"2021-08-17T11:09:28.530Z","0.7.1-rc.12":"2021-08-17T12:55:54.241Z","0.7.1-rc.15":"2021-08-17T21:55:51.093Z","0.7.1-rc.17":"2021-08-25T07:32:20.618Z","0.7.1-rc.18":"2021-08-25T08:52:43.314Z","0.7.1-rc.25":"2021-08-26T09:48:06.471Z","0.7.1-rc.26":"2021-08-26T11:09:59.531Z","0.7.1-rc.27":"2021-08-26T13:58:08.814Z","0.7.1-rc.28":"2021-08-26T15:43:03.166Z","0.7.1-rc.29":"2021-08-31T13:34:49.085Z","0.7.1-rc.30":"2021-09-02T14:59:47.148Z","0.7.1-rc.31":"2021-09-02T17:38:47.204Z","0.7.1":"2021-09-02T18:18:49.810Z","0.7.2-rc.1":"2021-09-06T11:18:54.542Z","0.7.2-rc.2":"2021-09-06T15:02:00.683Z","0.7.2-rc.4":"2021-09-07T17:03:40.801Z","0.7.2-rc.5":"2021-09-08T09:33:18.215Z","0.7.2-rc.8":"2021-09-14T13:40:08.262Z","0.7.2-rc.11":"2021-09-17T12:50:48.871Z","0.7.2":"2021-09-17T13:24:04.146Z","0.7.3-rc.0":"2021-09-17T13:30:11.551Z","0.7.4-rc.0":"2021-09-17T16:25:29.387Z","0.7.3":"2021-09-17T16:36:03.073Z","0.7.4-rc.1":"2021-09-21T16:10:43.304Z","0.7.4-rc.3":"2021-09-22T12:12:06.783Z","0.7.4-rc.4":"2021-09-22T12:55:33.644Z","0.7.4-rc.6":"2021-09-22T14:12:04.153Z","0.7.4-rc.7":"2021-09-22T14:54:39.790Z","0.7.4-rc.9":"2021-09-22T16:35:11.795Z","0.7.4-rc.12":"2021-09-23T06:16:05.800Z","0.7.4-rc.13":"2021-09-23T06:26:28.385Z","0.7.4-rc.14":"2021-09-23T10:47:49.502Z","0.7.4-rc.15":"2021-09-23T12:56:45.775Z","0.7.4-rc.16":"2021-09-23T18:33:05.643Z","0.7.4-rc.17":"2021-09-24T11:20:41.142Z","0.7.4-rc.18":"2021-09-24T12:45:29.649Z","0.8.0":"2021-09-24T12:49:09.386Z","0.8.1-rc.0":"2021-09-24T12:53:33.417Z","0.8.1-rc.1":"2021-09-25T17:26:09.399Z","0.8.1-rc.2":"2021-09-25T18:11:05.269Z","0.8.1-rc.3":"2021-09-27T16:37:23.990Z","0.8.1-rc.4":"2021-09-28T07:03:41.195Z","0.8.1-rc.5":"2021-09-28T12:00:09.104Z","0.8.1":"2021-09-28T12:02:52.703Z","0.8.2-rc.0":"2021-09-28T12:07:36.692Z","0.8.2-rc.1":"2021-09-30T15:48:47.100Z","0.8.2-rc.2":"2021-09-30T17:39:04.324Z","0.8.2-rc.3":"2021-10-02T12:58:09.314Z","0.8.2-rc.4":"2021-10-08T14:32:55.274Z","0.8.2-rc.5":"2021-11-04T07:26:13.719Z","0.8.2-rc.6":"2021-11-12T11:31:09.289Z","0.8.2":"2021-11-12T11:54:10.158Z","0.8.3-rc.0":"2021-11-12T11:56:03.162Z","0.8.3-rc.1":"2021-11-19T15:41:59.470Z","0.8.3":"2021-11-19T15:45:51.614Z","0.8.4-rc.0":"2021-11-19T15:48:20.397Z","0.8.4-rc.1":"2021-11-19T17:23:21.213Z","0.8.4-rc.2":"2021-11-22T16:17:08.040Z","0.8.4-rc.3":"2021-11-24T09:35:31.201Z","0.8.4":"2021-11-24T09:37:40.865Z","0.8.5-rc.0":"2021-11-24T09:39:24.264Z","0.8.5-rc.1":"2021-12-03T10:51:45.673Z","0.8.5-rc.2":"2021-12-03T13:26:13.048Z","0.8.5-rc.3":"2021-12-03T14:05:18.728Z","0.8.5-rc.4":"2021-12-03T15:01:26.042Z","0.8.5-rc.5":"2021-12-06T10:37:38.097Z","0.8.5-rc.6":"2021-12-06T16:28:42.408Z","0.8.5-rc.7":"2021-12-06T22:23:28.893Z","0.8.5-rc.8":"2021-12-13T11:34:21.493Z","0.8.5-rc.9":"2021-12-13T12:09:15.118Z","0.8.5-rc.11":"2021-12-15T12:50:08.855Z","0.8.5-rc.10":"2021-12-15T12:50:22.859Z","0.8.5-rc.12":"2021-12-15T12:52:49.147Z","0.8.5-rc.13":"2021-12-15T18:24:59.071Z","0.9.0":"2021-12-15T20:27:18.679Z","0.9.1-rc.0":"2021-12-15T20:29:37.833Z","0.9.1-rc.1":"2021-12-16T09:06:11.380Z","0.9.1-rc.2":"2021-12-17T09:57:01.297Z","0.9.1-rc.3":"2022-01-13T18:31:02.693Z","0.9.1-rc.4":"2022-01-20T14:26:17.040Z","0.9.1-rc.5":"2022-01-21T15:45:51.618Z","0.9.1-7fe0da57f.0":"2022-01-26T12:13:36.453Z","0.9.1-5439a0e.0":"2022-01-26T13:07:18.310Z","0.9.1-a6b201af.0":"2022-01-27T15:37:12.011Z","0.9.1-fbe14923.0":"2022-01-27T18:17:11.122Z","0.9.1-6cb3a87e.0":"2022-01-27T19:12:20.562Z","0.10.1-2afef2eb.0":"2022-01-27T20:08:41.252Z","0.10.1-3a5d61d4.0":"2022-01-27T21:33:26.138Z","0.9.1-cca6e321.0":"2022-01-27T23:03:30.914Z","0.10.0":"2022-01-27T23:17:20.679Z","0.10.1-8d260215.0":"2022-01-27T23:52:40.615Z","0.10.1-2c8ec080.0":"2022-01-28T14:56:10.642Z","0.10.1-3a74c110.0":"2022-02-04T16:16:48.810Z","0.10.1-383dc07d.0":"2022-02-04T19:56:57.239Z","0.10.1-709831f6.0":"2022-02-06T16:03:10.649Z","0.10.1":"2022-02-07T16:51:12.045Z","0.10.2-1082fce9.0":"2022-02-18T16:14:47.874Z","0.10.2-125d42ba.0":"2022-03-01T09:46:49.951Z","0.10.2-df1bd1bb.0":"2022-03-01T11:11:04.897Z","0.10.2":"2022-04-05T15:10:04.710Z","0.10.3-e90b8f13.0":"2022-04-05T16:09:52.104Z","0.10.3-8f7ce23c.0":"2022-04-20T12:40:06.277Z","0.10.3":"2022-04-26T07:01:59.282Z","0.10.4-7165bf71.0":"2022-05-16T20:07:47.108Z","0.10.4-4e93dd5d.0":"2022-05-27T13:42:57.496Z","0.10.4-919b27a8.0":"2022-05-27T16:18:28.380Z","0.11.0":"2022-05-30T19:17:13.082Z","0.11.1-ddfb899f.0":"2022-05-30T19:56:51.951Z","0.11.1-764b4adc.0":"2022-06-01T14:26:12.402Z","0.11.1-be025c89.0":"2022-06-01T14:31:22.228Z","0.11.1-87e00a69.0":"2022-06-01T14:36:02.677Z","0.11.1-70e142ac.0":"2022-06-13T16:00:25.569Z","0.11.1-7be50bd1.0":"2022-06-22T17:48:28.172Z","0.11.1":"2022-06-23T12:03:08.615Z","0.11.2-00bd3dd0.0":"2022-06-24T09:30:39.798Z","0.11.2-a05695fc.0":"2022-07-20T13:22:10.844Z","0.11.2-39dbf708.0":"2022-08-17T21:42:50.559Z","0.11.2-8f351a89.0":"2022-08-17T23:18:43.441Z","0.11.2-83f9882e.0":"2022-09-06T11:30:23.300Z","0.11.2-051da161.0":"2022-09-07T12:55:15.171Z","0.12.0":"2022-09-07T13:37:25.273Z","0.12.1-b5456882.0":"2022-09-16T09:24:06.925Z","0.12.1-7c676f63.0":"2022-09-21T19:16:16.039Z","0.12.1-2a830bf5.0":"2022-09-21T20:53:54.456Z","0.12.1-7304a0f4.0":"2022-09-21T20:54:37.993Z","0.12.1":"2022-09-21T21:54:50.154Z","0.12.2-d75e0a39.0":"2022-09-22T08:52:02.054Z","0.12.2-d1b0a8a7.0":"2022-09-22T10:41:37.791Z","0.12.2-acbc1c62.0":"2022-09-22T12:59:45.477Z","0.12.2-dfc43d4e.0":"2022-09-26T14:20:11.643Z","0.12.2-0cee4a4c.0":"2022-10-24T09:13:17.647Z","0.13.0":"2022-10-24T10:47:20.423Z","0.13.1-a77e40cc.0":"2022-10-25T07:11:15.167Z","0.13.1-58e6f468.0":"2022-10-25T08:15:33.205Z","0.13.1-6ae5eb7d.0":"2022-10-28T07:29:41.731Z","0.13.1-6be59068.0":"2022-11-17T19:47:43.635Z","0.0.1-563806f1.0":"2023-01-09T18:10:39.296Z","0.0.1-e85e5b6e.0":"2023-01-09T19:15:50.914Z","0.0.1-2a6fede5.0":"2023-01-10T09:35:34.810Z","0.13.0-5f73ecad":"2023-01-10T17:14:26.318Z","0.13.0-4b4c124c":"2023-01-11T16:05:37.973Z","0.13.0-789ee585":"2023-01-11T17:05:24.463Z","0.13.0-fa578bac":"2023-01-11T17:50:04.480Z","0.13.0-d1c3abb3":"2023-01-11T18:08:47.675Z","0.14.0":"2023-01-12T11:36:18.495Z","0.14.0-6eeb1be5":"2023-01-13T18:20:13.056Z","0.14.0-ab02e8f8":"2023-01-17T12:23:52.731Z","0.14.0-3bcabe38":"2023-01-17T15:30:22.341Z","0.14.0-b64d4af0":"2023-02-01T11:24:18.661Z","0.14.0-e64813f6":"2023-05-24T18:45:32.319Z","0.14.0-4694e806":"2023-05-25T11:31:32.276Z","0.14.0-6d95ce08":"2023-05-25T12:10:21.774Z","0.14.0-7b79c1b8":"2023-05-25T12:46:06.608Z","0.14.1":"2023-05-25T14:59:22.540Z"},"maintainers":[{"email":"alex@achingbrain.net","name":"achingbrain"},{"email":"npm-service-account+ipfs@protocol.ai","name":"npm-service-account-ipfs"}],"license":"Apache-2.0 OR MIT","readme":"> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia)\n>\n> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS)\n>\n> ⚠️ If you continue using this repo, please note that security fixes will not be provided\n\n# ipfs-core-types \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> IPFS interface definitions used by implementations for API compatibility.\n\n## Table of contents \n\n- [Install](#install)\n- [Background](#background)\n- [Usage](#usage)\n - [In JSDoc syntax](#in-jsdoc-syntax)\n - [In Typescript](#in-typescript)\n- [Validation](#validation)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i ipfs-core-types\n```\n\n## Background\n\nThe primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.\n\nIt offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the [interface-ipfs-core](https://www.npmjs.com/package/interface-ipfs-core) module to validate your implementation.\n\n```console\n$ npm install ipfs-core-types\n```\n\n## Usage\n\nInstall `ipfs-core-types` as one of the dependencies of your project and use it to ensure your implementations API compatibility:\n\n### In [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)\n\n```js\n/**\n * @implements {import('ipfs-core-types').IPFS}\n */\nclass MyImpl {\n // your implementation goes here\n}\n```\n\n### In Typescript\n\n```ts\nimport type { IPFS } from 'ipfs-core-types'\nclass MyImpl implements IPFS {\n // your implementation goes here\n}\n```\n\n## Validation\n\nIn order to validate API compatibility you can run [typescript](https://www.typescriptlang.org/) over your implementation which will point out all the API compatibilities if there are some.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-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","readmeFilename":"README.md","description":"IPFS interface definitions used by implementations for API compatibility.","homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","keywords":["API","IPFS","interface","types"],"repository":{"type":"git","url":"git+https://github.com/ipfs/js-ipfs.git"},"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"}}