crawlee
crawlee copied to clipboard
Crawlee docs - the default values are wrongly displayed
Which package is this bug report for? If unsure which one to select, leave blank
None
Issue description
see this page and prnt scrn
blockedStatusCodes - should be [401, 403, 429] but is = number[] maxPoolSize - should be 1000 but is ````ts 1000`` etc
Code sample
No response
Package version
not relevant
Node.js version
not relevant
Operating system
No response
Apify platform
- [ ] Tick me if you encountered this issue on the Apify platform
I have tested this on the next release
No response
Other context
No response
I thought this may be a trivial one, but it's not. What I've figured out:
- in the typedoc JSON output, the default is stored in
blockTagsunder thecommentfield of the declaration- default values that work as expected (e.g.,
BASIC_CRAWLER_TIMEOUT_BUFFER_SECS) have the default underdefaultin the declaration
- default values that work as expected (e.g.,
- the "```ts" code fence is added by typedoc, apparently in the case when there is no explicit code block in the @default tag
- the
number[]inblockedStatusCodesseems to be some kind of a default for kinda-complex types. After changing the type of the property tostring, I got a code block, just like for the other properties