Rename tRpcAzureFunctionsPlugin to unstable prefix (#115)

thaitype · Jan 20, 2024 · e64d620 · e64d620
2 parents 2cd4626 + 4d2854e
commit e64d620
Show file tree

Hide file tree

Showing 7 changed files with 220 additions and 188 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -1 +1,2 @@
-.eslintrc.js
+.eslintrc.js
+examples
diff --git a/README.md b/README.md
@@ -87,7 +87,7 @@ npm start
 
 ### Available Adatpers
 
-- [azure-functions][@nammatham/azure-functions], Azure Functions Adapter for Nammatham
+- [azure-functions][@nammatham/azure-functions], Azure Functions Adapter for Nammatham, internally, Azure Functions in local dev mode is dependend on Express.js.
 
 ### Available Plugins
 

diff --git a/examples/azure-functions-with-trpc/README.md b/examples/azure-functions-with-trpc/README.md
@@ -1,5 +1,23 @@
 # @examples/azure-functions-with-trpc
 
+> Unstable API, please use in your own risk, any PRs are welcome!
+
+## Usage
+
+```ts
+// No need to call expressPlugin() in dev mode, as it is already called by nammathamTrpcPlugin()
+// app.register(expressPlugin());
+app.register(
+  unstable__tRpcAzureFunctionsPlugin({
+    prefix: '/trpc',
+    trpcOptions: {
+      router: appRouter,
+      createContext,
+    }
+  })
+);
+```
+
 ## Run Dev Server 
 
 ```

diff --git a/examples/azure-functions-with-trpc/src/main.ts b/examples/azure-functions-with-trpc/src/main.ts
@@ -1,11 +1,11 @@
-import { tRpcAzureFunctionsPlugin } from '@nammatham/trpc-azure-functions';
+import { unstable__tRpcAzureFunctionsPlugin } from '@nammatham/trpc-azure-functions';
 import { app } from './nammatham';
 import { appRouter, createContext } from './router';
 
 // No need to call expressPlugin() in dev mode, as it is already called by nammathamTrpcPlugin()
 // app.register(expressPlugin());
 app.register(
-  tRpcAzureFunctionsPlugin({
+  unstable__tRpcAzureFunctionsPlugin({
     prefix: '/trpc',
     trpcOptions: {
       router: appRouter,

diff --git a/examples/azure-functions-with-trpc/src/nammatham.ts b/examples/azure-functions-with-trpc/src/nammatham.ts
@@ -2,7 +2,6 @@ import { initNammatham } from '@nammatham/core';
 import { AzureFunctionsAdapter } from '@nammatham/azure-functions';
 
 const n = initNammatham.create(new AzureFunctionsAdapter());
-n.func;
-// ^?
+
 export const func = n.func;
 export const app = n.app;
diff --git a/packages/trpc-azure-functions/src/trpc-azure-functions.ts b/packages/trpc-azure-functions/src/trpc-azure-functions.ts
@@ -19,7 +19,12 @@ export interface TrpcAzureFunctionsPluginOption<TRouter extends AnyRouter> {
   expressPluginOption?: ExpressServerOption;
 }
 
-export function tRpcAzureFunctionsPlugin<TRouter extends AnyRouter>(option: TrpcAzureFunctionsPluginOption<TRouter>) {
+/**
+ * tRPC plugin for AzureFunctions
+ * Unstable, some features are not implemented yet.
+ */
+
+export function unstable__tRpcAzureFunctionsPlugin<TRouter extends AnyRouter>(option: TrpcAzureFunctionsPluginOption<TRouter>) {
   return (app: NammathamApp, handlerResolver: BaseHandlerResolver) => {
     logger.info(`Using plugin: tRPC for AzureFunctions`);