Add hint in docs

open-pioneer · Jan 31, 2024 · f749d96 · f749d96
1 parent 8b7c973
commit f749d96
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/.changeset/neat-terms-teach.md b/.changeset/neat-terms-teach.md
@@ -0,0 +1,5 @@
+---
+"@open-pioneer/runtime": patch
+---
+
+Add a hint that `DECLARE_SERVICE_INTERFACE` should be imported via `import type`.
diff --git a/src/packages/runtime/DeclaredService.ts b/src/packages/runtime/DeclaredService.ts
@@ -41,10 +41,13 @@ export interface DeclaredService<InterfaceName extends string> {
  * Helper symbol to declare a service's interface name when not using a separate interface.
  *
  * > NOTE: This symbol does not exist at runtime. Declaring a service interface is compile time only!
+ * > It should therefore be imported via `import type` (see example below).
  *
  * @example
  *
  * ```ts
+ * import { type DECLARE_SERVICE_INTERFACE} from "@open-pioneer/runtime";
+ *
  * class MyServiceImpl {
  *     // Add this line to your class.
  *     // It declares (at compile time) that the service class must be used via the given interface name.