Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IGeneratorMutable<Data>

Type parameters

  • Data

Hierarchy

Implemented by

Index

Properties

Methods

Properties

cache

cache: ICacheMutable<Data>

Retrieves cache that is being used to retrieve the messages

ctx

ctx: IContextImmutable

The current generator context

discourse

discourse: IDiscourseImmutable<Data> | undefined

The current discourse being processed

features

features: ReadonlySet<string>

The features of the formation. This is pulled from the metadata

id

id: IGuidImmutable

Retrieves the ID that is currently being processed

jump

jump: IGuidImmutable | undefined

Determines the formation to jump to on the next iteration

link

link: ILinkImmutable | undefined

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

undefined when the current formation is not known

meta

meta: IFormationMetaImmutable

The formation metadata. This can be used to determine extra information about the formation. Of particular note are the features.

off

off: Record extends object ? <E extends Exclude<keyof Record, number>>(event: E, listener: IEventEmitterFunction<Record, E>) => this : (event: EventEmitterEvent, listener: IEventEmitterListener<unknown[], unknown, never>) => this

on

on: Record extends object ? <E extends Exclude<keyof Record, number>>(event: E, listener: IEventEmitterFunction<Record, E>) => this : (event: EventEmitterEvent, listener: IEventEmitterListener<unknown[], unknown, never>) => this

once

once: Record extends object ? <E extends Exclude<keyof Record, number>>(event: E, listener: IEventEmitterFunction<Record, E>) => this : (event: EventEmitterEvent, listener: IEventEmitterListener<unknown[], unknown, never>) => this

options

options: ILinkProcessOptions

Retrieves options to use when processing the links

redirect

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.

tags

tags: ReadonlyArray<string>

The formation tags. Can be used to determine formation metadata

Methods

__@asyncIterator

  • __@asyncIterator(): IAsyncIterableIterator<Data>

  • Returns an iterator that moves the generator along to the next formations

    Returns IAsyncIterableIterator<Data>

dispose

  • dispose(): this