Docs: Typedoc ignore flag for generated docs (#46)

ceramicnetwork · Jan 9, 2025 · bd85519 · bd85519
1 parent e5114a0
commit bd85519
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 42 deletions.
diff --git a/docs/@ceramic-sdk/events/README.md b/docs/@ceramic-sdk/events/README.md
@@ -26,8 +26,6 @@
 
 ## Functions
 
-- [assertSignedEvent](functions/assertSignedEvent.md)
-- [assertTimeEvent](functions/assertTimeEvent.md)
 - [carFromString](functions/carFromString.md)
 - [carToString](functions/carToString.md)
 - [createSignedInitEvent](functions/createSignedInitEvent.md)

diff --git a/docs/@ceramic-sdk/events/functions/assertSignedEvent.md b/docs/@ceramic-sdk/events/functions/assertSignedEvent.md
diff --git a/docs/@ceramic-sdk/events/functions/assertTimeEvent.md b/docs/@ceramic-sdk/events/functions/assertTimeEvent.md
diff --git a/packages/events/src/codecs.ts b/packages/events/src/codecs.ts
@@ -66,7 +66,9 @@ export function decodeSignedEvent(input: unknown): SignedEvent {
   return decode(SignedEvent, input)
 }
 
-/** Assert the provided `input` is a SignedEvent */
+/**
+ * @ignore
+ */
 export function assertSignedEvent(
   input: unknown,
 ): asserts input is SignedEvent {
@@ -90,7 +92,9 @@ export function decodeTimeEvent(input: unknown): TimeEvent {
   return decode(TimeEvent, input)
 }
 
-/** Assert the provided `input` is a TimeEvent */
+/**
+ * @ignore
+ */
 export function assertTimeEvent(input: unknown): asserts input is TimeEvent {
   decodeTimeEvent(input)
 }