Pangular Inspector
On this page ▾
The symbols @pangular-inspector/devtools/overlay-angular-native exports, generated from the package source.

@pangular-inspector/devtools/overlay-angular-native

Import from @pangular-inspector/devtools/overlay-angular-native. This page is generated from packages/devtools/src/overlay-angular-native.ts and the files it re-exports. Run pnpm docs:api after you change the public API.

AngularNativeNode

Interface. Source: packages/devtools/src/overlay-angular-native-views.ts.

The part of an @ng-native/fabric engine node the overlay reads. Structural, so this file compiles and tests without Angular Native installed.

interface AngularNativeNode {
  /** `element`, `text` or `anchor`. */
  readonly kind: string;
  /** The template spelling, such as `view` or `app-row`. */
  readonly name: string;
  readonly children: readonly AngularNativeNode[];
  readonly parent: AngularNativeNode | null;
  props?: Record<string, unknown>;
  ownStyle?: object;
  readonly host?: {setProp(node: never, key: string, value: unknown): void};
}

AngularNativeOverlayOptions

Interface. Source: packages/devtools/src/overlay-angular-native.ts.

interface AngularNativeOverlayOptions {
  /** The root node `mount()` created (`app.engine.root`), or a function that returns it. */
  root: AngularNativeNode | (() => AngularNativeNode | null | undefined);
  /** Absolute URL of the devtools server. Defaults to `http://localhost:9999/`. */
  baseURL?: string;
  /** How often the app reports, in milliseconds. Defaults to the server's `limits.refreshMs`. */
  intervalMs?: number;
  /** How long to wait before trying the server again, in milliseconds. */
  retryMs?: number;
}

DEFAULT_ANGULAR_NATIVE_BASE_URL

Constant. Source: packages/devtools/src/overlay-angular-native.ts.

const DEFAULT_ANGULAR_NATIVE_BASE_URL: 'http://localhost:9999/';

initAngularNativeOverlay

Function. Source: packages/devtools/src/overlay-angular-native.ts.

Report an Angular Native app to a devtools server over a WebSocket. Call it after mount(), in development only. A session that fails or drops is replaced after retryMs until the returned function is called.

function initAngularNativeOverlay(options: AngularNativeOverlayOptions): () => void;

withWebShims

Function. Source: packages/devtools/src/overlay-angular-native.ts.

async function withWebShims<T>(baseURL: string, connect: () => Promise<T>): Promise<T>;
© 2026 Pangular Inspector contributors. Released under the MIT License.