⛔️ 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-client
A client library to talk to local IPFS daemons
Table of contents
Install
$ npm i ipfs-clientThis module combines the ipfs-grpc-client and ipfs-http-client modules to give you a client that is capable of bidirectional streaming in the browser as well as node.
API
The client object created by the createClient function supports the IPFS Core API, see the docs for more.
create([options])
Parameters
None
Options
An optional object which may have the following keys:
| Name | Type | Default | Description |
|---|---|---|---|
| grpc |
Multiaddr or string or URL
|
undefined |
The address of a ipfs-grpc-server to connect to |
| http |
Multiaddr or string or URL
|
undefined |
The address of a ipfs-http-server to connect to |
| agent | http.Agent | undefined |
A http.Agent used to control HTTP client behaviour (node.js only) |
Returns
| Type | Description |
|---|---|
object |
An instance of the client |
Example
import { create } from 'ipfs-client'
const client = create({
grpc: '/ipv4/127.0.0.1/tcp/5003/ws',
http: '/ipv4/127.0.0.1/tcp/5002/http'
})
const id = await client.id()License
Licensed under either of
- Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
- MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)
Contribute
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.
