Skip to content
This repository was archived by the owner on Jun 30, 2023. It is now read-only.

Commit df525a1

Browse files
author
Alan Shaw
committed
docs: add missing but planned API methods
1 parent 4bc9318 commit df525a1

File tree

2 files changed

+144
-4
lines changed

2 files changed

+144
-4
lines changed

API.md

+72-2
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,92 @@
22

33
* [IpfsHttpClientLite](#ipfshttpclientlite)
44
* [add](#add)
5-
* [addPullStream](#addpullstream)
5+
* addFromFs
66
* [addFromStream](#addfromstream) TODO: add docs
77
* [addFromURL](#addfromurl) TODO: add docs
8+
* [addPullStream](#addpullstream)
89
* [bitswap.stat](#bitswapstat) TODO: add docs
910
* [bitswap.wantlist](#bitswapwantlist) TODO: add docs
1011
* [block.get](#blockget)
1112
* [block.put](#blockput)
1213
* [block.stat](#blockstat)
14+
* bootstrap.add
15+
* bootstrap.list
16+
* bootstrap.rm
1317
* [cat](#cat)
1418
* [catPullStream](#catpullstream) TODO: add docs
19+
* config.get
20+
* config.replace
21+
* config.set
22+
* dag.get
23+
* dag.put
24+
* dag.tree
25+
* dht.findPeer
26+
* dht.findProvs
27+
* dht.get
28+
* dht.provide
29+
* dht.put
30+
* dht.query
31+
* dns
32+
* files.cp
33+
* files.flush
34+
* files.ls
35+
* files.lsPullStream
36+
* files.mkdir
37+
* files.mv
38+
* files.read
39+
* files.readPullStream
40+
* files.rm
41+
* files.stat
42+
* files.write
43+
* [id](#id) TODO: add docs
44+
* key.export
45+
* key.gen
46+
* key.import
47+
* key.list
48+
* key.rename
49+
* key.rm
1550
* [ls](#ls) TODO: add docs
1651
* [lsPullStream](#lspullstream) TODO: add docs
17-
* [id](#id) TODO: add docs
52+
* name.pubsub.cancel
53+
* name.pubsub.state
54+
* name.pubsub.subs
55+
* object.data
56+
* object.get
57+
* object.links
58+
* object.new
59+
* object.patch.addLink
60+
* object.patch.appendData
61+
* object.patch.rmLink
62+
* object.patch.setData
63+
* object.put
64+
* pin.add
65+
* pin.ls
66+
* pin.rm
1867
* [ping](#ping) TODO: add docs
1968
* [pingPullStream](#pingpullstream) TODO: add docs
69+
* pubsub.publish
70+
* pubsub.ls
71+
* pubsub.peers
72+
* pubsub.subscribe
73+
* pubsub.unsubscribe
74+
* refs
75+
* refsPullStream
76+
* refs.local
77+
* refs.localPullStream
78+
* repo.gc
79+
* repo.stat
80+
* repo.version
81+
* resolve
82+
* shutdown
83+
* stats.bitswap
84+
* stats.bw
85+
* stats.bwPullStream
86+
* stats.repo
87+
* swarm.addrs
2088
* [swarm.connect](#swarmconnect) TODO: add docs
89+
* swarm.disconnect
90+
* swarm.localAddrs
2191
* [swarm.peers](#swarmpeers) TODO: add docs
2292
* [version](#version) TODO: add docs
2393

README.md

+72-2
Original file line numberDiff line numberDiff line change
@@ -140,22 +140,92 @@ This module is in heavy development, not all API methods are available (or docum
140140

141141
* [IpfsHttpClientLite](./API.md#ipfshttpclientlite)
142142
* [add](./API.md#add)
143-
* [addPullStream](./API.md#addpullstream)
143+
* addFromFs
144144
* [addFromStream](./API.md#addfromstream) TODO: add docs
145145
* [addFromURL](./API.md#addfromurl) TODO: add docs
146+
* [addPullStream](./API.md#addpullstream)
146147
* [bitswap.stat](./API.md#bitswapstat) TODO: add docs
147148
* [bitswap.wantlist](./API.md#bitswapwantlist) TODO: add docs
148149
* [block.get](./API.md#blockget)
149150
* [block.put](./API.md#blockput)
150151
* [block.stat](./API.md#blockstat)
152+
* bootstrap.add
153+
* bootstrap.list
154+
* bootstrap.rm
151155
* [cat](./API.md#cat)
152156
* [catPullStream](./API.md#catpullstream) TODO: add docs
157+
* config.get
158+
* config.replace
159+
* config.set
160+
* dag.get
161+
* dag.put
162+
* dag.tree
163+
* dht.findPeer
164+
* dht.findProvs
165+
* dht.get
166+
* dht.provide
167+
* dht.put
168+
* dht.query
169+
* dns
170+
* files.cp
171+
* files.flush
172+
* files.ls
173+
* files.lsPullStream
174+
* files.mkdir
175+
* files.mv
176+
* files.read
177+
* files.readPullStream
178+
* files.rm
179+
* files.stat
180+
* files.write
181+
* [id](./API.md#id) TODO: add docs
182+
* key.export
183+
* key.gen
184+
* key.import
185+
* key.list
186+
* key.rename
187+
* key.rm
153188
* [ls](./API.md#ls) TODO: add docs
154189
* [lsPullStream](./API.md#lspullstream) TODO: add docs
155-
* [id](./API.md#id) TODO: add docs
190+
* name.pubsub.cancel
191+
* name.pubsub.state
192+
* name.pubsub.subs
193+
* object.data
194+
* object.get
195+
* object.links
196+
* object.new
197+
* object.patch.addLink
198+
* object.patch.appendData
199+
* object.patch.rmLink
200+
* object.patch.setData
201+
* object.put
202+
* pin.add
203+
* pin.ls
204+
* pin.rm
156205
* [ping](./API.md#ping) TODO: add docs
157206
* [pingPullStream](./API.md#pingpullstream) TODO: add docs
207+
* pubsub.publish
208+
* pubsub.ls
209+
* pubsub.peers
210+
* pubsub.subscribe
211+
* pubsub.unsubscribe
212+
* refs
213+
* refsPullStream
214+
* refs.local
215+
* refs.localPullStream
216+
* repo.gc
217+
* repo.stat
218+
* repo.version
219+
* resolve
220+
* shutdown
221+
* stats.bitswap
222+
* stats.bw
223+
* stats.bwPullStream
224+
* stats.repo
225+
* swarm.addrs
158226
* [swarm.connect](./API.md#swarmconnect) TODO: add docs
227+
* swarm.disconnect
228+
* swarm.localAddrs
159229
* [swarm.peers](./API.md#swarmpeers) TODO: add docs
160230
* [version](./API.md#version) TODO: add docs
161231

0 commit comments

Comments
 (0)