Security News
vlt Debuts New JavaScript Package Manager and Serverless Registry at NodeConf EU
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.
ipfs-core-types
Advanced tools
IPFS interface definitions used by implementations for API compatibility.
⛔️ DEPRECATED: js-IPFS has been superseded by Helia
📚 Learn more about this deprecation or how to migrate
⚠️ If you continue using this repo, please note that security fixes will not be provided
IPFS interface definitions used by implementations for API compatibility.
$ npm i ipfs-core-types
The 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.
It 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 module to validate your implementation.
$ npm install ipfs-core-types
Install ipfs-core-types
as one of the dependencies of your project and use it to ensure your implementations API compatibility:
/**
* @implements {import('ipfs-core-types').IPFS}
*/
class MyImpl {
// your implementation goes here
}
import type { IPFS } from 'ipfs-core-types'
class MyImpl implements IPFS {
// your implementation goes here
}
In order to validate API compatibility you can run typescript over your implementation which will point out all the API compatibilities if there are some.
Licensed under either of
Contributions welcome! Please check out the issues.
Also see our contributing document for more information on how we work, and about contributing in general.
Please be aware that all interactions related to this repo are subject to the IPFS Code of Conduct.
Unless 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.
FAQs
IPFS interface definitions used by implementations for API compatibility.
We found that ipfs-core-types demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.
Security News
Research
The Socket Research Team uncovered a malicious Python package typosquatting the popular 'fabric' SSH library, silently exfiltrating AWS credentials from unsuspecting developers.
Security News
At its inaugural meeting, the JSR Working Group outlined plans for an open governance model and a roadmap to enhance JavaScript package management.