25 lines
1.3 KiB
TypeScript
25 lines
1.3 KiB
TypeScript
import { LoggerProvider } from '../types/LoggerProvider';
|
|
export declare const GLOBAL_LOGS_API_KEY: unique symbol;
|
|
declare type Get<T> = (version: number) => T;
|
|
export declare const _global: Partial<{
|
|
[GLOBAL_LOGS_API_KEY]: Get<LoggerProvider>;
|
|
}>;
|
|
/**
|
|
* Make a function which accepts a version integer and returns the instance of an API if the version
|
|
* is compatible, or a fallback version (usually NOOP) if it is not.
|
|
*
|
|
* @param requiredVersion Backwards compatibility version which is required to return the instance
|
|
* @param instance Instance which should be returned if the required version is compatible
|
|
* @param fallback Fallback instance, usually NOOP, which will be returned if the required version is not compatible
|
|
*/
|
|
export declare function makeGetter<T>(requiredVersion: number, instance: T, fallback: T): Get<T>;
|
|
/**
|
|
* A number which should be incremented each time a backwards incompatible
|
|
* change is made to the API. This number is used when an API package
|
|
* attempts to access the global API to ensure it is getting a compatible
|
|
* version. If the global API is not compatible with the API package
|
|
* attempting to get it, a NOOP API implementation will be returned.
|
|
*/
|
|
export declare const API_BACKWARDS_COMPATIBILITY_VERSION = 1;
|
|
export {};
|
|
//# sourceMappingURL=global-utils.d.ts.map
|