Skip to content

A way to document "export from" types? #964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
1 task done
gwynjudd opened this issue Feb 1, 2019 · 2 comments
Closed
1 task done

A way to document "export from" types? #964

gwynjudd opened this issue Feb 1, 2019 · 2 comments

Comments

@gwynjudd
Copy link

gwynjudd commented Feb 1, 2019

Problem

I've got something like this:

[picklist/index.ts]

/**
 * @module picklist
 */

export * from './controller';
export * from './shims';
export * from './view-item';
export * from './view';
import * as Picklist from 'picklist/index';

export interface Foo {
  Picklist: typeof Picklist;
}

The question is, how to document [Foo.Picklist]? Currently it is coming out like this in the docs:

image

There is no documentation generated for the Picklist type.

By comparison, types that are generated without using the "export from" syntax don't have this problem.

Suggested Solution

Don't really know to be honest. Seems like it could be related to #516.

@aciccarello
Copy link
Collaborator

To clarify the problem, type information is not given to the Picklist property and instead the path is shown.

In general import * as and export * currently aren't well supported. We should probably link to a file that has all the symbols in the file.

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Mar 16, 2020

In 0.17.0 Picklist is shows as typeof Picklist (it doesn't have a link, but that's a separate issue that I'm looking into and not specific to this use, quite a few reference types seem to be broken)

image

The support for export declarations was greatly improved in 0.16, and slightly extended in 0.17

@Gerrit0 Gerrit0 closed this as completed Mar 16, 2020
@Gerrit0 Gerrit0 removed the bug label Feb 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants