@smithy/service-client-documentation-generator 1.0.1 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { Logger, Options, Renderer } from "typedoc";
|
|
2
|
+
/**
|
|
3
|
+
* @internal
|
|
4
|
+
*
|
|
5
|
+
* Group the ToC for easier observability.
|
|
6
|
+
*/
|
|
7
|
+
export declare class SdkClientTocPlugin {
|
|
8
|
+
readonly options: Options;
|
|
9
|
+
readonly logger: Logger;
|
|
10
|
+
private readonly renderer;
|
|
11
|
+
private clientDir?;
|
|
12
|
+
readonly defaultGroup: string;
|
|
13
|
+
readonly defaultCategory: string;
|
|
14
|
+
constructor(options: Options, logger: Logger, renderer: Renderer);
|
|
15
|
+
private changeLinksToLowerCase;
|
|
16
|
+
private onEndResolve;
|
|
17
|
+
private belongsToClientPackage;
|
|
18
|
+
private isClient;
|
|
19
|
+
private isCommand;
|
|
20
|
+
private isPaginator;
|
|
21
|
+
private isInputOrOutput;
|
|
22
|
+
private isWaiter;
|
|
23
|
+
/**
|
|
24
|
+
* Define navigation categories in Client, Commands, Paginators and Waiters sections. It will update the
|
|
25
|
+
* supplied categories array.
|
|
26
|
+
*
|
|
27
|
+
* @param group The parent group where the categories will be placed under.
|
|
28
|
+
* @param reflections The reflections that should be categorized.
|
|
29
|
+
*/
|
|
30
|
+
private defineCategories;
|
|
31
|
+
private isCategorized;
|
|
32
|
+
private loadClientDir;
|
|
33
|
+
}
|
package/package.json
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@smithy/service-client-documentation-generator",
|
|
3
|
-
"version": "1.0
|
|
3
|
+
"version": "1.1.0",
|
|
4
4
|
"scripts": {
|
|
5
|
-
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
5
|
+
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types && yarn build:types:downlevel'",
|
|
6
6
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
7
7
|
"build:es": "tsc -p tsconfig.es.json",
|
|
8
8
|
"build:types": "tsc -p tsconfig.types.json",
|