Skip to content

docs(codegen): document the config option types in src/types.ts #5371

Description

@aryaemami59

Part of #5368.

Document the config option types in src/types.ts - Config, CommonOptions,
OutputFileOptions, EndpointOverrides, the matcher types, and the exported
string-union types.

This is the source of truth the docs page is generated from by hand, so it is the
highest-leverage file to document first.

Blocked on the tagging-convention question in
#5368: whether to apply
@public +
@since to exported symbols and
@internal to non-exported ones. If that is
declined, this becomes a plain descriptive JSDoc pass with no tags.

Fixed by #5373.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

DocumentationImprovements or additions to documentationRTKQ-CodegenIssues related to the @rtk-query/codegen-openapi package.

Type

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions