Feathers is a full-stack framework for creating web APIs and real-time applications with TypeScript or JavaScript.

Feathers can interact with any backend technology, supports many databases out of the box and works with any frontend like React, VueJS, Angular, React Native, Android or iOS.

Getting started

Get started with just three commands:

$ npm create feathers my-new-app
$ cd my-new-app
$ npm run dev

To learn more about Feathers visit the website at feathersjs.com or jump right into the Feathers guides.

Contributing

To start developing, clone this repository, then run:

cd feathers
npm install

To run all tests run

npm test

Individual tests can be run in the module you are working on:

cd packages/feathers
npm test

License

Copyright (c) 2024 Feathers contributors

Licensed under the MIT license.

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

5.0.34 (2025-05-03)

Bug Fixes

• Update dependencies (#3584) (119fa4e)

5.0.33 (2025-02-24)

Bug Fixes

• dependencies: Update dependencies (#3571) (ad611cb)

5.0.32 (2025-02-01)

Note: Version bump only for package @feathersjs/transport-commons

5.0.31 (2024-10-31)

Bug Fixes

• dependencies: Update all dependencies (#3545) (221b92b)

5.0.30 (2024-09-02)

Note: Version bump only for package @feathersjs/transport-commons

5.0.29 (2024-07-10)

Note: Version bump only for package @feathersjs/transport-commons

5.0.28 (2024-07-10)

Bug Fixes

• transport-commons: Fix HTTP status precedence (#3511) (5d999a0)

5.0.27 (2024-06-18)

Note: Version bump only for package @feathersjs/transport-commons

5.0.26 (2024-06-09)

Note: Version bump only for package @feathersjs/transport-commons

5.0.25 (2024-05-03)

Bug Fixes

• Reduce usage of lodash (#3455) (8ce807a)

5.0.24 (2024-03-13)

Bug Fixes

• socketio: Handle ackTimeout of socket.io (#3437) (2642072)

5.0.23 (2024-02-25)

Bug Fixes

• core: Update to latest feathersjs/hooks (#3434) (1499ccc)
• transport-commons: Properly delete route data (#3433) (af01bdb)

5.0.22 (2024-02-15)

Note: Version bump only for package @feathersjs/transport-commons

5.0.21 (2024-01-25)

Note: Version bump only for package @feathersjs/transport-commons

5.0.20 (2024-01-24)

Note: Version bump only for package @feathersjs/transport-commons

5.0.19 (2024-01-23)

Note: Version bump only for package @feathersjs/transport-commons

5.0.18 (2024-01-22)

Note: Version bump only for package @feathersjs/transport-commons

5.0.17 (2024-01-22)

Note: Version bump only for package @feathersjs/transport-commons

5.0.16 (2024-01-22)

Note: Version bump only for package @feathersjs/transport-commons

5.0.15 (2024-01-22)

Note: Version bump only for package @feathersjs/transport-commons

5.0.14 (2024-01-05)

Note: Version bump only for package @feathersjs/transport-commons

5.0.13 (2023-12-29)

Note: Version bump only for package @feathersjs/transport-commons

5.0.12 (2023-11-28)

Bug Fixes

• transport-commons: Allow case insensitive route lookups (#3353) (a4a5ab6)

5.0.11 (2023-10-11)

Bug Fixes

• client: Replace placeholders in URL with route params (#3270) (a0624eb)
• knex: Update all dependencies and Knex peer (#3308) (d2f9860)

5.0.10 (2023-10-03)

Note: Version bump only for package @feathersjs/transport-commons

5.0.9 (2023-09-27)

Bug Fixes

• client: Add underscored methods to clients (#3176) (f3c01f7)

5.0.8 (2023-07-19)

Bug Fixes

• transport-commons: Handle invalid service paths on socket lookups (#3241) (c397ab3)

5.0.7 (2023-07-14)

Note: Version bump only for package @feathersjs/transport-commons

5.0.6 (2023-06-15)

Note: Version bump only for package @feathersjs/transport-commons

5.0.5 (2023-04-28)

Note: Version bump only for package @feathersjs/transport-commons

5.0.4 (2023-04-12)

Note: Version bump only for package @feathersjs/transport-commons

5.0.3 (2023-04-05)

Bug Fixes

• dependencies: Update all dependencies (#3139) (f24276e)

5.0.1 (2023-03-15)

Bug Fixes

• core: Use Symbol.for to instantiate shared symbols (#3087) (7f3fc21)
• transport-commons: Fix dispatching of arrays (#3075) (98fdda5)

5.0.0 (2023-02-24)

Note: Version bump only for package @feathersjs/transport-commons

5.0.0-pre.38 (2023-02-17)

Note: Version bump only for package @feathersjs/transport-commons

5.0.0-pre.37 (2023-02-09)

Note: Version bump only for package @feathersjs/transport-commons

5.0.0-pre.36 (2023-01-29)

Note: Version bump only for package @feathersjs/transport-commons

5.0.0-pre.35 (2023-01-12)

Features

• generators: Move core code generators to shared generators package (#2982) (0328d22)

5.0.0-pre.34 (2022-12-14)

Bug Fixes

• core: Improve service option usage and method option typings (#2902) (164d75c)

5.0.0-pre.33 (2022-11-08)

Note: Version bump only for package @feathersjs/transport-commons

5.0.0-pre.32 (2022-10-26)

Bug Fixes

• docs: Review transport API docs and update Express middleware setup (#2811) (1b97f14)

5.0.0-pre.31 (2022-10-12)

Features

• cli: Generate full client test suite and improve typed client (#2788) (57119b6)

5.0.0-pre.30 (2022-10-07)

Features

• core: Allow to unregister services at runtime (#2756) (d16601f)

5.0.0-pre.29 (2022-09-16)

Note: Version bump only for package @feathersjs/transport-commons

5.0.0-pre.28 (2022-08-03)

Bug Fixes

• cli: Improve generated application and client (#2701) (bd55ffb)

5.0.0-pre.27 (2022-07-13)

Bug Fixes

• socketio-client: Make Socket.io client event target compatible (#2686) (716c49a)

5.0.0-pre.26 (2022-06-22)

Note: Version bump only for package @feathersjs/transport-commons

5.0.0-pre.25 (2022-06-22)

Note: Version bump only for package @feathersjs/transport-commons

5.0.0-pre.24 (2022-06-21)

Note: Version bump only for package @feathersjs/transport-commons

5.0.0-pre.23 (2022-06-06)

Features

• client: Improve client side custom method support (#2654) (c138acf)

5.0.0-pre.22 (2022-05-24)

Note: Version bump only for package @feathersjs/transport-commons

5.0.0-pre.21 (2022-05-23)

Note: Version bump only for package @feathersjs/transport-commons

5.0.0-pre.20 (2022-05-04)

Bug Fixes

• dependencies: Lock monorepo package version numbers (#2623) (5640c10)

5.0.0-pre.19 (2022-05-01)

Bug Fixes

• transport-commons: Ensure socket queries are always plain objects (#2597) (97313e1)

5.0.0-pre.18 (2022-04-11)

Features

• transport-commons: add context.http.response (#2524) (5bc9d44)

5.0.0-pre.17 (2022-02-15)

Note: Version bump only for package @feathersjs/transport-commons

5.0.0-pre.16 (2022-01-12)

Features

• express, koa: make transports similar (#2486) (26aa937)

5.0.0-pre.15 (2021-11-27)

Bug Fixes

• typescript: Overall typing improvements (#2478) (b8eb804)

Features

• core: add context.http and move statusCode there (#2496) (b701bf7)
• transport-commons: Ability to register routes with custom params (#2482) (497990a)

5.0.0-pre.14 (2021-10-13)

Note: Version bump only for package @feathersjs/transport-commons

5.0.0-pre.13 (2021-10-13)

Note: Version bump only for package @feathersjs/transport-commons

5.0.0-pre.12 (2021-10-12)

Note: Version bump only for package @feathersjs/transport-commons

5.0.0-pre.11 (2021-10-06)

Note: Version bump only for package @feathersjs/transport-commons

5.0.0-pre.10 (2021-09-19)

Note: Version bump only for package @feathersjs/transport-commons

5.0.0-pre.9 (2021-08-09)

Note: Version bump only for package @feathersjs/transport-commons

5.0.0-pre.8 (2021-08-09)

Note: Version bump only for package @feathersjs/transport-commons

5.0.0-pre.7 (2021-08-09)

Note: Version bump only for package @feathersjs/transport-commons

5.0.0-pre.6 (2021-08-08)

Note: Version bump only for package @feathersjs/transport-commons

5.0.0-pre.5 (2021-06-23)

Bug Fixes

• koa: Use extended query parser for compatibility (#2397) (b2944ba)

5.0.0-pre.4 (2021-05-13)

Bug Fixes

• transport-commons: Fix route placeholder registration and improve radix router performance (#2336) (4d84dfd)

Features

• koa: KoaJS transport adapter (#2315) (2554b57)

5.0.0-pre.3 (2021-04-21)

Bug Fixes

• typescript: Improve TypeScript backwards compatibility (#2310) (f33be73)

Features

• dependencies: Remove direct debug dependency (#2296) (501d416)

5.0.0-pre.2 (2021-04-06)

Note: Version bump only for package @feathersjs/transport-commons

5.0.0-beta.1 (2021-04-03)

Note: Version bump only for package @feathersjs/transport-commons

5.0.0-beta.0 (2021-03-28)

Bug Fixes

• transport-commons: Do not error when adding an undefined connection to a channel (#2268) (28114c4)
• Update Grant usage and other dependencies (#2264) (7b0f8fa)
• socketio-client: Fix client transport-commons reference (#2164) (3a42c54)

Features

• core: Public custom service methods (#2270) (e65abfb)
• Application service types default to any (#1566) (d93ba9a)
• Feathers v5 core refactoring and features (#2255) (2dafb7c)
• transport-commons: New built-in high performance radix router (#2177) (6d18065)

5.0.0-pre.1 (2020-12-17)

5.0.0-pre.0 (2020-05-19)

Features

• core: use @feathers/hooks and add async type (#1929) (a5c4756)
• transport-commons: Remove legacy message format and unnecessary client timeouts (#1939) (5538881)

BREAKING CHANGES

• transport-commons: Removes the old message format and client service timeout

5.0.0-pre.0 (2020-05-19)

Features

• core: use @feathers/hooks and add async type (#1929) (a5c4756)
• transport-commons: Remove legacy message format and unnecessary client timeouts (#1939) (5538881)

BREAKING CHANGES

• transport-commons: Removes the old message format and client service timeout

4.5.11 (2020-12-05)

Bug Fixes

• socketio-client: Throw an error and show a warning if someone tries to use socket.io-client v3 (#2135) (cc3521c)

4.5.10 (2020-11-08)

Note: Version bump only for package @feathersjs/transport-commons

4.5.9 (2020-10-09)

Note: Version bump only for package @feathersjs/transport-commons

4.5.8 (2020-08-12)

Note: Version bump only for package @feathersjs/transport-commons

4.5.7 (2020-07-24)

Note: Version bump only for package @feathersjs/transport-commons

4.5.5 (2020-07-11)

Note: Version bump only for package @feathersjs/transport-commons

4.5.3 (2020-04-17)

Note: Version bump only for package @feathersjs/transport-commons

4.5.2 (2020-03-04)

Note: Version bump only for package @feathersjs/transport-commons

4.5.1 (2020-01-24)

Note: Version bump only for package @feathersjs/transport-commons

4.5.0 (2020-01-18)

Note: Version bump only for package @feathersjs/transport-commons

4.4.3 (2019-12-06)

Note: Version bump only for package @feathersjs/transport-commons

4.4.1 (2019-11-27)

Bug Fixes

• Gracefully handle errors in publishers (#1710) (0616306)

4.4.0 (2019-11-27)

Bug Fixes

• transport-commons: Allow to properly chain SocketIo client.off (#1706) (a4aecbc)

4.3.11 (2019-11-11)

Note: Version bump only for package @feathersjs/transport-commons

4.3.10 (2019-10-26)

Note: Version bump only for package @feathersjs/transport-commons

4.3.9 (2019-10-26)

Note: Version bump only for package @feathersjs/transport-commons

4.3.7 (2019-10-14)

Note: Version bump only for package @feathersjs/transport-commons

4.3.4 (2019-10-03)

Note: Version bump only for package @feathersjs/transport-commons

4.3.3 (2019-09-21)

Note: Version bump only for package @feathersjs/transport-commons

4.3.2 (2019-09-16)

Note: Version bump only for package @feathersjs/transport-commons

4.3.1 (2019-09-09)

Bug Fixes

• Fix regression in transport commons (#1551) (ed9e934)

4.3.0 (2019-08-27)

Note: Version bump only for package @feathersjs/transport-commons

4.3.0-pre.4 (2019-08-22)

Note: Version bump only for package @feathersjs/transport-commons

4.3.0-pre.3 (2019-08-19)

Bug Fixes

• Expire and remove authenticated real-time connections (#1512) (2707c33)
• Update all dependencies (7d53a00)
• Use WeakMap to connect socket to connection (#1509) (64807e3)

4.3.0-pre.2 (2019-08-02)

Bug Fixes

• Add getEntityId to JWT strategy and fix legacy Socket authentication (#1488) (9a3b324)
• Improve Params typing (#1474) (54a3aa7)

4.3.0-pre.1 (2019-07-11)

Note: Version bump only for package @feathersjs/transport-commons

4.0.0-pre.5 (2019-07-10)

Note: Version bump only for package @feathersjs/transport-commons

4.0.0-pre.4 (2019-07-05)

Bug Fixes

• Clean up hooks code (#1407) (f25c88b)
• Improve transport-commons types (#1396) (f9d8536)

4.0.0-pre.3 (2019-06-01)

Bug Fixes

• Make oAuth paths more consistent and improve authentication client (#1377) (adb2543)
• Update dependencies and fix tests (#1373) (d743a7f)

4.0.0-pre.2 (2019-05-15)

Bug Fixes

• Add fallback for legacy socket authenticate event (#1356) (61b1056)
• Throw NotAuthenticated on token verification errors (#1357) (e0120df)

Features

• Add global disconnect event (#1355) (85afcca)

4.0.0-pre.1 (2019-05-08)

Bug Fixes

• Add registerPublisher alias for .publish (#1302) (98fe8f8)

4.0.0-pre.0 (2019-04-21)

Bug Fixes

• Compare socket event data using lodash's isEqual instead of indexOf (#1061) (f706db3)
• Make Mocha a proper devDependency for every repository (#1053) (9974803)
• Update adapter common tests (#1135) (8166dda)
• Update all dependencies to latest (#1206) (e51e0f6)
• package: update debug to version 3.0.0 (#45) (9b9bde5)

Features

• Add TypeScript definitions (#1275) (9dd6713)
• Allow registering a service at the root level (#1115) (c73d322)

4.2.1 (2019-01-02)

Bug Fixes

• Update adapter common tests (#1135) (8166dda)

4.2.0 (2018-12-16)

Features

• Allow registering a service at the root level (#1115) (c73d322)

4.1.6 (2018-10-25)

Bug Fixes

• Compare socket event data using lodash's isEqual instead of indexOf (#1061) (f706db3)
• Make Mocha a proper devDependency for every repository (#1053) (9974803)

4.1.5 (2018-09-21)

Note: Version bump only for package @feathersjs/transport-commons

4.1.4 (2018-09-17)

Note: Version bump only for package @feathersjs/transport-commons

4.1.3 (2018-09-02)

Note: Version bump only for package @feathersjs/transport-commons

4.1.2

• Migrate to Monorepo (feathers#462)

v4.1.1 (2018-07-03)

Full Changelog

Merged pull requests:

• Properly dispatch arrays that do not come from Feathers hook events #77 (daffl)

v4.1.0 (2018-06-28)

Full Changelog

Merged pull requests:

• Remove empty channels #75 (daffl)

v4.0.2 (2018-06-12)

Full Changelog

Merged pull requests:

• Fix looking up invalid path names through sockets #76 (daffl)

v4.0.1 (2018-05-30)

Full Changelog

Merged pull requests:

• Update Codeclimate settings #74 (daffl)

v4.0.0 (2018-02-09)

Full Changelog

Closed issues:

• Additional data for client errors #72

Merged pull requests:

• Throw a Timeout error on send timeout instead of Error #73 (TimNZ)
• Pass connection in params #71 (daffl)
• Move socket handling into its own file #70 (daffl)

v3.2.0 (2018-01-30)

Full Changelog

Closed issues:

• Publishing to a channel fails after passing safety check #66
• Feathers Server Ends unexpected if some arg to socket.io is a ipv6 local subnet #65

Merged pull requests:

• Rename to @feathersjs/transport-commons #69 (daffl)
• Switch to Radix tree based routing #68 (daffl)
• Update mocha to the latest version 🚀 #64 (greenkeeper[bot])
• Update semistandard to the latest version 🚀 #63 (greenkeeper[bot])

v3.1.5 (2017-12-12)

Full Changelog

v3.1.4 (2017-12-12)

Full Changelog

Merged pull requests:

• Fix dispatching of arrays #62 (daffl)

v3.1.3 (2017-12-12)

Full Changelog

Merged pull requests:

• Make sure that each entry in an array is dispatched as its own even #61 (daffl)

v3.1.2 (2017-12-06)

Full Changelog

Merged pull requests:

• Fix another error when there are no results #60 (daffl)

v3.1.1 (2017-12-06)

Full Changelog

Merged pull requests:

• Always use a combined channel #59 (daffl)

v3.1.0 (2017-12-06)

Full Changelog

Merged pull requests:

• Give channel dispatchers a precedence #58 (daffl)

v3.0.1 (2017-11-03)

Full Changelog

Closed issues:

• Allow socket calls without params and callback #54

Merged pull requests:

• Allow socket calls without query and callback #55 (daffl)

v3.0.0 (2017-11-01)

Full Changelog

v3.0.0-pre.7 (2017-10-25)

Full Changelog

Merged pull requests:

• Update to better returnHook handling #53 (daffl)

v3.0.0-pre.6 (2017-10-21)

Full Changelog

Closed issues:

• feathers-socket-commons produces error when it get bundled and steal-socket.io gets used as connection #44
• Surface src/events.js lines 44-69 for feathers-hooks-common/src/filters/combine.js #40

Merged pull requests:

• Updates for Feathers v3 (Buzzard) #52 (daffl)
• Rename repository and use npm scope #51 (daffl)

v3.0.0-pre.5 (2017-10-18)

Full Changelog

Merged pull requests:

• Pass events property to the client #50 (daffl)

v3.0.0-pre.4 (2017-10-17)

Full Changelog

Merged pull requests:

• Fix the event name and add some channel debug statements #49 (daffl)

v3.0.0-pre.3 (2017-10-16)

Full Changelog

Merged pull requests:

• Update mocha to the latest version 🚀 #48 (greenkeeper[bot])

v3.0.0-pre.2 (2017-09-28)

Full Changelog

Merged pull requests:

• Add feathers-channels #47 (daffl)

v3.0.0-pre.1 (2017-09-08)

Full Changelog

Fixed bugs:

• Socket events don't fire for sub-apps nested more than 2 deep #5

Closed issues:

• more tests #38

Merged pull requests:

• Prepare v3.0-pre #46 (daffl)
• Update debug to the latest version 🚀 #45 (greenkeeper[bot])
• Update feathers-socketio to the latest version 🚀 #43 (greenkeeper[bot])
• Update semistandard to the latest version 🚀 #42 (greenkeeper[bot])
• Update dependencies to enable Greenkeeper 🌴 #41 (greenkeeper[bot])

v2.4.0 (2017-01-07)

Full Changelog

Implemented enhancements:

• support service.json #34
• Socket event filters should not force returning data #4
• bootstrap service.filters #37 (slajax)

Closed issues:

• Sockets timed out request - retry on reconnection [feat?] #32

Merged pull requests:

• Normalize arguments when client sends packed data. #39 (devel-pa)
• Create .codeclimate.yml #33 (larkinscott)
• Update feathers-commons to version 0.8.0 🚀 #31 (greenkeeperio-bot)
• jshint —> semistandard #30 (corymsmith)
• Code coverage #29 (ekryski)

v2.3.1 (2016-09-02)

Full Changelog

Merged pull requests:

• Make service off method be namespaced #26 (t2t2)
• Update mocha to version 3.0.0 🚀 #25 (greenkeeperio-bot)

v2.3.0 (2016-07-24)

Full Changelog

Fixed bugs:

• Error in filter chain for 'created' event after app.authenticate() #12

Merged pull requests:

• Skip subsequent filters instead of rejecting the promise #24 (daffl)

v2.2.1 (2016-07-05)

Full Changelog

v2.2.0 (2016-07-05)

Full Changelog

Implemented enhancements:

• Support native websockets directly #8

Fixed bugs:

• Calling off on primus fails #7

Closed issues:

• Should add other eventEmitter methods #22
• Patch event sends the whole data back #21

Merged pull requests:

• Pass all EventEmitter methods to the client connection #23 (daffl)

v2.1.0 (2016-05-29)

Full Changelog

Closed issues:

• Client should convert error objects to feathers-errors #19

Merged pull requests:

• Make client convert to feathers-errors #20 (daffl)

v2.0.0 (2016-05-23)

Full Changelog

Merged pull requests:

• Better handling of sub-apps and sockets #18 (daffl)
• Update babel-plugin-add-module-exports to version 0.2.0 🚀 #17 (greenkeeperio-bot)
• babel-polyfill@6.7.4 breaks build 🚨 #16 (greenkeeperio-bot)

v1.0.0 (2016-04-28)

Full Changelog

Implemented enhancements:

• Support acknowledgement timeouts #9

Closed issues:

• Feathers over sockets is totally silent when a hook has errors #13
• Listener warning when you register your own events on the socket #10

Merged pull requests:

• Support timeouts for socket clients #15 (daffl)
• Convert errors in socket callbacks #14 (daffl)

v0.2.3 (2016-04-16)

Full Changelog

Merged pull requests:

• Remove connection setMaxListeners #11 (daffl)

v0.2.2 (2016-03-22)

Full Changelog

Merged pull requests:

• Allow chaining event listeners. #6 (joshuajabbour)

v0.2.1 (2016-03-08)

Full Changelog

Merged pull requests:

• Set connection max listeners and better debug messages #3 (daffl)

v0.2.0 (2016-02-08)

Full Changelog

Merged pull requests:

• Query params #2 (ekryski)
• Adding nsp check #1 (marshallswain)

v0.1.0 (2016-01-21)

* _This Change Log was automatically generated by github_changelog_generator_