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

Hierarchy (view full)

Implemented by

Properties

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

Type declaration

    • (content, options?): Promise<string>
    • Parameters

      Returns Promise<string>

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

Type declaration

    • (cid, options?): AsyncIterable<Uint8Array>
    • Parameters

      Returns AsyncIterable<Uint8Array>

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

Type declaration

    • (address): Promise<boolean>
    • Parameters

      • address: string

      Returns Promise<boolean>

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

Type declaration

    • (): Promise<string[]>
    • Returns Promise<string[]>

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

Type declaration

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

Type declaration

    • (options?): Promise<void>
    • Parameters

      Returns Promise<void>

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

Type declaration

    • (): AsyncIterable<LsResult>
    • Returns AsyncIterable<LsResult>

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

Type declaration

    • (cid, options?): Promise<string>
    • Parameters

      Returns Promise<string>

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

Type declaration

    • (): Promise<void>
    • Returns Promise<void>

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

Type declaration

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

Type declaration

    • (): Promise<void>
    • Returns Promise<void>