Class ApiVersionEvaluator

The evaluator service to evaluate the API versions. Used to filter out incompatible (due to incompatible API version range) routes and menus.

Note that during bootstrapping phase, a singleton instance is registered. Hence, instead of creating a new evaluator, you can get it injected.

Index

Constructors

Accessors

currentApiVersions

Methods

ensureSettled isApiVersionsSatisfied isApiVersionsSatisfiedForApp waitForVersionResolution

Constructors

constructor

new ApiVersionEvaluator(
baseServiceEndpoint: string,
httpClient: HttpClient,
): ApiVersionEvaluator
Parameters
- baseServiceEndpoint: string
- httpClient: HttpClient
Returns ApiVersionEvaluator
- Defined in core/src/security/ApiVersionEvaluator.ts:29

Accessors

currentApiVersions

get currentApiVersions(): Readonly<Map<string, SemVer | null>>
Returns Readonly<Map<string, SemVer | null>>
- Defined in core/src/security/ApiVersionEvaluator.ts:23

Methods

ensureSettled

ensureSettled(): void
Returns void
- Defined in core/src/security/ApiVersionEvaluator.ts:114

isApiVersionsSatisfied

isApiVersionsSatisfied(
versionSpecs?: Readonly<Record<string, string>> | null,
): boolean
Verifies if the given version specification is satisfied by the current versions of the APIs.
Parameters
- OptionalversionSpecs: Readonly<Record<string, string>> | null
Returns boolean
true if the specification is satisfied, else false.
Example
```
evaluator.isApiVersionsSatisfied({
  foo: '^1.5',
  bar: '<2.3',
});
```
- Defined in core/src/security/ApiVersionEvaluator.ts:104

isApiVersionsSatisfiedForApp

isApiVersionsSatisfiedForApp(app: Partial<MenuApp>): boolean
Verifies if the version specification for the given app is satisfied by the current versions of the APIs.
Parameters
- app: Partial<MenuApp>
  For which the version specification needs to be evaluated.
Returns boolean
true if the specification is satisfied, else false.
Example
```
evaluator.isApiVersionsSatisfiedForApp({
  settings: {
    apiVersions: {
      foo: '^1.5',
      bar: '<2.3',
    }
  }
});
```
- Defined in core/src/security/ApiVersionEvaluator.ts:88

waitForVersionResolution

waitForVersionResolution(): Promise<void>
Helper method that can be used to wait for initialization.

Returns Promise<void>
- Defined in core/src/security/ApiVersionEvaluator.ts:66