|
7 | 7 | [](https://www.npmjs.com/package/feathers-hooks-common)
|
8 | 8 | [](http://slack.feathersjs.com)
|
9 | 9 |
|
10 |
| -> Useful hooks for use with Feathers services. |
| 10 | +A collection of useful hooks to use with Feathers services. |
11 | 11 |
|
12 |
| ---- |
13 |
| - |
14 |
| -> Use feathers-hooks-common v3.10.0 with FeathersJS v2 (Auk). |
15 |
| -
|
16 |
| -> Use feathers-hooks-common v4.x.x with FeathersJS v3 (Buzzard). |
17 |
| -
|
18 |
| -## Migration to v4 (for FeathersJS v3 Buzzard) from v3 (for FeathersJSv2 Auk). |
19 |
| - |
20 |
| - - Docs moved to [feathers-plus web site](https://feathers-plus.github.io/v1/feathers-hooks-common/guide.html). |
21 |
| - |
22 |
| - - v4.x.x now supports FeathersJS v3 (Buzzard). Continue using v3.10.0 for FeathersJS v2 (Auk). |
23 |
| - - Removed: |
24 |
| - - Removed support for the deprecated legacy syntax in `populate`. |
25 |
| - - Removed the deprecated `remove` hook in favor of `discard`. |
26 |
| - |
27 |
| - - Deprecated. These will be removed in FeathersJS v3 (Crow). |
28 |
| - - Deprecated `pluck` in favor of `iff(isProvider('external'),` `keep(...fieldNames))`. **Be careful!** |
29 |
| - - Deprecated the `client` in favor of the `paramsFromClient`. |
30 |
| - |
31 |
| - - Added modules. They work with both FeathersJS v2 and v3. |
32 |
| - - `fastJoin` hook - Very fast alternative to `populate`. |
33 |
| - - `makeCallingParams` utility - Help construct `context.params` when calling services. |
| 12 | +``` |
| 13 | +npm install feathers-hooks-common --save |
| 14 | +``` |
34 | 15 |
|
35 | 16 | ## Documentation
|
36 | 17 |
|
37 |
| -Refer to [Feathers-Plus web site](https://feathers-plus.github.io/v1/feathers-hooks-common/guide.html). |
38 |
| - |
39 |
| -## Installation |
40 |
| - |
41 |
| -Run `npm install feathers-hooks-common --save` in your project folder (installs the latest v4 release). |
| 18 | +For the full list and API of available hooks and utilities, refer to the [feathers-hooks-common documentation](https://hooks-common.feathersjs.com/overview.html). |
42 | 19 |
|
43 | 20 | ## Tests
|
44 | 21 |
|
45 | 22 | `npm test` to run tests.
|
46 | 23 |
|
47 | 24 | ## License
|
48 | 25 |
|
49 |
| -See LICENSE. |
| 26 | +See [LICENSE](LICENSE). |
0 commit comments