From 5b3290455ee1eafcb5e33f6ed92cad11b53656bf Mon Sep 17 00:00:00 2001 From: Thada Wangthammang Date: Wed, 8 May 2024 13:22:51 +0700 Subject: [PATCH] doc(nammatham): fix broken linked --- apps/nammatham/docs/concept/binding-type.md | 2 +- apps/nammatham/docs/concept/define-azure-function.md | 4 ++-- apps/nammatham/docs/intro.md | 11 ++++------- 3 files changed, 7 insertions(+), 10 deletions(-) diff --git a/apps/nammatham/docs/concept/binding-type.md b/apps/nammatham/docs/concept/binding-type.md index ac70fad..fa900a8 100644 --- a/apps/nammatham/docs/concept/binding-type.md +++ b/apps/nammatham/docs/concept/binding-type.md @@ -3,7 +3,7 @@ sidebar_position: 3 --- # All Built-in Binding Type -You can see all built-in binding type in [test case](packages/core/src/test-usecases/all-bindings/fixtures/functions/all-bindings.function.ts) as shown below: +You can see all built-in binding type in [test case](https://github.com/thaitype/nammatham/blob/v1.x/packages/core/src/test-usecases/all-bindings/fixtures/functions/all-bindings.function.ts) as shown below: ```ts import { BaseFunction, binding, functionName } from '../../../../main'; diff --git a/apps/nammatham/docs/concept/define-azure-function.md b/apps/nammatham/docs/concept/define-azure-function.md index 2879929..c94f4d5 100644 --- a/apps/nammatham/docs/concept/define-azure-function.md +++ b/apps/nammatham/docs/concept/define-azure-function.md @@ -111,9 +111,9 @@ const { req } = this.context.bindings; However, the `@azure/functions` doesn't provide any type binding based on `function.json`. -In case you want custom type for binding, please read the section [Custom Binding](define-azure-function.md#custom-binding) +In case you want custom type for binding, please read the section [Custom Binding](./define-azure-function.md#custom-binding) -# Custom Binding +## Custom Binding In `@functionName` decorator support any JSON Binding Object that you can self-define it. diff --git a/apps/nammatham/docs/intro.md b/apps/nammatham/docs/intro.md index 7269d73..2e3cd5e 100644 --- a/apps/nammatham/docs/intro.md +++ b/apps/nammatham/docs/intro.md @@ -63,11 +63,12 @@ export class UserFunction extends BaseFunction { - Cosmos DB, support both [v2](https://learn.microsoft.com/en-us/azure/azure-functions/functions-bindings-cosmosdb-v2-trigger?tabs=in-process%2Cfunctionsv2&pivots=programming-language-javascript#configuration) and [v4](https://learn.microsoft.com/en-us/azure/azure-functions/functions-bindings-cosmosdb-v2-trigger?tabs=in-process%2Cextensionv4&pivots=programming-language-javascript#configuration). - Blob - Service Bus - - If your binding type isn't in the list, please use [custom type](docs/define-azure-function.md#custom-binding) - - You can see [All available type support](docs/binding-type.md) or create a PR ;). + - If your binding type isn't in the list, please use [custom type](./concept/define-azure-function.md#custom-binding) + - You can see [All available type support](./concept/binding-type) or create a PR ;). - Support TypeScript and [InversifyJS](https://github.com/inversify/Inversify) as the [Most Popular Inversion of Control Container and Dependency Injection Approach](https://npmtrends.com/awilix-vs-bottlejs-vs-inversify-vs-node-dependency-injection-vs-tsyringe-vs-typedi-vs-typescript-ioc) - Build Tool Agnostic, this framework just provide the library. It can work with all TypeScript build tool e.g. tsc, esbuild, etc. + ## Installation You can install nammatham using npm: @@ -83,7 +84,7 @@ For the [InversifyJS](https://github.com/inversify/InversifyJS#-installation), p ## Getting Started -Full examples please, go to [examples](examples) directory +Full examples please, go to [examples](https://github.com/thaitype/nammatham/tree/v1.x/examples) directory ### 1. Basic @@ -243,10 +244,6 @@ builder.build(); export default builder.getApp(); ``` -## Documentation - -Please read the [full documentation in the repo](docs) - ## Inspiration - [Azure Functions .NET](https://learn.microsoft.com/en-us/azure/azure-functions/create-first-function-cli-csharp?tabs=azure-cli%2Cin-process) - [inversify-express-utils](https://github.com/inversify/inversify-express-utils) - We use inversify as a Dependency Injection Tool.