Class HashLockHttp

Hashlock http repository.

since: 1.0

Hierarchy

Http
- HashLockHttp

Implements

HashLockRepository

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new HashLockHttp(url: string, fetchApi?: any): HashLockHttp

Overrides Http.constructor
- Defined in infrastructure/HashLockHttp.ts:47
Constructor

Parameters
- url: string
  
  Base catapult-rest url
- Optional fetchApi: any
  
  fetch function to be used when performing rest requests.
Returns HashLockHttp

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?: NetworkType | Observable<NetworkType>): Observable<NetworkType>

Inherited from Http.createNetworkTypeObservable
- Defined in infrastructure/Http.ts:76
Parameters
- Optional networkType: NetworkType | Observable<NetworkType>
Returns Observable<NetworkType>

getHashLock

getHashLock(hash: string): Observable<HashLockInfo>

Implementation of HashLockRepository.getHashLock
- Defined in infrastructure/HashLockHttp.ts:57
Get hash lock info for an account.

Parameters
- hash: string
  
  Hashlock hash
Returns Observable<HashLockInfo>
Observable

getHashLockMerkle

getHashLockMerkle(hash: string): Observable<MerkleStateInfo>

Implementation of HashLockRepository.getHashLockMerkle
- Defined in infrastructure/HashLockHttp.ts:65
Get secret lock merkle info of the given id.

Parameters
- hash: string
  
  HashLockInfo hash id
Returns Observable<MerkleStateInfo>
Observable

search

search(criteria: HashLockSearchCriteria): Observable<Page<HashLockInfo>>

Implementation of HashLockRepository.search
- Defined in infrastructure/HashLockHttp.ts:74
Gets an array of HashLockInfo.

Parameters
- criteria: HashLockSearchCriteria
  
  HashLock search criteria
Returns Observable<Page<HashLockInfo>>
Observable<Page>

streamer

streamer(): HashLockPaginationStreamer

Implementation of HashLockRepository.streamer
- Defined in infrastructure/HashLockHttp.ts:87
It creates a streamer for this searcher.

Returns HashLockPaginationStreamer

Static errorHandling

errorHandling(error: any): Promise<Error>

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

Generated using TypeDoc