Class ReplayApi

Hierarchy (View Summary)

ApiGroup
- ReplayApi

Index

Constructors

Properties

client eip712 listeners

Methods

emit get list off on once removeAllListeners write

Constructors

constructor

new ReplayApi(config: ApiConfig): ReplayApi
Parameters
- config: ApiConfig
Returns ReplayApi
Overrides ApiGroup.constructor
- Defined in Replay/index.ts:57

Properties

`Protected`client

client: ApiClient

`Protected`eip712

eip712: EIP712Helper

`Protected`listeners

listeners: {} = {}

Methods

`Protected`emit

emit<T extends never>(event: T, data: {}[T]): void
Dispatch an event to all listeners
Type Parameters
- T extends never
Parameters
- event: T
- data: {}[T]
Returns void
Inherited from ApiGroup.emit
- Defined in lib/TypedEventEmitter.ts:69

get

get(
runId: string,
options?: ReplayRequestOptions,
): Promise<GetReplayRecordResult>
GET /v1/replay/records/:id — full RunRecord for the viewer detail.
Parameters
- runId: string
- options: ReplayRequestOptions = {}
Returns Promise<GetReplayRecordResult>
- Defined in Replay/index.ts:113

list

list(options?: ListReplayRecordsOptions): Promise<ListReplayRecordsResult>
GET /v1/replay/records — paginated summary view for the caller's own records. limit caps results (api defaults apply when omitted).
Parameters
- options: ListReplayRecordsOptions = {}
Returns Promise<ListReplayRecordsResult>
- Defined in Replay/index.ts:96

off

off<T extends never>(event: T, listener: (data: {}[T]) => void): void
Remove an event listener
Type Parameters
- T extends never
Parameters
- event: T
- listener: (data: {}[T]) => void
Returns void
Inherited from ApiGroup.off
- Defined in lib/TypedEventEmitter.ts:45

on

on<T extends never>(event: T, listener: (data: {}[T]) => void): () => void
Add an event listener, returns a function that can be called to remove the listener
Type Parameters
- T extends never
Parameters
- event: T
- listener: (data: {}[T]) => void
Returns () => void
Inherited from ApiGroup.on
- Defined in lib/TypedEventEmitter.ts:17

once

once<T extends never>(event: T, listener: (data: {}[T]) => void): () => void
Add an event listener that will be called only once
Type Parameters
- T extends never
Parameters
- event: T
- listener: (data: {}[T]) => void
Returns () => void
Inherited from ApiGroup.once
- Defined in lib/TypedEventEmitter.ts:32

removeAllListeners

removeAllListeners<T extends never>(event?: T): void
Remove all event listeners, optionally for a specific event
Type Parameters
- T extends never
Parameters
- Optionalevent: T
Returns void
Inherited from ApiGroup.removeAllListeners
- Defined in lib/TypedEventEmitter.ts:56

write

write(
record: RunRecord,
options?: ReplayRequestOptions,
): Promise<ReplayWriteResult>
POST /v1/replay/records — ingest one RunRecord. The api re-runs the redaction pass server-side as defense-in-depth, so the returned redacted flag reflects what was actually stored.
Parameters
- record: RunRecord
- options: ReplayRequestOptions = {}
Returns Promise<ReplayWriteResult>
- Defined in Replay/index.ts:66