# Interface IpfsNode

interface IpfsNode {
add: ((content: string | File, options?: AbortOptions) => Promise<string>);
cat: ((cid: string, options?: CatOptions) => AsyncIterable<Uint8Array>);
config: IpfsNodePrperties;
connectPeer: ((address: string) => Promise<boolean>);
getPeers: (() => Promise<string[]>);
info: (() => Promise<IpfsNodeInfo>);
init: ((options?: InitOptions) => Promise<void>);
isStarted: boolean;
ls: (() => AsyncIterable<LsResult>);
nodeType: IpfsNodeType;
pin: ((cid: string, options?: AbortOptions) => Promise<string>);
start: (() => Promise<void>);
stat: ((cid: string, options?: AbortOptions) => Promise<IpfsFileStats>);
stop: (() => Promise<void>);
}

#### Hierarchy (view full)

- IpfsNode
  - CybIpfsNode

#### Implemented by

- default
- default
- default

- Defined in work/deeplinks/deeplinks/imports/cyber/ipfs/ipfs.ts:124

#####
Index

### Properties

add
cat
config
connectPeer
getPeers
info
init
isStarted
ls
nodeType
pin
start
stat
stop

##
Properties

### add

add: ((content: string | File, options?: AbortOptions) => Promise<string>)

- Defined in work/deeplinks/deeplinks/imports/cyber/ipfs/ipfs.ts:133

### cat

cat: ((cid: string, options?: CatOptions) => AsyncIterable<Uint8Array>)

- Defined in work/deeplinks/deeplinks/imports/cyber/ipfs/ipfs.ts:131

### `Readonly` config

config: IpfsNodePrperties

- Defined in work/deeplinks/deeplinks/imports/cyber/ipfs/ipfs.ts:126

### connectPeer

connectPeer: ((address: string) => Promise<boolean>)

- Defined in work/deeplinks/deeplinks/imports/cyber/ipfs/ipfs.ts:137

### getPeers

getPeers: (() => Promise<string[]>)

- Defined in work/deeplinks/deeplinks/imports/cyber/ipfs/ipfs.ts:136

### info

info: (() => Promise<IpfsNodeInfo>)

- Defined in work/deeplinks/deeplinks/imports/cyber/ipfs/ipfs.ts:138

### init

init: ((options?: InitOptions) => Promise<void>)

- Defined in work/deeplinks/deeplinks/imports/cyber/ipfs/ipfs.ts:128

### `Readonly` isStarted

isStarted: boolean

- Defined in work/deeplinks/deeplinks/imports/cyber/ipfs/ipfs.ts:127

### ls

ls: (() => AsyncIterable<LsResult>)

- Defined in work/deeplinks/deeplinks/imports/cyber/ipfs/ipfs.ts:135

### `Readonly` nodeType

nodeType: IpfsNodeType

- Defined in work/deeplinks/deeplinks/imports/cyber/ipfs/ipfs.ts:125

### pin

pin: ((cid: string, options?: AbortOptions) => Promise<string>)

- Defined in work/deeplinks/deeplinks/imports/cyber/ipfs/ipfs.ts:134

### start

start: (() => Promise<void>)

- Defined in work/deeplinks/deeplinks/imports/cyber/ipfs/ipfs.ts:130

### stat

stat: ((cid: string, options?: AbortOptions) => Promise<IpfsFileStats>)

- Defined in work/deeplinks/deeplinks/imports/cyber/ipfs/ipfs.ts:132

### stop

stop: (() => Promise<void>)

- Defined in work/deeplinks/deeplinks/imports/cyber/ipfs/ipfs.ts:129