Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/michallytek/routing-controllers-multiparam
A simple plugin for routing-controllers which allows to inject param from multiple sources.
https://github.com/michallytek/routing-controllers-multiparam
decorator express koa nodejs routing-controllers typescript typescript-library
Last synced: about 1 month ago
JSON representation
A simple plugin for routing-controllers which allows to inject param from multiple sources.
- Host: GitHub
- URL: https://github.com/michallytek/routing-controllers-multiparam
- Owner: MichalLytek
- License: mit
- Created: 2017-10-07T14:03:17.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-10-10T08:32:39.000Z (over 7 years ago)
- Last Synced: 2024-12-09T03:55:49.234Z (about 1 month ago)
- Topics: decorator, express, koa, nodejs, routing-controllers, typescript, typescript-library
- Language: TypeScript
- Homepage:
- Size: 33.2 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# routing-controllers-multiparam
[](https://badge.fury.io/js/routing-controllers-multiparam)
[](https://david-dm.org/19majkel94/routing-controllers-multiparam)
[](https://david-dm.org/19majkel94/routing-controllers-multiparam#info=devDependencies)
[](https://david-dm.org/19majkel94/routing-controllers-multiparam#info=devDependencies)
A simple plugin for [routing-controllers](https://github.com/pleerock/routing-controllers) which allows to inject param from multiple sources.
## Installation
#### Module installation
`npm install routing-controllers-multiparam --save`
(or the short way with NPM v5):
`npm i routing-controllers-multiparam`
#### Peer dependencies
This package is only a plugin, so you have to install the `routing-controllers` package because it can't work without it.
## Usage
The usage of this module is very simple. All you need is:
```ts
import { JsonController, Post, createExpressServer } from "routing-controllers";
// import the `@MultiParam` decorator and `ParamType` enum from the module
import { MultiParam, ParamType } from "routing-controllers-multiparam";
// declare the controller class using routing-controllers decorators
@JsonController()
class ProductsController {
// example use case:
// register action on two routes and get `categoryId` param from query or path so both routes will work
@Get("/products")
@Get("/categories/:categoryId/products")
getProductsByCategory(
// use the `@MultiParam` decorator to define the sources of the param to inject
@MultiParam("categoryId", { required: true, allow: [ParamType.QueryParam, ParamType.Param] })
categoryId: string,
) {
return {
categoryId,
};
}
}
// start the server
createExpressServer({ controllers: [SampleController] }).listen(3000);
```
And that's it! This will lead to inject the first non-undefined value from the list of sources, so when you specify `categoryId` param in path but not as a query string, it will be injected. It works just like switch-case - finds first source that exist.
## API reference
#### Function signatures
The `@MultiParam` decorator has two overloads:
```ts
export function MultiParam(options: NamedParamOptions): ParameterDecorator;
```
```ts
export function MultiParam(paramName: string, options: UnamedParamOptions): ParameterDecorator;
```
#### Parameters and types
- `NamedParamOptions` - a type of object that property `allow` can be a dictionary of allowed types:
```ts
{
required?: boolean;
allow: {
[P in ParamType]?: string | string[];
};
};
```
So the usage is just like this:
```ts
@MultiParam({ allow: {
[ParamType.QueryParam]: ["api_key", "apiKey"],
[ParamType.HeaderParam]: "X-Auth-Api-Key",
}})
```
- `UnamedParamOptions` - a type of object that property `allow` can be `ParamType` or array of `ParamType`
```ts
{
required?: boolean;
allow: ParamType | ParamType[];
};
```
It can be used only with `paramName` parameter when you want to get the param from multiple source but which is avaible on the same name:
```ts
@MultiParam("apiKey", { allow: [ParamType.QueryParam, ParamType.HeaderParam] })
```
## Known limitation/issues
* param normalization doesn't work - number params aren't casted from string (TBD after routing-controller `0.8.x` release)
* there's no validation and transforming options (only primitives are supported)
## More info
If you need more examples of usage, go to the sources and check unit tests file (`/src/decorators/MultiParam.spec.ts`).
If you have questions or new features/ideas, feel free to open an issue on GitHub repository.
## Release notes
**0.1.0**
* initial version with basic `@MultiParam` decorator support