How to properly document (TSDoc) exported classes

By -

A.ts

/**
* The A Class
*/
export class A {}
export default A

The Alphabet Namespace(?)

Alphabet.ts

import A from "./"
import B from "./"
import C from "./"
/**
* Collection of letters
*/
export const Alphabet = {
 A,
 B,
 C
}
export default Alphabet

This allows you to use the library like:

import MyLibrary from "x"

const letter = new MyLibrary.Alphabet.A

The problem

The documentation you see in A.ts does not persist over once it has been exported in Alphabet.ts

If you hover over import A from "./" you will see The A Class. But if you hover over A here:

export const Alphabet = {
 A,
 B,
 C
}

You will see no documentation which of course means you see nothing when you utilize it as an end-user here: MyLibrary.Alphabet.A

It seems you could fix this, but the documentation must be moved from A.ts to where it is exported in Alphabet.ts, which is not ideal from a developer standpoint, though this works for users.



from Recent Questions - Stack Overflow https://ift.tt/3npf8HA
https://ift.tt/eA8V8J

Comments

Post a Comment

Popular posts from this blog

Today Walkin 14th-Sept

By -
Image
14th Sept 2017 ( GO Through all List) Read Walkin details properly , Try to call company before attending if possible !!! ==================================== 1. Myntra through fresherworld (Call Based , Venue shared to shortlisted candidates) _____________________________ 2. Magna : Hiring for Client Harman : C++
Read more

Spring Elasticsearch Operations

By -
Elasticsearch Operations Spring Data Elasticsearch uses two interfaces to define the operations that can be called against an Elasticsearch index. These are ElasticsearchOperations and ReactiveElasticsearchOperations. Whereas the first is used with the classic synchronous implementations, the second one uses reactive infrastructure. The default implementations of the interfaces offer: Read/Write mapping support for domain types. A rich query and criteria api. Resource management and Exception translation. ElasticsearchTemplate The ElasticsearchTemplate is an implementation of the ElasticsearchOperations interface using the Transport Client. @Configuration public class TransportClientConfig extends ElasticsearchConfigurationSupport {   @Bean   public Client elasticsearchClient() throws UnknownHostException {                      Settings settings = Settings.builder().put("cluster.name", "elasticsearch")....
Read more

Hibernate Search - Elasticsearch with JSON manipulation

By -
Elasticsearch with JSON manipulation Elasticsearch ships with many features. It is possible that at some point, one feature you need will not be exposed by the Search DSL. To work around such limitations, Hibernate Search provides ways to: Transform the HTTP request sent to Elasticsearch for search queries. Read the raw JSON of the HTTP response received from Elasticsearch for search queries. Direct changes to the HTTP request may conflict with Hibernate Search features and be supported differently by different versions of Elasticsearch. Similarly, the content of the HTTP response may change depending on the version of Elasticsearch, depending on which Hibernate Search features are used, and even depending on how Hibernate Search features are implemented. Thus, features relying on direct access to HTTP requests or responses cannot be guaranteed to continue to work when upgrading Hibernate Search, even for micro upgrades (x.y.z to x.y.(z+1)). Use this at your own risk....
Read more