k6-docs icon indicating copy to clipboard operation
k6-docs copied to clipboard

How to document JS API objects with nested definitions

Open heitortsergent opened this issue 2 years ago • 0 comments

Related to https://github.com/grafana/k6-docs/pull/1348.

When documenting k6's JS API, we don't currently have a great/standard way of providing a definition for the properties of objects with nested objects with them.

One way to do it is to provide multiple tables, one for each object, in the same page, although they can be a little hard to parse.

How can we improve this? How do other libraries/docs handle this?

heitortsergent avatar Oct 03 '23 15:10 heitortsergent