Skip to content

How to document JS API objects with nested definitions #1357

@heitortsergent

Description

@heitortsergent

Related to #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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    Tech WritersIssues that a writer could help withWIP

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions