Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FormationWalker<Data>

Walks the formation tree that allows processing of discourse in an iterator. Used by the {@link Processor} which is more commonly used to process the formation tree

Type parameters

  • Data

Hierarchy

  • FormationWalker

Implements

Index

Constructors

constructor

Properties

cache

cache: ICacheMutable<Data>

The cache that is being used to retrieve the messages

options

options: ILinkProcessOptions

Options to use when processing the links

start

start: IGuidImmutable

The start of the conversation tree to process

Accessors

discourse

features

  • get features(): ReadonlySet<string>

id

  • get id(): IGuidImmutable

link

  • The current formation link. This can be used to determine what the next formation will be. It is highly likely you will need to use redirect as well

    Returns ILinkImmutable | undefined

    undefined when the current formation is not known

meta

redirect

  • get redirect(): IGuidImmutable | undefined
  • This is the current redirection state of the walker. This is used to ignore the link target and go straight to this GUID. This can be used with link to determine which formation will be walked to.

    Returns IGuidImmutable | undefined

tags

  • get tags(): ReadonlyArray<string>

Methods

__@asyncIterator

next

return

throw

  • Throws an exception into the iterator. Cleans up the iterator and then throws the exception into the iterator context

    Parameters

    • error: Error

      the error given by the calling context into the iterator

    Returns Promise<IteratorResult<IFormationWalkerData<Data>>>