Class BlockApi

Hierarchy

BaseApi
- BlockApi

Index

Constructors

constructor

Properties

api

Methods

Constructors

constructor

new BlockApi(api: DCoreApi): BlockApi

Overrides BaseApi.constructor
- Defined in api/rx/BlockApi.ts:11
Parameters
- api: DCoreApi
Returns BlockApi

Properties

Protected api

Methods

get

get(blockNum: number): Observable<SignedBlock>

- Defined in api/rx/BlockApi.ts:24
Retrieve a full, signed block.

Parameters
- blockNum: number
  
  height of the block to be returned
Returns Observable<SignedBlock>

the referenced block, or ObjectNotFoundError if no matching block was found

getHeadTime

getHeadTime(): Observable<Moment>

- Defined in api/rx/BlockApi.ts:44
Query the last local block.

Returns Observable<Moment>

the block time

getHeader

getHeader(blockNum: number): Observable<BlockHeader>

- Defined in api/rx/BlockApi.ts:35
Retrieve a block header.

Parameters
- blockNum: number
  
  height of the block whose header should be returned
Returns Observable<BlockHeader>

header of the referenced block, or ObjectNotFoundError if no matching block was found

Protected request

request<T>(request: BaseRequest<T> | BaseRequest<T> & WithCallback): Observable<T>

Inherited from BaseApi.request
- Defined in api/rx/BaseApi.ts:12
Type parameters
- T
Parameters
- request: BaseRequest<T> | BaseRequest<T> & WithCallback
Returns Observable<T>

Generated using TypeDoc