rspress-plugin-api-extractor 0.16.1 → 0.16.2
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.
- package/index.d.ts +6 -6
- package/package.json +23 -23
- package/runtime/index.d.ts +6 -6
package/index.d.ts
CHANGED
|
@@ -59,7 +59,7 @@ type SourceConfig = typeof SourceConfig.Type;
|
|
|
59
59
|
*
|
|
60
60
|
* @public
|
|
61
61
|
*/
|
|
62
|
-
declare const DEFAULT_CATEGORIES: Record<string, CategoryConfig>;
|
|
62
|
+
export declare const DEFAULT_CATEGORIES: Record<string, CategoryConfig>;
|
|
63
63
|
/**
|
|
64
64
|
* Configuration for a single version of an API within a multi-version setup.
|
|
65
65
|
*
|
|
@@ -782,7 +782,7 @@ declare function ApiExtractorPluginImpl(rawOptions: PluginOptions): RspressPlugi
|
|
|
782
782
|
*
|
|
783
783
|
* @public
|
|
784
784
|
*/
|
|
785
|
-
declare const ApiExtractorPlugin: typeof ApiExtractorPluginImpl & {
|
|
785
|
+
export declare const ApiExtractorPlugin: typeof ApiExtractorPluginImpl & {
|
|
786
786
|
api: {
|
|
787
787
|
fromDir: typeof fromDir;
|
|
788
788
|
};
|
|
@@ -861,7 +861,7 @@ interface ResolvedServeConfig {
|
|
|
861
861
|
* @returns `true` when the server appears to be listening
|
|
862
862
|
* @public
|
|
863
863
|
*/
|
|
864
|
-
declare function isServerReady(mode: ServeMode, output: string): boolean;
|
|
864
|
+
export declare function isServerReady(mode: ServeMode, output: string): boolean;
|
|
865
865
|
/**
|
|
866
866
|
* Resolve {@link ServeOptions} into a concrete {@link ResolvedServeConfig},
|
|
867
867
|
* applying all defaults. Pure (modulo reading `process.env`) and exported so
|
|
@@ -871,7 +871,7 @@ declare function isServerReady(mode: ServeMode, output: string): boolean;
|
|
|
871
871
|
* @returns a fully resolved config with all defaults applied
|
|
872
872
|
* @public
|
|
873
873
|
*/
|
|
874
|
-
declare function resolveServeConfig(options?: ServeOptions): ResolvedServeConfig;
|
|
874
|
+
export declare function resolveServeConfig(options?: ServeOptions): ResolvedServeConfig;
|
|
875
875
|
/**
|
|
876
876
|
* Run an RSPress `dev` or `preview` server, freeing the port first and opening a
|
|
877
877
|
* browser once the server is ready. A drop-in replacement for the per-site
|
|
@@ -893,7 +893,7 @@ declare function resolveServeConfig(options?: ServeOptions): ResolvedServeConfig
|
|
|
893
893
|
* @returns a promise that resolves once the server is ready and the browser has been opened
|
|
894
894
|
* @public
|
|
895
895
|
*/
|
|
896
|
-
declare function serve(options?: ServeOptions): Promise<void>;
|
|
896
|
+
export declare function serve(options?: ServeOptions): Promise<void>;
|
|
897
897
|
//#endregion
|
|
898
|
-
export {
|
|
898
|
+
export type { PluginOptions as ApiExtractorPluginOptions, BaseRoute, CategoryConfig, DirInfo, FromDirOptions, LoadedModel, MultiApiConfig, OpenGraphImageConfig, OpenGraphImageMetadata, OpenGraphMetadata, ResolvedServeConfig, ServeMode, ServeOptions, SingleApiConfig, SourceConfig, VersionConfig };
|
|
899
899
|
//# sourceMappingURL=index.d.ts.map
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "rspress-plugin-api-extractor",
|
|
3
|
-
"version": "0.16.
|
|
3
|
+
"version": "0.16.2",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "RSPress plugin for generating API documentation from TypeScript API Extractor models",
|
|
6
6
|
"keywords": [
|
|
@@ -37,32 +37,32 @@
|
|
|
37
37
|
"./package.json": "./package.json"
|
|
38
38
|
},
|
|
39
39
|
"dependencies": {
|
|
40
|
-
"@effect/platform-node": "4.0.0-rc.
|
|
41
|
-
"@effected/github": "^0.
|
|
42
|
-
"@effected/glob": "^0.
|
|
43
|
-
"@effected/jsonc": "^0.
|
|
44
|
-
"@effected/markdown": "^0.
|
|
45
|
-
"@effected/npm": "^0.
|
|
46
|
-
"@effected/package-json": "^0.
|
|
47
|
-
"@effected/semver": "^0.
|
|
48
|
-
"@effected/store": "^0.
|
|
49
|
-
"@effected/tsconfig-json": "^0.
|
|
50
|
-
"@effected/walker": "^0.
|
|
51
|
-
"@effected/xdg": "^0.
|
|
52
|
-
"@effected/yaml": "^0.
|
|
40
|
+
"@effect/platform-node": "4.0.0-rc.112",
|
|
41
|
+
"@effected/github": "^0.9.0",
|
|
42
|
+
"@effected/glob": "^0.5.0",
|
|
43
|
+
"@effected/jsonc": "^0.9.0",
|
|
44
|
+
"@effected/markdown": "^0.9.0",
|
|
45
|
+
"@effected/npm": "^0.13.0",
|
|
46
|
+
"@effected/package-json": "^0.14.0",
|
|
47
|
+
"@effected/semver": "^0.6.0",
|
|
48
|
+
"@effected/store": "^0.7.0",
|
|
49
|
+
"@effected/tsconfig-json": "^0.8.0",
|
|
50
|
+
"@effected/walker": "^0.6.0",
|
|
51
|
+
"@effected/xdg": "^0.4.0",
|
|
52
|
+
"@effected/yaml": "^0.13.0",
|
|
53
53
|
"@microsoft/api-extractor-model": "^7.33.11",
|
|
54
54
|
"@shikijs/twoslash": "^4.4.3",
|
|
55
|
-
"@tsdoctor/bundle": "0.3.
|
|
56
|
-
"@tsdoctor/manifest": "0.1.
|
|
57
|
-
"@tsdoctor/model": "0.6.
|
|
58
|
-
"@tsdoctor/pages": "0.1.
|
|
59
|
-
"@tsdoctor/registry": "0.3.
|
|
60
|
-
"@tsdoctor/seo": "0.2.
|
|
61
|
-
"@tsdoctor/snapshot": "0.2.
|
|
62
|
-
"@tsdoctor/vfs": "0.2.
|
|
55
|
+
"@tsdoctor/bundle": "0.3.1",
|
|
56
|
+
"@tsdoctor/manifest": "0.1.1",
|
|
57
|
+
"@tsdoctor/model": "0.6.3",
|
|
58
|
+
"@tsdoctor/pages": "0.1.4",
|
|
59
|
+
"@tsdoctor/registry": "0.3.4",
|
|
60
|
+
"@tsdoctor/seo": "0.2.1",
|
|
61
|
+
"@tsdoctor/snapshot": "0.2.5",
|
|
62
|
+
"@tsdoctor/vfs": "0.2.2",
|
|
63
63
|
"@typescript/vfs": "^1.6.4",
|
|
64
64
|
"clsx": "^2.1.1",
|
|
65
|
-
"effect": "4.0.0-rc.
|
|
65
|
+
"effect": "4.0.0-rc.112",
|
|
66
66
|
"hast-util-to-jsx-runtime": "^2.3.6",
|
|
67
67
|
"image-size": "^2.0.2",
|
|
68
68
|
"ioredis": "^5.7.0",
|
package/runtime/index.d.ts
CHANGED
|
@@ -23,7 +23,7 @@ interface ApiExampleProps {
|
|
|
23
23
|
* @param props - {@link ApiExampleProps}
|
|
24
24
|
* @public
|
|
25
25
|
*/
|
|
26
|
-
declare function ApiExample({ code, hast }: ApiExampleProps): ReactElement;
|
|
26
|
+
export declare function ApiExample({ code, hast }: ApiExampleProps): ReactElement;
|
|
27
27
|
//#endregion
|
|
28
28
|
//#region src/runtime/components/ApiMember/index.d.ts
|
|
29
29
|
/**
|
|
@@ -57,7 +57,7 @@ interface ApiMemberProps {
|
|
|
57
57
|
* @param props - {@link ApiMemberProps}
|
|
58
58
|
* @public
|
|
59
59
|
*/
|
|
60
|
-
declare function ApiMember({ code, memberName, summary, id, hast, hasParameters }: ApiMemberProps): ReactElement;
|
|
60
|
+
export declare function ApiMember({ code, memberName, summary, id, hast, hasParameters }: ApiMemberProps): ReactElement;
|
|
61
61
|
//#endregion
|
|
62
62
|
//#region src/runtime/components/ApiSignature/index.d.ts
|
|
63
63
|
/**
|
|
@@ -91,7 +91,7 @@ interface ApiSignatureProps {
|
|
|
91
91
|
* @param props - {@link ApiSignatureProps}
|
|
92
92
|
* @public
|
|
93
93
|
*/
|
|
94
|
-
declare function ApiSignature({ code, heading: _heading, id: _id, hast, hasParameters, hasMembers }: ApiSignatureProps): ReactElement;
|
|
94
|
+
export declare function ApiSignature({ code, heading: _heading, id: _id, hast, hasParameters, hasMembers }: ApiSignatureProps): ReactElement;
|
|
95
95
|
//#endregion
|
|
96
96
|
//#region src/runtime/components/EnumMembersTable/index.d.ts
|
|
97
97
|
/**
|
|
@@ -121,7 +121,7 @@ interface EnumMembersTableProps {
|
|
|
121
121
|
*
|
|
122
122
|
* @public
|
|
123
123
|
*/
|
|
124
|
-
declare const EnumMembersTable: ({ members }: EnumMembersTableProps) => ReactElement | null;
|
|
124
|
+
export declare const EnumMembersTable: ({ members }: EnumMembersTableProps) => ReactElement | null;
|
|
125
125
|
//#endregion
|
|
126
126
|
//#region src/runtime/components/ParametersTable/index.d.ts
|
|
127
127
|
/**
|
|
@@ -151,7 +151,7 @@ interface ParametersTableProps {
|
|
|
151
151
|
*
|
|
152
152
|
* @public
|
|
153
153
|
*/
|
|
154
|
-
declare const ParametersTable: ({ parameters }: ParametersTableProps) => ReactElement | null;
|
|
154
|
+
export declare const ParametersTable: ({ parameters }: ParametersTableProps) => ReactElement | null;
|
|
155
155
|
//#endregion
|
|
156
|
-
export {
|
|
156
|
+
export type { ApiExampleProps, ApiMemberProps, ApiSignatureProps, EnumMember, EnumMembersTableProps, Parameter, ParametersTableProps };
|
|
157
157
|
//# sourceMappingURL=index.d.ts.map
|