Skip to content

Add JSDoc comments, support @deprecated annotation #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 25, 2025
Merged

Add JSDoc comments, support @deprecated annotation #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
608ca13
Add JSDoc comments, support @deprecated annotation
VojtechVitek Mar 25, 2025
7afed2c
Add example & regenerate
VojtechVitek Mar 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions _examples/node-ts/server/server.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
/* eslint-disable */
// node-ts v1.0.0 f5566a7aae2c4d2f76cc64d8e55f9ac841447e43
// node-ts v1.0.0 642309974d39b8627aaa432be234932d66aaa816
// --
// Code generated by webrpc-gen@v0.23.0-1-g0d3483b with ../../../gen-typescript generator. DO NOT EDIT.
// Code generated by webrpc-gen@v0.24.0 with ../../../gen-typescript generator. DO NOT EDIT.
//
// webrpc-gen -schema=service.ridl -target=../../../gen-typescript -server -out=./server/server.gen.ts

export const WebrpcHeader = "Webrpc"

export const WebrpcHeaderValue = "webrpc@v0.23.0-1-g0d3483b;gen-typescript@unknown;node-ts@v1.0.0"
export const WebrpcHeaderValue = "webrpc@v0.24.0;gen-typescript@unknown;node-ts@v1.0.0"

// WebRPC description and code-gen version
export const WebRPCVersion = "v1"
Expand All @@ -16,7 +16,7 @@ export const WebRPCVersion = "v1"
export const WebRPCSchemaVersion = "v1.0.0"

// Schema hash generated from your RIDL schema
export const WebRPCSchemaHash = "f5566a7aae2c4d2f76cc64d8e55f9ac841447e43"
export const WebRPCSchemaHash = "642309974d39b8627aaa432be234932d66aaa816"

type WebrpcGenVersions = {
webrpcGenVersion: string;
Expand Down Expand Up @@ -89,7 +89,13 @@ export interface Page {
}

export interface ExampleService {
/**
* @deprecated Use /health endpoint instead.
*/
ping(headers?: object, signal?: AbortSignal): Promise<PingReturn>
/**
* GetUser returns a user by ID.
*/
getUser(args: GetUserArgs, headers?: object, signal?: AbortSignal): Promise<GetUserReturn>
}

Expand Down
3 changes: 3 additions & 0 deletions _examples/node-ts/service.ridl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,10 @@ struct Page
- num: uint32

service ExampleService
@deprecated:"Use /health endpoint instead."
- Ping() => ()

# GetUser returns a user by ID.
- GetUser(userID: uint64) => (code: uint32, user: User)

error 1000 Unauthorized "Unauthorized access" HTTP 401
Expand Down
14 changes: 10 additions & 4 deletions _examples/node-ts/webapp/client.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
/* eslint-disable */
// node-ts v1.0.0 f5566a7aae2c4d2f76cc64d8e55f9ac841447e43
// node-ts v1.0.0 642309974d39b8627aaa432be234932d66aaa816
// --
// Code generated by webrpc-gen@v0.23.0-1-g0d3483b with ../../../gen-typescript generator. DO NOT EDIT.
// Code generated by webrpc-gen@v0.24.0 with ../../../gen-typescript generator. DO NOT EDIT.
//
// webrpc-gen -schema=service.ridl -target=../../../gen-typescript -client -out=./webapp/client.gen.ts

export const WebrpcHeader = "Webrpc"

export const WebrpcHeaderValue = "webrpc@v0.23.0-1-g0d3483b;gen-typescript@unknown;node-ts@v1.0.0"
export const WebrpcHeaderValue = "webrpc@v0.24.0;gen-typescript@unknown;node-ts@v1.0.0"

// WebRPC description and code-gen version
export const WebRPCVersion = "v1"
Expand All @@ -16,7 +16,7 @@ export const WebRPCVersion = "v1"
export const WebRPCSchemaVersion = "v1.0.0"

// Schema hash generated from your RIDL schema
export const WebRPCSchemaHash = "f5566a7aae2c4d2f76cc64d8e55f9ac841447e43"
export const WebRPCSchemaHash = "642309974d39b8627aaa432be234932d66aaa816"

type WebrpcGenVersions = {
webrpcGenVersion: string;
Expand Down Expand Up @@ -89,7 +89,13 @@ export interface Page {
}

export interface ExampleService {
/**
* @deprecated Use /health endpoint instead.
*/
ping(headers?: object, signal?: AbortSignal): Promise<PingReturn>
/**
* GetUser returns a user by ID.
*/
getUser(args: GetUserArgs, headers?: object, signal?: AbortSignal): Promise<GetUserReturn>
}

Expand Down
4 changes: 2 additions & 2 deletions _examples/sse/webapp/client.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
/* eslint-disable */
// webrpc-sse-chat v1.0.0 a799dc63b082644f5d003c8881424546aee23a2c
// --
// Code generated by webrpc-gen@v0.23.0-1-g0d3483b with ../../ generator. DO NOT EDIT.
// Code generated by webrpc-gen@v0.24.0 with ../../ generator. DO NOT EDIT.
//
// webrpc-gen -schema=service.ridl -target=../../ -client -out=./webapp/client.gen.ts

export const WebrpcHeader = "Webrpc"

export const WebrpcHeaderValue = "webrpc@v0.23.0-1-g0d3483b;@unknown;webrpc-sse-chat@v1.0.0"
export const WebrpcHeaderValue = "webrpc@v0.24.0;@unknown;webrpc-sse-chat@v1.0.0"

// WebRPC description and code-gen version
export const WebRPCVersion = "v1"
Expand Down
16 changes: 16 additions & 0 deletions types.go.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,22 @@ export interface {{$type.Name}} {
{{- range $_, $service := $services}}
export interface {{$service.Name}} {
{{- range $_, $method := $service.Methods}}
{{- $deprecated := index $method.Annotations "deprecated" -}}
{{- if gt (len $method.Comments) 0 }}
/**
{{- range $_, $comment := $method.Comments }}
* {{ replaceAll $comment "\"" "'" }}
{{- end }}
{{- if $deprecated }}
*
* @deprecated {{ $deprecated.Value }}
{{- end }}
*/
{{- else if $deprecated }}
/**
* @deprecated {{ $deprecated.Value }}
*/
{{- end }}
{{firstLetterToLower $method.Name}}({{template "methodInputs" dict "Method" $method "TypeMap" $typeMap}}): {{if $method.StreamOutput}}WebrpcStreamController{{else}}Promise<{{$method.Name}}Return>{{end}}
{{- end}}
}
Expand Down