lib/types: add docs for custom type

2025-09-17 11:03:08 +02:00
parent 80bc3daf96
commit 7a38e976a4
1 changed files with 12 additions and 1 deletions
--- a/lib/types/default.nix
+++ b/lib/types/default.nix
@@ -1,8 +1,19 @@
 { lib, ... }:
 {
+  /**
+    A custom type for deferred modules that guarantee to be JSON serializable.
+
+    This type guarantees that the module is serializable by checking all definitions.
+    Nix doesn't allow to raise a nice error if the module is not serializable.
+
+    It applies the following restrictions:
+
+    - Enforces that there is only one definition.
+    - Enforces that the definition is JSON serializable
+    - Disallows nested imports
+  */
  uniqueDeferredSerializableModule = lib.fix (
    self:
-
    let
      checkDef =
        _loc: def: