documentation - 如何创建仅记录通过 index.ts 公开的对象的 Typedoc?
问题描述
我正在创建一个index.js
作为入口点的 NPM 包。
index.ts
(编译为index.js
)只导出一个类Client
。
然而 typedoc 记录了其他不向用户公开的类,但区域仅由客户端内部使用。
这是此类模块的示例。我相信它没有被我正在编写的 npm 包暴露,但我仍然导出模块以便Client
模块可以使用它。
import { Connection } from '../connection';
import { Request, IRequestBody } from '.';
import { IServerResponse } from '../common';
export interface RecordingDeleteRequestBody extends IRequestBody {
cmd: 'recording_delete';
data: {
recording_id: number;
}
}
export interface RecordingDeleteServerResponse extends IServerResponse {
cmd: 'recording_delete';
}
export type RecordingDeleteResponse = true;
export class RecordingDeleteRequest extends Request {
constructor(
recordingId: number,
transactionId: string,
connection: Connection,
maxTime: number
) {
let requestBody: RecordingDeleteRequestBody = {
type: 'request',
cmd: 'recording_delete',
data: { recording_id: recordingId }
}
super(requestBody, transactionId, connection, maxTime);
}
async run(): Promise<RecordingDeleteResponse> {
await new Promise<RecordingDeleteServerResponse>((resolve, reject) => {
this.connection.push(
this.requestBody,
this.transactionId,
this.maxTime,
resolve,
reject
);
});
return true;
}
}
如何从我的 typedoc 文档中清除这些类?
Class.recordingDeleteRequest()
我只想要创建使用此类的客户端方法的文档。
export default class Client {
public async recordingDelete(recordingId: number) {
let req = new requests.RecordingDeleteRequest(recordingId, this.newTransactionId(), this.connection!, this.defaultMaxWaitForResponse)
return await req.run();
}
}
解决方案
推荐阅读
- angular - 我无法将一个模块中的组件用于另一个模块组件
- python - AWS Lambda 在私有 API 网关后面请求另一个 lambda - DNS 解析不起作用
- c# - 在 ASP .Net Core 3.0 中使用 Heroku PostgreSql
- bit-manipulation - 表达式“x & (x + (1 << n))”是如何工作的?
- python - Windows长度矩阵转向量,提取数据
- javascript - 如何在 Symfony 项目中使用 jQuery 和 webpack-encore?
- javascript - React.js - 无法访问对象数组中的值
- jquery - 通过 AJAX 调用传递数据导致失败
- java - 使用 Java 从 YAML 文件中删除 Key:Value 属性
- python - 如何使用 python 应用 IDW 插值来使用 Plotly 绘制 3D 曲面