Class HypersyncClient

Index

Constructors

Methods

collect collectEvents collectParquet get getChainId getEvents getHeight stream streamEvents new

Constructors

constructor

new HypersyncClient(): HypersyncClient
Returns HypersyncClient

Methods

collect

collect(query, config): Promise<QueryResponse>
Parameters
- query: Query
- config: StreamConfig
Returns Promise<QueryResponse>
- Defined in index.d.ts:572

collectEvents

collectEvents(query, config): Promise<EventResponse>
Parameters
- query: Query
- config: StreamConfig
Returns Promise<EventResponse>
- Defined in index.d.ts:573

collectParquet

collectParquet(path, query, config): Promise<void>
Parameters
- path: string
- query: Query
- config: StreamConfig
Returns Promise<void>
- Defined in index.d.ts:574

get

get(query): Promise<QueryResponse>
Parameters
- query: Query
Returns Promise<QueryResponse>
- Defined in index.d.ts:575

getChainId

getChainId(): Promise<number>
Get the chain_id of the source hypersync instance

Returns Promise<number>
- Defined in index.d.ts:571

getEvents

getEvents(query): Promise<EventResponse>
Parameters
- query: Query
Returns Promise<EventResponse>
- Defined in index.d.ts:576

getHeight

getHeight(): Promise<number>
Get the height of the source hypersync instance

Returns Promise<number>
- Defined in index.d.ts:569

stream

stream(query, config): Promise<QueryResponseStream>
Parameters
- query: Query
- config: StreamConfig
Returns Promise<QueryResponseStream>
- Defined in index.d.ts:577

streamEvents

streamEvents(query, config): Promise<EventStream>
Parameters
- query: Query
- config: StreamConfig
Returns Promise<EventStream>
- Defined in index.d.ts:578

`Static` new

new(cfg?): HypersyncClient
Create a new client with given config
Parameters
- Optional cfg: ClientConfig
Returns HypersyncClient
- Defined in index.d.ts:567