@@ -75,8 +75,7 @@ weight: 77
7575
7676* [ Overview] ( #Overview ) ⇒ ` JSX.Element ` <br />
7777
78- Renders an overview section for a WebSocket client.
79- Displays the API description, version, and server URL.
78+ Renders an overview section for a WebSocket client. Displays the API description, version, and server URL.
8079
8180* [ Readme] ( #Readme ) ⇒ ` JSX.Element ` <br />
8281
@@ -96,12 +95,11 @@ Displays the API description, version, and server URL.
9695
9796* [ SendOperations] ( #SendOperations ) ⇒ ` Array.<JSX.Element> ` <br />
9897
99- Renders WebSocket send operation methods.
100- Generates both static and instance methods for sending messages through WebSocket connections.
98+ Renders WebSocket send operation methods. Generates both static and instance methods for sending messages through WebSocket connections.
10199
102100
103101<a name =" CloseConnection " ></a >
104- ## CloseConnection()
102+ ## CloseConnection()
105103Renders a WebSocket close connection method with optional pre- and post-execution logic.
106104
107105
@@ -157,7 +155,7 @@ renderCloseConnection();
157155
158156
159157<a name =" Connect " ></a >
160- ## Connect()
158+ ## Connect()
161159Renders a WebSocket connection method for the specified programming language.
162160
163161
@@ -198,7 +196,7 @@ renderConnect();
198196
199197
200198<a name =" DependencyProvider " ></a >
201- ## DependencyProvider()
199+ ## DependencyProvider()
202200Renders the top-of-file dependency statements for the selected programming language.
203201
204202
@@ -244,7 +242,7 @@ renderDependencyProvider();
244242
245243
246244<a name =" FileHeaderInfo " ></a >
247- ## FileHeaderInfo()
245+ ## FileHeaderInfo()
248246Renders a file header with metadata information such as title, version, protocol, host, and path.
249247
250248
@@ -296,7 +294,7 @@ renderFileHeader().catch(console.error);
296294
297295
298296<a name =" HandleMessage " ></a >
299- ## HandleMessage()
297+ ## HandleMessage()
300298Renders a WebSocket message handler method with optional pre- and post-execution logic.
301299
302300
@@ -354,7 +352,7 @@ renderHandleMessage();
354352
355353
356354<a name =" MethodGenerator " ></a >
357- ## MethodGenerator()
355+ ## MethodGenerator()
358356Renders a language-specific formatted method definition.
359357
360358
@@ -421,7 +419,7 @@ renderMethodGenerator();
421419
422420
423421<a name =" Models " ></a >
424- ## Models()
422+ ## Models()
425423Renders an array of model files based on the AsyncAPI document.
426424
427425
@@ -475,7 +473,7 @@ renderModel().catch(console.error);
475473
476474
477475<a name =" OnClose " ></a >
478- ## OnClose()
476+ ## OnClose()
479477Renders a WebSocket onClose event handler for the specified programming language.
480478
481479
@@ -519,7 +517,7 @@ renderOnClose();
519517
520518
521519<a name =" OnError " ></a >
522- ## OnError()
520+ ## OnError()
523521Renders a WebSocket onError event handler for the specified programming language.
524522
525523
@@ -555,7 +553,7 @@ renderOnError();
555553
556554
557555<a name =" OnMessage " ></a >
558- ## OnMessage()
556+ ## OnMessage()
559557Renders a WebSocket onMessage event handler for the specified programming language.
560558
561559
@@ -591,7 +589,7 @@ renderOnMessage();
591589
592590
593591<a name =" OnOpen " ></a >
594- ## OnOpen()
592+ ## OnOpen()
595593Renders a WebSocket onOpen event handler for the specified programming language.
596594
597595
@@ -635,7 +633,7 @@ renderOnOpen();
635633
636634
637635<a name =" QueryParamsVariables " ></a >
638- ## QueryParamsVariables()
636+ ## QueryParamsVariables()
639637Renders query parameter variables code blocks.
640638
641639
@@ -694,7 +692,7 @@ renderQueryParamsVariable().catch(console.error);
694692
695693
696694<a name =" AvailableOperations " ></a >
697- ## AvailableOperations()
695+ ## AvailableOperations()
698696Renders a list of AsyncAPI operations with their headers and message examples.
699697
700698
@@ -739,7 +737,7 @@ renderAvailableOperations().catch(console.error);
739737
740738
741739<a name =" CoreMethods " ></a >
742- ## CoreMethods()
740+ ## CoreMethods()
743741Renders a list of core WebSocket client methods for a given target language.
744742
745743
@@ -775,7 +773,7 @@ renderCoreMethods();
775773
776774
777775<a name =" Installation " ></a >
778- ## Installation()
776+ ## Installation()
779777Renders the Installation Command for a given language.
780778
781779
@@ -811,7 +809,7 @@ renderInstallation()
811809
812810
813811<a name =" MessageExamples " ></a >
814- ## MessageExamples()
812+ ## MessageExamples()
815813Renders Message Examples of a given AsyncAPI operation.
816814
817815
@@ -859,7 +857,7 @@ renderMessageExamples().catch(console.error);
859857
860858
861859<a name =" OperationHeader " ></a >
862- ## OperationHeader()
860+ ## OperationHeader()
863861Renders a header section for a single AsyncAPI operation.
864862
865863
@@ -907,9 +905,8 @@ renderOperationHeader().catch(console.error);
907905
908906
909907<a name =" Overview " ></a >
910- ## Overview()
911- Renders an overview section for a WebSocket client.
912- Displays the API description, version, and server URL.
908+ ## Overview()
909+ Renders an overview section for a WebSocket client. Displays the API description, version, and server URL.
913910
914911
915912** Parameters**
@@ -965,7 +962,7 @@ renderOverview().catch(console.error);
965962
966963
967964<a name =" Readme " ></a >
968- ## Readme()
965+ ## Readme()
969966Renders a README.md file for a given AsyncAPI document. Composes multiple sections (overview, installation, usage, core methods, and available operations) into a single File component based on the provided AsyncAPI document, generator parameters, and target language.
970967
971968
@@ -1020,7 +1017,7 @@ renderReadme().catch(console.error);
10201017
10211018
10221019<a name =" Usage " ></a >
1023- ## Usage()
1020+ ## Usage()
10241021Renders a usage example snippet for a generated WebSocket client in a given language.
10251022
10261023
@@ -1064,7 +1061,7 @@ renderUsage();
10641061
10651062
10661063<a name =" RegisterErrorHandler " ></a >
1067- ## RegisterErrorHandler()
1064+ ## RegisterErrorHandler()
10681065Renders a WebSocket error handler registration method with optional pre- and post-execution logic.
10691066
10701067
@@ -1117,7 +1114,7 @@ renderRegisterErrorHandler();
11171114
11181115
11191116<a name =" RegisterMessageHandler " ></a >
1120- ## RegisterMessageHandler()
1117+ ## RegisterMessageHandler()
11211118Renders a WebSocket message handler registration method with optional pre- and post-execution logic.
11221119
11231120
@@ -1167,9 +1164,8 @@ renderRegisterMessageHandler();
11671164
11681165
11691166<a name =" SendOperations " ></a >
1170- ## SendOperations()
1171- Renders WebSocket send operation methods.
1172- Generates both static and instance methods for sending messages through WebSocket connections.
1167+ ## SendOperations()
1168+ Renders WebSocket send operation methods. Generates both static and instance methods for sending messages through WebSocket connections.
11731169
11741170
11751171** Parameters**
0 commit comments