Interface LedgerEntryResponse<T>

Response expected from a LedgerEntryRequest.

interface LedgerEntryResponse<T = LedgerEntry.LedgerEntry> {
    api_version?: number;
    forwarded?: boolean;
    id: string | number;
    result: {
        deleted_ledger_index?: number;
        index: string;
        ledger_current_index: number;
        node?: T;
        node_binary?: string;
        validated?: boolean;
    };
    status?: string;
    type: string;
    warning?: "load";
    warnings?: ResponseWarning[];
}

Type Parameters

Hierarchy (View Summary)

Properties

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

Properties

Optionalapi_version

api_version?: number

Optionalforwarded

forwarded?: boolean

id

id: string | number

result

result: {
    deleted_ledger_index?: number;
    index: string;
    ledger_current_index: number;
    node?: T;
    node_binary?: string;
    validated?: boolean;
}

Type declaration

  • Optionaldeleted_ledger_index?: number

    (Optional) Indicates the ledger index at which the object was deleted.

  • index: string

    The unique ID of this ledger object.

  • ledger_current_index: number

    The ledger index of the ledger that was used when retrieving this data.

  • Optionalnode?: T

    Object containing the data of this ledger object, according to the ledger format.

  • Optionalnode_binary?: string

    The binary representation of the ledger object, as hexadecimal.

  • Optionalvalidated?: boolean

Optionalstatus

status?: string

type

type: string

Optionalwarning

warning?: "load"

Optionalwarnings

warnings?: ResponseWarning[]

Settings

Member Visibility

On This Page

Properties