Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "ipfs"

Index

Functions

connect

  • connect(multiaddr: string): Promise<boolean>
  • Open a new direct connection to a peer using an IPFS multiaddr

    Textile.ipfs.connect(multiaddr);

    Parameters

    • multiaddr: string

    Returns Promise<boolean>

dataAtPath

  • dataAtPath(path: string): Promise<object>
  • Get raw file data by IPFS path. See cat method in IPFS.

    Textile.ipfs.dataAtPath(path);

    Parameters

    • path: string

    Returns Promise<object>

peerId

  • peerId(): Promise<string>
  • Get node's IPFS peerId.

    Textile.ipfs.peerId();

    Returns Promise<string>

pubsubPub

  • pubsubPub(topic: string, data: string | object): Promise<string>
  • Publishes a message to a given pubsub topic

    Textile.ipfs.pubsubPub(topic, data);

    Parameters

    • topic: string
    • data: string | object

    Returns Promise<string>

pubsubSub

  • pubsubSub(topic: string): Promise<object>
  • Subscribes to messages on a given topic

    Textile.ipfs.pubsubSub(topic);

    Parameters

    • topic: string

    Returns Promise<object>