@arkormx/plugin-clear-router 0.1.45 → 0.1.48
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -15
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -19,12 +19,12 @@ import { Controller } from 'clear-router'
|
|
|
19
19
|
import { User } from './models/User'
|
|
20
20
|
|
|
21
21
|
class UserController extends Controller {
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
}
|
|
22
|
+
@Bind()
|
|
23
|
+
async show(user: User) {
|
|
24
|
+
return {
|
|
25
|
+
data: user,
|
|
27
26
|
}
|
|
27
|
+
}
|
|
28
28
|
}
|
|
29
29
|
|
|
30
30
|
Router.get('/users/:user', [UserController, 'show'])
|
|
@@ -42,11 +42,11 @@ Non-model arguments continue to resolve through Clear Router's container.
|
|
|
42
42
|
|
|
43
43
|
The plugin derives the route parameter name from the model class name:
|
|
44
44
|
|
|
45
|
-
| Model class | Route parameter
|
|
46
|
-
|
|
|
47
|
-
| `User`
|
|
48
|
-
| `Profile`
|
|
49
|
-
| `UserModel` | `:user` or `{user}`
|
|
45
|
+
| Model class | Route parameter |
|
|
46
|
+
| ----------- | ------------------------- |
|
|
47
|
+
| `User` | `:user` or `{user}` |
|
|
48
|
+
| `Profile` | `:profile` or `{profile}` |
|
|
49
|
+
| `UserModel` | `:user` or `{user}` |
|
|
50
50
|
|
|
51
51
|
Both Clear Router parameter styles are supported:
|
|
52
52
|
|
|
@@ -77,11 +77,11 @@ Models can override the default lookup by defining `resolveRouteBinding`:
|
|
|
77
77
|
import { Model } from 'arkormx'
|
|
78
78
|
|
|
79
79
|
export class User extends Model {
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
80
|
+
async resolveRouteBinding(value: unknown, field = 'id') {
|
|
81
|
+
return await User.query()
|
|
82
|
+
.whereKey(field as 'id', value as never)
|
|
83
|
+
.firstOrFail()
|
|
84
|
+
}
|
|
85
85
|
}
|
|
86
86
|
```
|
|
87
87
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@arkormx/plugin-clear-router",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.48",
|
|
4
4
|
"description": "Clear Router plugin for resolving Arkormx models from route parameters.",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"access": "public"
|
|
@@ -41,10 +41,10 @@
|
|
|
41
41
|
],
|
|
42
42
|
"dependencies": {
|
|
43
43
|
"reflect-metadata": "^0.2.2",
|
|
44
|
-
"arkormx": "^2.
|
|
44
|
+
"arkormx": "^2.10.0"
|
|
45
45
|
},
|
|
46
46
|
"peerDependencies": {
|
|
47
|
-
"clear-router": "^2.8.
|
|
47
|
+
"clear-router": "^2.8.9"
|
|
48
48
|
},
|
|
49
49
|
"devDependencies": {
|
|
50
50
|
"express": "^5.2.1",
|