Skip to content

Commit

Permalink
Deployed d7621ff with MkDocs version: 1.5.3
Browse files Browse the repository at this point in the history
  • Loading branch information
beltebelt committed Jan 5, 2024
1 parent db343b3 commit cfde439
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion grpc/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ <h6 id="gethelpers-helpers"><em>getHelpers = (): Helpers</em></h6>

camoflageGrpc.start();
</code></pre>
<p>You can take a look at how inbuilt helpers have been created, in case you want to understand how custom helpers can be created. Refer to the <a href="UPDATE THIS">helper source code</a></p>
<p>You can take a look at how inbuilt helpers have been created, in case you want to understand how custom helpers can be created. Refer to the <a href="https://github.com/testinggospels/camouflage-helpers">helper source code</a></p>
<h6 id="addservice-service-grpcservicedefinition-implementation-grpcuntypedserviceimplementation-void"><em>addService = (service: grpc.ServiceDefinition<grpc.UntypedServiceImplementation>, implementation: grpc.UntypedServiceImplementation): void</em></h6>
<p><code>camoflageGrpc.addService</code> is wrapper on <code>@grpc/grpc-js</code> <code>addService</code> method. It allows you to load your proto package definitions/services/methods into Camoflage's grpc server. In the following example we load the <code>blog.proto</code> definition into a grpcObject and use it to provide implementation of the <code>createBlog</code> and <code>listBlogs</code> methods required by the proto definition</p>
<pre><code class="language-javascript">import CamoflageGrpc, { CamoflageGrpcHandler } from &quot;@camoflage/grpc&quot;;
Expand Down
2 changes: 1 addition & 1 deletion http/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ <h6 id="gethelpers-helpers"><em>getHelpers = (): Helpers</em></h6>

camoflageHttp.start();
</code></pre>
<p>You can take a look at how inbuilt helpers have been created, in case you want to understand how custom helpers can be created. Refer to the <a href="UPDATE THIS">helper source code</a>.</p>
<p>You can take a look at how inbuilt helpers have been created, in case you want to understand how custom helpers can be created. Refer to the <a href="https://github.com/testinggospels/camouflage-helpers">helper source code</a>.</p>
<h6 id="loadconfigfromjsonconfigfilepath-string-void"><em>loadConfigFromJson(configFilePath: string): void</em></h6>
<p>While you can include your config as part of your code and ensure the types yourself, you may at times want to maintain the configuration for your Camoflage server separate from the application code. This is usually a good practice from maintainability point of view, or even practical if you want to maintain multiple config files for different usecases.</p>
<p><code>loadConfigFromJson</code> lets you load a config via a .json file. You don't need to worry about validating your config file, Camoflage takes care of validating your config and prints relevant errors which help you fix your config files, if you miss something.</p>
Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -177,5 +177,5 @@ <h3 id="improved-security">Improved security</h3>

<!--
MkDocs version : 1.5.3
Build Date UTC : 2024-01-05 10:16:34.048330+00:00
Build Date UTC : 2024-01-05 10:33:44.004596+00:00
-->
Binary file modified sitemap.xml.gz
Binary file not shown.

0 comments on commit cfde439

Please sign in to comment.