Interface VersioningServiceInterface

Interface for a versioning service.

interface VersioningServiceInterface {
    findOverlappingVersions: (
        a: SupportedVersionsOptions,
        b: SupportedVersionsOptions,
        currentLatest: `${number}.${number}.${number}`,
    ) => SupportedVersionsOptions;
    getVersions: () => VersionFile[];
    hasOverlappingVersions: (
        a: SupportedVersionsOptions,
        b: SupportedVersionsOptions,
        currentLatest: `${number}.${number}.${number}`,
    ) => boolean;
    matchesVersion: (
        versions: SupportedVersionsOptions,
        resolvedVersion: Version,
    ) => boolean;
    resolveVersion: (
        context: HttpRequestContext | WebsocketRequestContext,
    ) => Version | Promise<Version>;
}

Properties

findOverlappingVersions: (
    a: SupportedVersionsOptions,
    b: SupportedVersionsOptions,
    currentLatest: `${number}.${number}.${number}`,
) => SupportedVersionsOptions

Finds overlapping versions between two options.

getVersions: () => VersionFile[]

Returns all versions created in the file system.

hasOverlappingVersions: (
    a: SupportedVersionsOptions,
    b: SupportedVersionsOptions,
    currentLatest: `${number}.${number}.${number}`,
) => boolean

Checks whether or not the given options have some overlap.

matchesVersion: (
versions: SupportedVersionsOptions,
resolvedVersion: Version,
) => boolean

Checks if any of the given version options matches the resolved version.

resolveVersion: (
context: HttpRequestContext | WebsocketRequestContext,
) => Version | Promise<Version>

Resolves the version from the given request context.