Interface SubscribeResponse

Response expected from a SubscribeRequest.

interface SubscribeResponse {
    api_version?: number;
    forwarded?: boolean;
    id: string | number;
    result: Record<string, never> | LedgerStreamResponse | BooksSnapshot;
    status?: string;
    type: string;
    warning?: "load";
    warnings?: ResponseWarning[];
}

Hierarchy (View Summary)

BaseResponse
- SubscribeResponse

Index

Properties

api_version? forwarded? id result status? type warning? warnings?

Properties

`Optional`api_version

api_version?: number

`Optional`forwarded

forwarded?: boolean

id

id: string | number

result

result: Record<string, never> | LedgerStreamResponse | BooksSnapshot

`Optional`status

status?: string

type

type: string

`Optional`warning

warning?: "load"

`Optional`warnings

warnings?: ResponseWarning[]