Add support for predicate types (#71)

sphinx_js/typedoc.py

@@ -1073,6 +1073,17 @@ def _render_name_root(self, converter: Converter) -> Iterator[str | ir.TypeXRef]
         yield self.name
 
 
+class PredicateType(TypeBase):
+    type: Literal["predicate"]
+    name: str
+    targetType: "TypeD"
+
+    def _render_name_root(self, converter: Converter) -> Iterator[str | ir.TypeXRef]:
+        yield self.name
+        yield " is "
+        yield from self.targetType.render_name(converter)
+
+
 AnyNode = Node | Project | Signature
 
 
@@ -1086,6 +1097,7 @@ def _render_name_root(self, converter: Converter) -> Iterator[str | ir.TypeXRef]
     | ReferenceType
     | ReflectionType
     | TupleType
+    | PredicateType
     | UnknownType
 )
 

tests/test_build_ts/source/class.ts

@@ -98,3 +98,7 @@ export class Iterable {
     yield 3;
   }
 }
+
+export function predicate(c): c is ConstructorlessClass {
+  return false;
+}

tests/test_build_ts/source/docs/predicate.rst

@@ -0,0 +1 @@
+.. js:autofunction:: predicate

tests/test_build_ts/test_build_ts.py

@@ -168,6 +168,22 @@ class Iterable()
             ),
         )
 
+    def test_predicate(self):
+        self._file_contents_eq(
+            "predicate",
+            dedent(
+                """\
+                predicate(c)
+
+                   Arguments:
+                      * **c** (*any*) --
+
+                   Returns:
+                      c is "ConstructorlessClass()"
+                """
+            ),
+        )
+
 
 class TestHtmlBuilder(SphinxBuildTestCase):
     """Tests which require an HTML build of our Sphinx tree, for checking