Skip to content

Commit

Permalink
doc(nammatham): fix broken linked
Browse files Browse the repository at this point in the history
  • Loading branch information
mildronize committed May 8, 2024
1 parent 0d2bd3e commit 5b32904
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 10 deletions.
2 changes: 1 addition & 1 deletion apps/nammatham/docs/concept/binding-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down
4 changes: 2 additions & 2 deletions apps/nammatham/docs/concept/define-azure-function.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
11 changes: 4 additions & 7 deletions apps/nammatham/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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

Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 5b32904

Please sign in to comment.