Class FlowrAnalyzerLoadingOrderContext

constructor

• new FlowrAnalyzerLoadingOrderContext(
      ctx: FlowrAnalyzerContext,
      plugins: undefined | readonly FlowrAnalyzerLoadingOrderPlugin[],
  ): FlowrAnalyzerLoadingOrderContext

  Parameters

  • ctx: FlowrAnalyzerContext
  • plugins: undefined | readonly FlowrAnalyzerLoadingOrderPlugin[]

  Returns FlowrAnalyzerLoadingOrderContext

Readonlyname

addGuess

• addGuess(guess: readonly RParseRequest[], certain?: boolean): void

  Add a guess for the loading order. This is mostly for plugins to use. In case you have a certain order, use the certain flag to indicate this -- but please take care of really being certain!

  Parameters

  • guess: readonly RParseRequest[]
  • Optionalcertain: boolean

  Returns void

addRequest

• addRequest(request: RParseRequest): void

  Add a single request to the context. This is considered unordered (i.e., ordered implicitly by the order of addition) until a plugin provides either a guess or a known order.

  If you want to add multiple requests, consider using addRequests instead for efficiency.

  Parameters

  • request: RParseRequest

  Returns void

addRequests

• addRequests(requests: readonly RParseRequest[]): void

  Add one or multiple requests to the context. These are considered unordered (i.e., ordered implicitly by the order of addition) until a plugin provides either a guess or a known order.

  This is a batched version of addRequest.

  Parameters

  • requests: readonly RParseRequest[]

  Returns void

currentGuesses

• currentGuesses(): readonly RParseRequest[][]

  Get the current guesses for the loading order, if any. These are populated by FlowrAnalyzerLoadingOrderPlugins.

  Returns readonly RParseRequest[][]

currentKnownOrder

• currentKnownOrder(): undefined | readonly RParseRequest[]

  Get the current known loading order, if any. This is populated by FlowrAnalyzerLoadingOrderPlugins if they have a source of identifying the order definitively.

  Returns undefined | readonly RParseRequest[]

getLoadingOrder

• getLoadingOrder(): readonly RParseRequest[]

  Get the current loading order of requests, potentially triggering a re-computation if new requests have been added since the last computation.

  Returns readonly RParseRequest[]

getUnorderedRequests

• getUnorderedRequests(): readonly RParseRequest[]

  Get all requests that have been added to this context, but for which no loading order is known or guessed.

  Returns readonly RParseRequest[]

peekLoadingOrder

• peekLoadingOrder(): undefined | readonly RParseRequest[]

  Peek whether we have a loading order known or guessed, this does not trigger any plugin runs. If you want to get the current loading order, including potential recompoutations, use getLoadingOrder instead.

  Returns undefined | readonly RParseRequest[]

reset

• reset(): void

  Reset the context to its initial state.

  Returns void