Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IpfsConnection

Class represents the ipfs connection

Hierarchy

  • IpfsConnection

Index

Constructors

Properties

Methods

Constructors

constructor

  • new IpfsConnection(host: string, port?: undefined | string, options?: undefined | object): IpfsConnection

  • Constructor

    Parameters

    • host: string

      the ifps host

    • Optional port: undefined | string

      the ipfs port

    • Optional options: undefined | object

      the protocol options e.g. { protocol: 'http' }

    Returns IpfsConnection

Properties

Private API

API: any

host

host: string

the ifps host

Optional options

options: undefined | object

the protocol options e.g. { protocol: 'http' }

Optional port

port: undefined | string

the ipfs port

Methods

getAPI

  • getAPI(): any

  • Return instance of ipfs api

    Returns any

validate

  • validate(): void

  • Validates the ipfs connection

    Returns void

Generated using TypeDoc