Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PreparedQueryExecuteOptions

Options used to execute prepared query

Hierarchy

  • PreparedQueryExecuteOptions

Index

Constructors

constructor

Methods

getLimit

  • getLimit(): number
  • Set the size of the list to the given number of nodes. This is applied after any sorting or shuffling.

    Returns number

getNear

  • getNear(): string
  • Set node name for sorting the list in ascending order based on the estimated round trip time from that node. Passing _agent will use the agent's node for the sort. If this is not present, the default behavior will shuffle the nodes randomly each time the query is executed.

    Returns string

setLimit

  • Set the size of the list to the given number of nodes. This is applied after any sorting or shuffling.

    Parameters

    • limit: number

    Returns PreparedQueryExecuteOptions

setNear

  • Set node name for sorting the list in ascending order based on the estimated round trip time from that node. Passing _agent will use the agent's node for the sort. If this is not present, the default behavior will shuffle the nodes randomly each time the query is executed.

    Parameters

    • near: string

    Returns PreparedQueryExecuteOptions

toJson

  • toJson(): {}
  • Returns {}

    • [key: string]: any

Generated using TypeDoc