Skip to content

Commit 1e2442d

Browse files
zijianhuangzijianhuang
committed
api deprecated for TS
1 parent f55f28f commit 1e2442d

File tree

8 files changed

+35
-2
lines changed

8 files changed

+35
-2
lines changed

‎DemoCoreWeb/Scripts/ClientApi/WebApiCoreJQClientAuto.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -822,6 +822,7 @@ namespace DemoWebApi_Controllers_Client {
822822
/**
823823
* GET api/SuperDemo/DecimalZero
824824
* @return {number} Type: decimal
825+
* @deprecated Just for test
825826
*/
826827
getDecimalZero(callback: (data : number) => any, headersHandler?: () => {[header: string]: string}) {
827828
this.httpClient.get(this.baseUri + 'api/SuperDemo/DecimalZero', callback, this.error, this.statusCode, headersHandler);
@@ -860,6 +861,7 @@ namespace DemoWebApi_Controllers_Client {
860861
* Result of 0.1d + 0.2d - 0.3d
861862
* GET api/SuperDemo/DoubleZero
862863
* @return {number} Type: double
864+
* @deprecated for testing
863865
*/
864866
getDoubleZero(callback: (data : number) => any, headersHandler?: () => {[header: string]: string}) {
865867
this.httpClient.get(this.baseUri + 'api/SuperDemo/DoubleZero', callback, this.error, this.statusCode, headersHandler);
@@ -883,6 +885,7 @@ namespace DemoWebApi_Controllers_Client {
883885
/**
884886
* GET api/SuperDemo/FloatZero
885887
* @return {number} Type: float
888+
* @deprecated
886889
*/
887890
getFloatZero(callback: (data : number) => any, headersHandler?: () => {[header: string]: string}) {
888891
this.httpClient.get(this.baseUri + 'api/SuperDemo/FloatZero', callback, this.error, this.statusCode, headersHandler);

‎Fonlow.Poco2TsCore/AnnotationCommentGenerator.cs

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ public AnnotationCommentGenerator(bool forTS=false)
1818
generator.Add(typeof(ObsoleteAttribute), a => //https://jsdoc.app/tags-deprecated
1919
{
2020
ObsoleteAttribute obsoleteAttr = (ObsoleteAttribute)a;
21-
return $"@deprecated {obsoleteAttr.Message}" + (obsoleteAttr.IsError ? " ~ Is Error." : string.Empty);
21+
return GenerateComments(obsoleteAttr);
2222
});
2323
}
2424
else
@@ -82,5 +82,10 @@ public IDictionary<Type, Func<object, string>> Get()
8282
}
8383

8484
};
85+
86+
public static string GenerateComments(ObsoleteAttribute obsoleteAttr)
87+
{
88+
return $"@deprecated {obsoleteAttr.Message}" + (obsoleteAttr.IsError ? " ~ Is Error." : string.Empty);
89+
}
8590
}
8691
}

‎HeroesDemo/src/clientapi/WebApiCoreNG2FormGroupClientAuto.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -908,6 +908,7 @@ export namespace DemoWebApi_Controllers_Client {
908908
/**
909909
* GET api/SuperDemo/DecimalZero
910910
* @return {number} Type: decimal
911+
* @deprecated Just for test
911912
*/
912913
getDecimalZero(headersHandler?: () => HttpHeaders): Observable<number> {
913914
return this.http.get<number>(this.baseUri + 'api/SuperDemo/DecimalZero', { headers: headersHandler ? headersHandler() : undefined });
@@ -946,6 +947,7 @@ export namespace DemoWebApi_Controllers_Client {
946947
* Result of 0.1d + 0.2d - 0.3d
947948
* GET api/SuperDemo/DoubleZero
948949
* @return {number} Type: double
950+
* @deprecated for testing
949951
*/
950952
getDoubleZero(headersHandler?: () => HttpHeaders): Observable<number> {
951953
return this.http.get<number>(this.baseUri + 'api/SuperDemo/DoubleZero', { headers: headersHandler ? headersHandler() : undefined });
@@ -969,6 +971,7 @@ export namespace DemoWebApi_Controllers_Client {
969971
/**
970972
* GET api/SuperDemo/FloatZero
971973
* @return {number} Type: float
974+
* @deprecated
972975
*/
973976
getFloatZero(headersHandler?: () => HttpHeaders): Observable<number> {
974977
return this.http.get<number>(this.baseUri + 'api/SuperDemo/FloatZero', { headers: headersHandler ? headersHandler() : undefined });

‎HeroesDemo/src/clientapi/WebApiCoreNg2ClientAuto.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -829,6 +829,7 @@ export namespace DemoWebApi_Controllers_Client {
829829
/**
830830
* GET api/SuperDemo/DecimalZero
831831
* @return {number} Type: decimal
832+
* @deprecated Just for test
832833
*/
833834
getDecimalZero(headersHandler?: () => HttpHeaders): Observable<number> {
834835
return this.http.get<number>(this.baseUri + 'api/SuperDemo/DecimalZero', { headers: headersHandler ? headersHandler() : undefined });
@@ -867,6 +868,7 @@ export namespace DemoWebApi_Controllers_Client {
867868
* Result of 0.1d + 0.2d - 0.3d
868869
* GET api/SuperDemo/DoubleZero
869870
* @return {number} Type: double
871+
* @deprecated for testing
870872
*/
871873
getDoubleZero(headersHandler?: () => HttpHeaders): Observable<number> {
872874
return this.http.get<number>(this.baseUri + 'api/SuperDemo/DoubleZero', { headers: headersHandler ? headersHandler() : undefined });
@@ -890,6 +892,7 @@ export namespace DemoWebApi_Controllers_Client {
890892
/**
891893
* GET api/SuperDemo/FloatZero
892894
* @return {number} Type: float
895+
* @deprecated
893896
*/
894897
getFloatZero(headersHandler?: () => HttpHeaders): Observable<number> {
895898
return this.http.get<number>(this.baseUri + 'api/SuperDemo/FloatZero', { headers: headersHandler ? headersHandler() : undefined });

‎WebApiClientGenCore.Abstract/ClientApiTsFunctionGenAbstract.cs

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,16 @@ public abstract class ClientApiTsFunctionGenAbstract
3434
readonly IDictionary<Type, string> dotNetTypeCommentDic;
3535
readonly IDictionary<Type, Func<object, string>> attribueCommentDic;
3636

37+
protected ObsoleteAttribute obsoleteAttribute;
38+
3739
System.Reflection.ParameterInfo[] parameterInfoArray;
3840

3941
JSOutput jsOutput;
4042

4143
protected ClientApiTsFunctionGenAbstract()
4244
{
4345
dotNetTypeCommentDic = DotNetTypeCommentGenerator.Get();
44-
AnnotationCommentGenerator annotationCommentGenerator = new AnnotationCommentGenerator();
46+
AnnotationCommentGenerator annotationCommentGenerator = new AnnotationCommentGenerator(true);
4547
attribueCommentDic = annotationCommentGenerator.Get();
4648
}
4749

@@ -78,6 +80,9 @@ public CodeMemberMethod CreateApiFunction(WebApiDescription description, IPoco2C
7880
{
7981
ReturnTypeIsNullable = ReturnType != null && !Attribute.IsDefined(methodInfo.ReturnParameter, typeof(System.Diagnostics.CodeAnalysis.NotNullAttribute));
8082
}
83+
84+
var attributes = methodInfo.GetCustomAttributes<ObsoleteAttribute>();
85+
obsoleteAttribute = attributes.FirstOrDefault();
8186
}
8287
else
8388
{
@@ -220,6 +225,11 @@ void CreateDocComments()
220225
builder.AppendLine($"@return {{{returnTypeOfResponse}}} {returnComment}");
221226
}
222227

228+
if (obsoleteAttribute != null)
229+
{
230+
builder.AppendLine(AnnotationCommentGenerator.GenerateComments(obsoleteAttribute));
231+
}
232+
223233
Method.Comments.Add(new CodeCommentStatement(builder.ToString(), true));
224234
}
225235

‎aurelia/src/clientapi/WebApiCoreAureliaClientAuto.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -828,6 +828,7 @@ export namespace DemoWebApi_Controllers_Client {
828828
/**
829829
* GET api/SuperDemo/DecimalZero
830830
* @return {number} Type: decimal
831+
* @deprecated Just for test
831832
*/
832833
getDecimalZero(headersHandler?: () => {[header: string]: string}): Promise<number> {
833834
return this.http.get('api/SuperDemo/DecimalZero', { headers: headersHandler ? headersHandler() : undefined }).then(d => {if (d.status<=204) return d.json(); throw d;});
@@ -866,6 +867,7 @@ export namespace DemoWebApi_Controllers_Client {
866867
* Result of 0.1d + 0.2d - 0.3d
867868
* GET api/SuperDemo/DoubleZero
868869
* @return {number} Type: double
870+
* @deprecated for testing
869871
*/
870872
getDoubleZero(headersHandler?: () => {[header: string]: string}): Promise<number> {
871873
return this.http.get('api/SuperDemo/DoubleZero', { headers: headersHandler ? headersHandler() : undefined }).then(d => {if (d.status<=204) return d.json(); throw d;});
@@ -889,6 +891,7 @@ export namespace DemoWebApi_Controllers_Client {
889891
/**
890892
* GET api/SuperDemo/FloatZero
891893
* @return {number} Type: float
894+
* @deprecated
892895
*/
893896
getFloatZero(headersHandler?: () => {[header: string]: string}): Promise<number> {
894897
return this.http.get('api/SuperDemo/FloatZero', { headers: headersHandler ? headersHandler() : undefined }).then(d => {if (d.status<=204) return d.json(); throw d;});

‎axios/src/clientapi/WebApiCoreAxiosClientAuto.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -822,6 +822,7 @@ export namespace DemoWebApi_Controllers_Client {
822822
/**
823823
* GET api/SuperDemo/DecimalZero
824824
* @return {number} Type: decimal
825+
* @deprecated Just for test
825826
*/
826827
getDecimalZero(headersHandler?: () => {[header: string]: string}): Promise<number> {
827828
return Axios.get<number>(this.baseUri + 'api/SuperDemo/DecimalZero', { headers: headersHandler ? headersHandler() : undefined }).then(d => {if (d.status<=204) return d.data; throw d;});
@@ -860,6 +861,7 @@ export namespace DemoWebApi_Controllers_Client {
860861
* Result of 0.1d + 0.2d - 0.3d
861862
* GET api/SuperDemo/DoubleZero
862863
* @return {number} Type: double
864+
* @deprecated for testing
863865
*/
864866
getDoubleZero(headersHandler?: () => {[header: string]: string}): Promise<number> {
865867
return Axios.get<number>(this.baseUri + 'api/SuperDemo/DoubleZero', { headers: headersHandler ? headersHandler() : undefined }).then(d => {if (d.status<=204) return d.data; throw d;});
@@ -883,6 +885,7 @@ export namespace DemoWebApi_Controllers_Client {
883885
/**
884886
* GET api/SuperDemo/FloatZero
885887
* @return {number} Type: float
888+
* @deprecated
886889
*/
887890
getFloatZero(headersHandler?: () => {[header: string]: string}): Promise<number> {
888891
return Axios.get<number>(this.baseUri + 'api/SuperDemo/FloatZero', { headers: headersHandler ? headersHandler() : undefined }).then(d => {if (d.status<=204) return d.data; throw d;});

‎fetchapi/src/clientapi/WebApiCoreFetchClientAuto.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -820,6 +820,7 @@ export namespace DemoWebApi_Controllers_Client {
820820
/**
821821
* GET api/SuperDemo/DecimalZero
822822
* @return {number} Type: decimal
823+
* @deprecated Just for test
823824
*/
824825
getDecimalZero(headersHandler?: () => {[header: string]: string}): Promise<number> {
825826
return fetch(this.baseUri + 'api/SuperDemo/DecimalZero', { method: 'get', headers: headersHandler ? headersHandler() : undefined }).then(d => {if (d.status<=202) return d.json(); else if (d.status==204) return null; throw d;});
@@ -858,6 +859,7 @@ export namespace DemoWebApi_Controllers_Client {
858859
* Result of 0.1d + 0.2d - 0.3d
859860
* GET api/SuperDemo/DoubleZero
860861
* @return {number} Type: double
862+
* @deprecated for testing
861863
*/
862864
getDoubleZero(headersHandler?: () => {[header: string]: string}): Promise<number> {
863865
return fetch(this.baseUri + 'api/SuperDemo/DoubleZero', { method: 'get', headers: headersHandler ? headersHandler() : undefined }).then(d => {if (d.status<=202) return d.json(); else if (d.status==204) return null; throw d;});
@@ -881,6 +883,7 @@ export namespace DemoWebApi_Controllers_Client {
881883
/**
882884
* GET api/SuperDemo/FloatZero
883885
* @return {number} Type: float
886+
* @deprecated
884887
*/
885888
getFloatZero(headersHandler?: () => {[header: string]: string}): Promise<number> {
886889
return fetch(this.baseUri + 'api/SuperDemo/FloatZero', { method: 'get', headers: headersHandler ? headersHandler() : undefined }).then(d => {if (d.status<=202) return d.json(); else if (d.status==204) return null; throw d;});

0 commit comments

Comments
 (0)