BlockApi | NULS JS - API Reference

Hierarchy

APIServerClass
- BlockApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BlockApi(conf?: IAPIConfig): BlockApi

Overrides APIServerClass.constructor
- Defined in packages/core/api/block.ts:22
Parameters
- Default value conf: IAPIConfig = config.nuls.api.explorer
Returns BlockApi

Properties

api

api: AxiosInstance

Optional resources

resources: Record<string, string>

url

url: string

Methods

block

block(height: number): Promise<ApiBlock>
block(hash: string): Promise<ApiBlock>

- Defined in packages/core/api/block.ts:44
Parameters
- height: number
Returns Promise<ApiBlock>
- Defined in packages/core/api/block.ts:45
Parameters
- hash: string
Returns Promise<ApiBlock>

Protected getResource

getResource(name: string, ...args: string[]): string

Inherited from APIServerClass.getResource
- Defined in packages/core/api/APIServer.ts:24
Parameters
- name: string
- Rest ...args: string[]
Returns string

Protected handleErrors

handleErrors(e: AxiosError): AxiosError

Inherited from APIServerClass.handleErrors
- Defined in packages/core/api/APIServer.ts:42
Parameters
- e: AxiosError
Returns AxiosError

lastHeight

lastHeight(): Promise<number>

- Defined in packages/core/api/block.ts:28
Returns Promise<number>

subscribe

subscribe(height?: number): SocketEmitter

- Defined in packages/core/api/block.ts:63
Parameters
- Default value height: number = -1
Returns SocketEmitter