Preparing search index...
The search index is not available
@deep-foundation/deeplinks
@deep-foundation/deeplinks
cyber/ipfs/node/impl/kubo
default
Class default
Implements
IpfsNode
Index
Constructors
constructor
Properties
_config
_is
Started
node?
node
Type
Accessors
config
is
Started
Methods
add
cat
connect
Peer
get
Peers
info
init
init
Config
ls
pin
start
stat
stop
Constructors
constructor
new default
(
)
:
default
Returns
default
Properties
Private
_config
_config
:
IpfsNodePrperties
= {}
Private
_is
Started
_is
Started
:
boolean
= false
Private
Optional
node
node
?:
IPFSHTTPClient
Readonly
node
Type
node
Type
:
IpfsNodeType
= 'external'
Accessors
config
get
config
(
)
:
IpfsNodePrperties
Returns
IpfsNodePrperties
is
Started
get
isStarted
(
)
:
boolean
Returns
boolean
Methods
add
add
(
content
,
options
?
)
:
Promise
<
string
>
Parameters
content
:
string
|
File
options
:
AbortOptions
= {}
Returns
Promise
<
string
>
cat
cat
(
cid
,
options
?
)
:
AsyncIterable
<
Uint8Array
>
Parameters
cid
:
string
options
:
CatOptions
= {}
Returns
AsyncIterable
<
Uint8Array
>
connect
Peer
connect
Peer
(
address
)
:
Promise
<
boolean
>
Parameters
address
:
string
Returns
Promise
<
boolean
>
get
Peers
get
Peers
(
)
:
Promise
<
string
[]
>
Returns
Promise
<
string
[]
>
info
info
(
)
:
Promise
<
{
agentVersion
:
string
;
id
:
string
;
repoSize
:
bigint
;
}
>
Returns
Promise
<
{
agentVersion
:
string
;
id
:
string
;
repoSize
:
bigint
;
}
>
init
init
(
options
?
)
:
Promise
<
void
>
Parameters
Optional
options
:
InitOptions
Returns
Promise
<
void
>
Private
init
Config
init
Config
(
)
:
Promise
<
{
gatewayUrl
:
string
;
}
>
Returns
Promise
<
{
gatewayUrl
:
string
;
}
>
ls
ls
(
)
:
AsyncIterable
<
LsResult
>
Returns
AsyncIterable
<
LsResult
>
pin
pin
(
cid
,
options
?
)
:
Promise
<
string
>
Parameters
cid
:
string
options
:
AbortOptions
= {}
Returns
Promise
<
string
>
start
start
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
stat
stat
(
cid
,
options
?
)
:
Promise
<
IpfsFileStats
>
Parameters
cid
:
string
options
:
AbortOptions
= {}
Returns
Promise
<
IpfsFileStats
>
stop
stop
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
On This Page
constructor
_config
_is
Started
node
node
Type
config
is
Started
add
cat
connect
Peer
get
Peers
info
init
init
Config
ls
pin
start
stat
stop
@deep-foundation/deeplinks
Loading...