Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UploadParameterData

Class represents the upload parameter data

Hierarchy

  • UploadParameterData

Index

Constructors

constructor

  • new UploadParameterData(byteStreams: any, path?: undefined | string, options?: undefined | object, description?: undefined | string, contentType?: undefined | string, metadata?: Map<string, any>, name?: undefined | string): UploadParameterData
  • Parameters

    • byteStreams: any
    • Optional path: undefined | string
    • Optional options: undefined | object
    • Optional description: undefined | string
    • Optional contentType: undefined | string
    • Optional metadata: Map<string, any>
    • Optional name: undefined | string

    Returns UploadParameterData

Properties

byteStreams

byteStreams: any

The content in stream

Optional contentType

contentType: undefined | string

The content type

Optional description

description: undefined | string

The content description

Optional metadata

metadata: Map<string, any>

The content metadata

Optional name

name: undefined | string

The content name

Optional options

options: undefined | object

The ipfs callback options e.g { progress: handle}

Optional path

path: undefined | string

The data path

Methods

validate

  • validate(): void
  • Validates the upload parameter data

    Returns void

Generated using TypeDoc