Skip to content
This repository was archived by the owner on Mar 10, 2025. It is now read-only.

Commit bd85519

Browse files
authored
Docs: Typedoc ignore flag for generated docs (#46)
1 parent e5114a0 commit bd85519

4 files changed

Lines changed: 6 additions & 42 deletions

File tree

docs/@ceramic-sdk/events/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,6 @@
2626

2727
## Functions
2828

29-
- [assertSignedEvent](functions/assertSignedEvent.md)
30-
- [assertTimeEvent](functions/assertTimeEvent.md)
3129
- [carFromString](functions/carFromString.md)
3230
- [carToString](functions/carToString.md)
3331
- [createSignedInitEvent](functions/createSignedInitEvent.md)

docs/@ceramic-sdk/events/functions/assertSignedEvent.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

docs/@ceramic-sdk/events/functions/assertTimeEvent.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

packages/events/src/codecs.ts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,9 @@ export function decodeSignedEvent(input: unknown): SignedEvent {
6666
return decode(SignedEvent, input)
6767
}
6868

69-
/** Assert the provided `input` is a SignedEvent */
69+
/**
70+
* @ignore
71+
*/
7072
export function assertSignedEvent(
7173
input: unknown,
7274
): asserts input is SignedEvent {
@@ -90,7 +92,9 @@ export function decodeTimeEvent(input: unknown): TimeEvent {
9092
return decode(TimeEvent, input)
9193
}
9294

93-
/** Assert the provided `input` is a TimeEvent */
95+
/**
96+
* @ignore
97+
*/
9498
export function assertTimeEvent(input: unknown): asserts input is TimeEvent {
9599
decodeTimeEvent(input)
96100
}

0 commit comments

Comments
 (0)