Interface ReadOnlyFlowrAnalyzerLoadingOrderContext

Read-only interface for the loading order context, which is used to determine the order in which script files are loaded in a project.

This interface prevents you from modifying the available files, but allows you to inspect them (which is probably what you want when using the FlowrAnalyzer). If you are a FlowrAnalyzerLoadingOrderPlugin and want to modify the available orders, you can use the FlowrAnalyzerLoadingOrderContext directly.

interface ReadOnlyFlowrAnalyzerLoadingOrderContext {
    currentGuesses(): readonly RParseRequest[][];
    currentKnownOrder(): undefined | readonly RParseRequest[];
    getLoadingOrder(): readonly RParseRequest[];
    getUnorderedRequests(): readonly RParseRequest[];
    name: string;
    peekLoadingOrder(): undefined | readonly RParseRequest[];
}

Implemented by

FlowrAnalyzerLoadingOrderContext

Index

Properties

Methods

currentGuesses currentKnownOrder getLoadingOrder getUnorderedRequests peekLoadingOrder

Properties

`Readonly`name

name: string

The name of this context.

Methods

currentGuesses

currentGuesses(): readonly RParseRequest[][]
Get the current guesses for the loading order, if any. These are populated by FlowrAnalyzerLoadingOrderPlugins.

Returns readonly RParseRequest[][]
- Defined in src/project/context/flowr-analyzer-loading-order-context.ts:35

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[]
- Defined in src/project/context/flowr-analyzer-loading-order-context.ts:39

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[]
- Defined in src/project/context/flowr-analyzer-loading-order-context.ts:27

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[]
- Defined in src/project/context/flowr-analyzer-loading-order-context.ts:31

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[]
- Defined in src/project/context/flowr-analyzer-loading-order-context.ts:23