Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IDistributedAggregateOptions

Hierarchy

Index

Properties

Properties

Optional autoParseNumbers

autoParseNumbers: boolean

enable auto parse of numbers

Optional contollerHint

contollerHint: { className?: string; name?: string }

Type declaration

  • Optional className?: string
  • Optional name?: string

Optional disableCount

disableCount: boolean

disable the count query

Optional filter

filter: (x: any) => boolean

Type declaration

    • (x: any): boolean

    • Parameters

      • x: any

      Returns boolean

Optional filterErrors

filterErrors: boolean

Optional limit

limit: number

result limit

Optional logger

logger: ILoggerApi

Optional offset

offset: number

result offset

Optional outputMode

outputMode: "map" | "only_value" | "embed_nodeId" | "responses"

Optional skipLocal

skipLocal: boolean

Each message will be locally processed (calling getResponse; look in Message). With this flag it can be prevented.

Optional sort

sort: {}

result sort definition

Type declaration

  • [key: string]: "asc" | "desc"

Optional targetIds

targetIds: string[]

used for defining targets to send messages

Optional timeout

timeout: number

Optional waitIfNoTarget

waitIfNoTarget: boolean

If no selected targets are given then no message will be send to unknown hosts. This can be prevented be this flag. The message will be send to unknown hosts and will wait for response till it arrive or will be timed out.

Generated using TypeDoc