{"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"dist":{"shasum":"86a331915b348da359d3bb905c7b42e2740d2744","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.3.2-rc.32.tgz","fileCount":29,"integrity":"sha512-X84DjpIBVOvdp6xInOpEbN56FOztagP4n8fKmYMDAc2L3DzhItZBGPWyILE0nAw2MEk5uqKESVN38lFyE0+fOQ==","signatures":[{"sig":"MEUCIQD+sDABD4ctvJezKIxI1z/ln9OhZRYqvD9R8cIlZAHA/wIgWG3pTfIQw+/w49zvAkMy7BPjvGmxaDty+R9o3M69oGc=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"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"},"name":"ipfs-core-types","types":"src/index.d.ts","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","gitHead":"3923133de800ffd5a5550da86b7bca254206104e","license":"(Apache-2.0 OR MIT)","scripts":{"lint":"aegir lint","test":"aegir ts -p check"},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core#readme","keywords":["IPFS","types","interface","API"],"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details","repository":{"url":"git+https://github.com/ipfs/js-ipfs.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v14.16.1+x64 (linux)","description":"IPFS interface definitions used by implementations for API compatibility.","directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_nodeVersion":"14.16.1","contributors":[{"name":"Irakli Gozalishvili","email":"dev@gozala.io"}],"dependencies":{"cids":"^1.1.6","multiaddr":"^9.0.1","multibase":"^4.0.2","ipld-block":"^0.11.1","interface-datastore":"^4.0.0"},"eslintConfig":{"extends":"ipfs"},"_hasShrinkwrap":false,"leadMaintainer":"Alex Potsides ","readmeFilename":"README.md","devDependencies":{"aegir":"^33.0.0"},"_npmOperationalInternal":{"tmp":"tmp/ipfs-core-types_0.3.2-rc.32_1620388745434_0.027815884091494825","host":"s3://npm-registry-packages"},"_id":"ipfs-core-types@0.3.2-rc.32","version":"0.3.2-rc.32"}