Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IFormationWalkOptions

Options that can be specified to change the behaviour of the formation walking

Hierarchy

  • IFormationWalkOptions

Implemented by

Index

Properties

Properties

Optional end

end: GuidAccepted

Stops the iteration when a certain ID value is seen. This may or may not occur depending on the number of formations that allowed to be walked by maximum.

Optional maximum

maximum: undefined | number

The maximum amount of formations that will be walked. The function has to keep a set of seen formations to prevent returning duplicates or to get into cycles. This requires memory for the bookkeeping. This defaults to 256.

Optional skip

skip: Iterable<GuidAccepted>

ID values that should be skipped. This is useful when a tree needs to be walked but some ID values are already cached. It can help servers re-send already cached formations.