Class MosaicHttp

Mosaic http repository.

since: 1.0

Hierarchy

Http
- MosaicHttp

Implements

MosaicRepository

Index

Constructors

constructor

Properties

fetchApi
url

Methods

Constructors

constructor

new MosaicHttp(url: string, networkType?: MAIN_NET | TEST_NET | MIJIN | MIJIN_TEST | PRIVATE | PRIVATE_TEST | Observable<NetworkType>, fetchApi?: any): MosaicHttp

Overrides Http.constructor
- Defined in infrastructure/MosaicHttp.ts:50
Constructor

Parameters
- url: string
  
  Base catapult-rest url
- Optional networkType: MAIN_NET | TEST_NET | MIJIN | MIJIN_TEST | PRIVATE | PRIVATE_TEST | Observable<NetworkType>
  
  the network type.
- Optional fetchApi: any
  
  fetch function to be used when performing rest requests.
Returns MosaicHttp

Properties

Protected Optional Readonly fetchApi

fetchApi: any

Protected Readonly url

url: string

Methods

Protected call

call<D, M>(remoteCall: Promise<D>, mapper: (value: D) => M): Observable<M>

Inherited from Http.call
- Defined in infrastructure/Http.ts:96
This method knows how to call, convert and handle exception when doing remote http operations.

Type parameters
- D
- M
Parameters
- remoteCall: Promise<D>
  
  the remote call
- mapper: (value: D) => M
  
  the mapper from dto to the model object.
  - - (value: D): M
    - Parameters
      - value: D
      Returns M
Returns Observable<M>

config

config(): Configuration

Inherited from Http.config
- Defined in infrastructure/Http.ts:86
Returns Configuration

createNetworkTypeObservable

createNetworkTypeObservable(networkType?: MAIN_NET | TEST_NET | MIJIN | MIJIN_TEST | PRIVATE | PRIVATE_TEST | Observable<NetworkType>): Observable<NetworkType>

Inherited from Http.createNetworkTypeObservable
- Defined in infrastructure/Http.ts:76
Parameters
- Optional networkType: MAIN_NET | TEST_NET | MIJIN | MIJIN_TEST | PRIVATE | PRIVATE_TEST | Observable<NetworkType>
Returns Observable<NetworkType>

getMosaic

getMosaic(mosaicId: MosaicId): Observable<MosaicInfo>

Implementation of MosaicRepository.getMosaic
- Defined in infrastructure/MosaicHttp.ts:69
Gets the MosaicInfo for a given mosaicId

Parameters
- mosaicId: MosaicId
  
  Mosaic id
Returns Observable<MosaicInfo>

Observable

getMosaicMerkle

getMosaicMerkle(mosaicId: MosaicId): Observable<MerkleStateInfo>

Implementation of MosaicRepository.getMosaicMerkle
- Defined in infrastructure/MosaicHttp.ts:92
Gets a MosaicInfo merkle for a given mosaicId

Parameters
- mosaicId: MosaicId
  
  Mosaic id
Returns Observable<MerkleStateInfo>

Observable

getMosaics

getMosaics(mosaicIds: MosaicId[]): Observable<MosaicInfo[]>

Implementation of MosaicRepository.getMosaics
- Defined in infrastructure/MosaicHttp.ts:78
Gets MosaicInfo for different mosaicIds.

Parameters
- mosaicIds: MosaicId[]
  
  Array of mosaic ids
Returns Observable<MosaicInfo[]>

Observable<MosaicInfo[]>

search

search(criteria: MosaicSearchCriteria): Observable<Page<MosaicInfo>>

Implementation of MosaicRepository.search
- Defined in infrastructure/MosaicHttp.ts:102
Gets an array of mosaics.

summary

Get mosaics created for given address

Parameters
- criteria: MosaicSearchCriteria
  
  Mosaic search criteria
Returns Observable<Page<MosaicInfo>>

streamer

streamer(): MosaicPaginationStreamer

Implementation of MosaicRepository.streamer
- Defined in infrastructure/MosaicHttp.ts:119
It creates a streamer for this searcher.

Returns MosaicPaginationStreamer

Static errorHandling

errorHandling(error: any): Promise<Error>

Inherited from Http.errorHandling
- Defined in infrastructure/Http.ts:35
Parameters
- error: any
Returns Promise<Error>

Static toMosaicInfo

toMosaicInfo(mosaicInfo: MosaicInfoDTO): MosaicInfo

- Defined in infrastructure/MosaicHttp.ts:129
Maps MosaicInfoDTO to MosaicInfo

Parameters
- mosaicInfo: MosaicInfoDTO
  
  the dto object.
Returns MosaicInfo

the model object

Generated using TypeDoc