README.md

feathers-hooks-common

Useful hooks for use with Feathers services.

---

Use feathers-hooks-common v3.10.0 with FeathersJS v2 (Auk).

Use feathers-hooks-common v4.x.x with FeathersJS v3 (Buzzard).

Migration to v4 (for FeathersJS v3 Buzzard) from v3 (for FeathersJSv2 Auk).

• Docs moved to feathers-plus web site.

• v4.x.x now supports FeathersJS v3 (Buzzard). Continue using v3.10.0 for FeathersJS v2 (Auk).

  • Removed:

    • Removed support for the deprecated legacy syntax in populate.
    • Removed the deprecated remove hook in favor of discard.

  • Deprecated. These will be removed in FeathersJS v3 (Crow).

    • Deprecated pluck in favor of iff(isProvider('external'), keep(...fieldNames)). Be careful!
    • Deprecated the client in favor of the paramsFromClient.

  • Added modules. They work with both FeathersJS v2 and v3.

    • fastJoin hook - Very fast alternative to populate.
    • makeCallingParams utility - Help construct context.params when calling services.

Documentation

Refer to Feathers-Plus web site..

Installation

Run npm install feathers-hooks-common --save in your project folder (installs the latest v4 release).

Tests

npm test to run tests.

License

See LICENSE.