{"bugs":{"url":"https://github.com/ipfs/js-ipfs/issues"},"dist":{"shasum":"df544d4afd6aca5189aad4e9fb937af1296982b9","tarball":"https://registry.npmjs.org/ipfs-core-types/-/ipfs-core-types-0.14.0-e64813f6.tgz","fileCount":134,"integrity":"sha512-6pObdzbrCDBHRz5dwGBC1j5wTSF14YzCRdqzGSCqo6ZKZboLn5UPGhflXYtCUNbnGaAGLUmcLo6bHgsciVv0Sg==","signatures":[{"sig":"MEUCIQDu4EIHmRQhnHs91ccz1XYkgEM2n1TBEorG3NIhXMf7uQIgb09e4pHSJs0c0L3hsusRB/bpcCpDmtJAjs9DP44o1lE=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":201691},"name":"ipfs-core-types","type":"module","types":"./dist/src/index.d.ts","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","engines":{"npm":">=7.0.0","node":">=16.0.0"},"exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"gitHead":"e64813f6fdc681328da7cb893c93e1f4f70bfc99","license":"Apache-2.0 OR MIT","scripts":{"lint":"aegir lint","build":"aegir build","clean":"aegir clean"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme","keywords":["API","IPFS","interface","types"],"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details","repository":{"url":"git+https://github.com/ipfs/js-ipfs.git","type":"git"},"_npmVersion":"8.19.4","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"},{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"}],"_nodeVersion":"18.16.0","dependencies":{"@types/node":"^18.0.0","ipfs-unixfs":"^9.0.0","@ipld/dag-pb":"^4.0.0","multiformats":"^11.0.0","interface-datastore":"^7.0.0","@multiformats/multiaddr":"^11.1.5","@libp2p/interface-pubsub":"^3.0.0","@libp2p/interface-peer-id":"^2.0.0","@libp2p/interface-keychain":"^2.0.0","@libp2p/interface-peer-info":"^1.0.2"},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"aegir":"^37.11.0"},"_npmOperationalInternal":{"tmp":"tmp/ipfs-core-types_0.14.0-e64813f6_1684953932094_0.5566280758304987","host":"s3://npm-registry-packages"},"_id":"ipfs-core-types@0.14.0-e64813f6","version":"0.14.0-e64813f6"}