You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I also observe this passing a type predicate to a generic function. I have configured
{
"validation": {
"notDocumented": true
}
}
The function
/** * Parses a JSON string to the specified type. * @param guard The type predicate to validate the deserialized object. * @param json The JSON string to parse. * @typeParam T - The type of the returned objects. * @returns The desrialized object, if the type guard function returns true; otherwise, undefined. * @category Helper */exportfunctionsafeParse<T>(guard: (o: unknown)=>o is T,json: string): T|undefined{try{consto=JSON.parse(json)asunknown;returnguard(o) ? o : undefined;}catch{returnundefined;}}
includes the documentation for guard, as described above. I also observe the following message:
[warning] safeParse.guard.__type, defined in ./src/helpers/safe-parse.ts, does not have any documentation.
Here's a screen shot of the generated documentation.
I also observe this passing a type predicate to a generic function. I have configured
The function
includes the documentation for guard, as described above. I also observe the following message:
[warning] safeParse.guard.__type, defined in ./src/helpers/safe-parse.ts, does not have any documentation.
Here's a screen shot of the generated documentation.
I am using typedoc 0.24.7
To replicate:
Originally posted by @jstritch in #2283 (comment)
The text was updated successfully, but these errors were encountered: