Skip to content

index.md

Latest commit

 

History

History
32 lines (28 loc) · 14.1 KB

index.md

File metadata and controls

32 lines (28 loc) · 14.1 KB
Raw
title API reference
description The public entry points of @pangular-inspector/devtools and the symbols each one exports, generated from the package source.
Every public entry point of the package and the symbols it exports, generated from the source.

API reference

Each entry point of @pangular-inspector/devtools has a page with every symbol it exports, its declaration and its JSDoc. The pages are generated from the package source, so names and types match the published code. Installation says what each entry point is for, and Configuration explains the options. Angular debug API lists the window.ng functions the overlay reads and the Angular version each one needs.

Entry point Exports
@pangular-inspector/devtools/devframe (also @pangular-inspector/devtools) createPangular, default, DEFAULT_POPUP_HOTKEY, initDevframe, PANGULAR_ACTIONS, PANGULAR_INSPECTORS, PANGULAR_LIMITS, PangularAction, PangularConfig, PangularHostOptions, PangularInspector, PangularLimit, PluginSwitchInput, ResolvedPangularConfig, resolvePangularConfig
@pangular-inspector/devtools/config DEFAULT_POPUP_HOTKEY, PANGULAR_ACTIONS, PANGULAR_INSPECTORS, PANGULAR_LIMITS, PangularAction, PangularConfig, PangularInspector, PangularLimit, PluginSwitchInput, ResolvedPangularConfig, resolvePangularConfig
@pangular-inspector/devtools/cd-data CD_CAUSE_KINDS, CD_CAUSE_LABEL, CD_EXPORT_FORMAT, CD_HINT_MAX_CHANGED, CD_HINT_MIN_CHECKS, CD_SPAN_KIND, cdCauseText, cdExportFile, CdExportFile, CdHint, cdHints, CdOptionsRequest, cdSlowMs, CdTraceEvent, cdTraceFile, CdTraceFile, DEFAULT_CD_SLOW_MS, MAX_CD_IMPORT_BYTES, MAX_SPANS, parseCdImport, sanitizeCdDiagnosis, sanitizeCdRecording, toCdOptions, toCdOptionsRequest, UNNAMED_SIGNAL
@pangular-inspector/devtools/overlay disposeOverlay, initOverlay, installSignalWriteHook, lanDevtoolsURL, OverlayConnectionMeta, OverlayOptions, registerNgrxSignals
@pangular-inspector/devtools/overlay-manual disposeOverlay, initOverlay, installSignalWriteHook, lanDevtoolsURL, OverlayConnectionMeta, OverlayOptions, registerNgrxSignals
@pangular-inspector/devtools/plugin definePangularServerPlugin, PANGULAR_PLUGIN_API_VERSION, PangularPagePlugin, PangularPluginAction, PangularPluginContext, PangularPluginPage, pangularPluginRegistry, PangularPluginRegistry, PangularPluginTool, PangularPluginToolContext, PangularPluginToolSafety, PangularServerPlugin, PangularServerPluginContext, PluginActionResult, PluginBadge, PluginCell, PluginListSection, PluginSection, PluginSerializeLimits, PluginStatsSection, PluginTableSection, PluginTextSection, PluginTone, PluginTreeSection, PluginView, PluginViewAction, registerPangularPlugin
@pangular-inspector/devtools/capacitor-hook installCapacitorHook
@pangular-inspector/devtools/store-hook installStoreHook
@pangular-inspector/devtools/startup-hook installStartupHook
@pangular-inspector/devtools/overlay-angular-native AngularNativeNode, AngularNativeOverlayOptions, DEFAULT_ANGULAR_NATIVE_BASE_URL, initAngularNativeOverlay, withWebShims
@pangular-inspector/devtools/popup createDevtoolsPopup, hideDevtools, LauncherCounts, shortCount, showDevtools
@pangular-inspector/devtools/overlay-nativescript defaultDevtoolsBaseURL, initNativeScriptOverlay, lanDevtoolsURL, NativeScriptOverlayOptions
@pangular-inspector/devtools/cli buildReport, BuildReportOptions, BuildReportResult, createPangularCli, DEFAULT_REPORT_DIR, PangularCliOptions
@pangular-inspector/devtools/http HttpTransferCacheOptions, PangularHttpOptions, providePangularHttp, withPangular
@pangular-inspector/devtools/hub hubEnabled, initPangularHub, PANGULAR_HUB_BASE, PangularConfig, PangularHubOptions
@pangular-inspector/devtools/ssr NodeEventLike, pangularSsrEventHandler, pangularSsrMiddleware, PangularSsrOptions, WebRequestHandler, withPangularSsr
@pangular-inspector/devtools/vite default, PangularConfig, PangularViteOptions