angular/devtools/projects/ng-devtools-backend/src/lib/ng-debug-api/ng-debug-api.ts
Tomasz Ducin 2d7d4e2cf0 refactor(core): type-safe global ng (#53439)
This PR provides strict type definition for the window.ng object used
for both console debugging and devtools. `GlobalDevModeUtils` now
gathers all type information about all methods exposed on window.ng.

PR Close #53439
2024-01-09 12:17:48 -08:00

48 lines
1.2 KiB
TypeScript

/**
* @license
* Copyright Google LLC All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.io/license
*/
import type {ɵGlobalDevModeUtils as GlobalDevModeUtils} from '@angular/core';
/**
* Returns a handle to window.ng APIs (global angular debugging).
*
* @returns window.ng
*/
export const ngDebugClient = () => (window as any as GlobalDevModeUtils).ng;
/**
* Checks whether a given debug API is supported within window.ng
*
* @returns boolean
*/
export function ngDebugApiIsSupported(api: keyof GlobalDevModeUtils['ng']): boolean {
const ng = ngDebugClient();
return typeof ng[api] === 'function';
}
/**
* Checks whether Dependency Injection debug API is supported within window.ng
*
* @returns boolean
*/
export function ngDebugDependencyInjectionApiIsSupported(): boolean {
if (!ngDebugApiIsSupported('ɵgetInjectorResolutionPath')) {
return false;
}
if (!ngDebugApiIsSupported('ɵgetDependenciesFromInjectable')) {
return false;
}
if (!ngDebugApiIsSupported('ɵgetInjectorProviders')) {
return false;
}
if (!ngDebugApiIsSupported('ɵgetInjectorMetadata')) {
return false;
}
return true;
}