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/socketio

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/socketio

5.0.29 (2024-07-10)

Note: Version bump only for package @feathersjs/socketio

5.0.28 (2024-07-10)

Note: Version bump only for package @feathersjs/socketio

5.0.27 (2024-06-18)

Note: Version bump only for package @feathersjs/socketio

5.0.26 (2024-06-09)

Note: Version bump only for package @feathersjs/socketio

5.0.25 (2024-05-03)

Bug Fixes

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

5.0.24 (2024-03-13)

Note: Version bump only for package @feathersjs/socketio

5.0.23 (2024-02-25)

Bug Fixes

• core: Update to latest feathersjs/hooks (#3434) (1499ccc)

5.0.22 (2024-02-15)

Note: Version bump only for package @feathersjs/socketio

5.0.21 (2024-01-25)

Note: Version bump only for package @feathersjs/socketio

5.0.20 (2024-01-24)

Note: Version bump only for package @feathersjs/socketio

5.0.19 (2024-01-23)

Note: Version bump only for package @feathersjs/socketio

5.0.18 (2024-01-22)

Note: Version bump only for package @feathersjs/socketio

5.0.17 (2024-01-22)

Note: Version bump only for package @feathersjs/socketio

5.0.16 (2024-01-22)

Note: Version bump only for package @feathersjs/socketio

5.0.15 (2024-01-22)

Note: Version bump only for package @feathersjs/socketio

5.0.14 (2024-01-05)

Note: Version bump only for package @feathersjs/socketio

5.0.13 (2023-12-29)

Note: Version bump only for package @feathersjs/socketio

5.0.12 (2023-11-28)

Note: Version bump only for package @feathersjs/socketio

5.0.11 (2023-10-11)

Bug Fixes

• knex: Update all dependencies and Knex peer (#3308) (d2f9860)

5.0.10 (2023-10-03)

Note: Version bump only for package @feathersjs/socketio

5.0.9 (2023-09-27)

Note: Version bump only for package @feathersjs/socketio

5.0.8 (2023-07-19)

Note: Version bump only for package @feathersjs/socketio

5.0.7 (2023-07-14)

Note: Version bump only for package @feathersjs/socketio

5.0.6 (2023-06-15)

Note: Version bump only for package @feathersjs/socketio

5.0.5 (2023-04-28)

Note: Version bump only for package @feathersjs/socketio

5.0.4 (2023-04-12)

Bug Fixes

• Make sure all Readme files are up to date (#3154) (a5f0b38)

5.0.3 (2023-04-05)

Bug Fixes

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

5.0.1 (2023-03-15)

Note: Version bump only for package @feathersjs/socketio

5.0.0 (2023-02-24)

Note: Version bump only for package @feathersjs/socketio

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

Note: Version bump only for package @feathersjs/socketio

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

Note: Version bump only for package @feathersjs/socketio

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

Note: Version bump only for package @feathersjs/socketio

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

• socketio: Disconnect socket on app disconnect event (#2896) (4ba0039)

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

Note: Version bump only for package @feathersjs/socketio

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

Bug Fixes

• authentication: Improve logout and disconnect connection handling (#2813) (dd77379)
• docs: Review transport API docs and update Express middleware setup (#2811) (1b97f14)

Features

• cli: Add authentication client to generated client (#2801) (bd59f91)

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

Note: Version bump only for package @feathersjs/socketio

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

Bug Fixes

• core: Ensure setup and teardown can be overriden and maintain hook functionality (#2779) (ab580cb)

Features

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

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

Bug Fixes

• socketio: Reinitialize hooks on overriden setup method (#2722) (5e8e7c4)

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)

Note: Version bump only for package @feathersjs/socketio

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

Note: Version bump only for package @feathersjs/socketio

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

Note: Version bump only for package @feathersjs/socketio

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

Note: Version bump only for package @feathersjs/socketio

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

Note: Version bump only for package @feathersjs/socketio

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

Note: Version bump only for package @feathersjs/socketio

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

Note: Version bump only for package @feathersjs/socketio

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)

Features

• typescript: Improve params and query typeability (#2600) (df28b76)

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

Note: Version bump only for package @feathersjs/socketio

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

Note: Version bump only for package @feathersjs/socketio

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

Note: Version bump only for package @feathersjs/socketio

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

Bug Fixes

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

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

Note: Version bump only for package @feathersjs/socketio

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

Note: Version bump only for package @feathersjs/socketio

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

Note: Version bump only for package @feathersjs/socketio

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

Note: Version bump only for package @feathersjs/socketio

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

Note: Version bump only for package @feathersjs/socketio

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

Note: Version bump only for package @feathersjs/socketio

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

Note: Version bump only for package @feathersjs/socketio

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

Note: Version bump only for package @feathersjs/socketio

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

Note: Version bump only for package @feathersjs/socketio

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

Features

• adapter-commons: Add support for params.adapter option and move memory adapter to @feathersjs/memory (#2367) (a43e7da)

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

Note: Version bump only for package @feathersjs/socketio

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/socketio

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

Bug Fixes

• dependencies: Fix transport-commons dependency and update other dependencies (#2284) (05b03b2)

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

Bug Fixes

• Update Grant usage and other dependencies (#2264) (7b0f8fa)

Features

• core: Public custom service methods (#2270) (e65abfb)
• Application service types default to any (#1566) (d93ba9a)
• Feathers v5 core refactoring and features (#2255) (2dafb7c)
• core: Remove Uberproto (#2178) (ddf8821)

BREAKING CHANGES

• core: Services no longer extend Uberproto objects and service.mixin() is no longer available.

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

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

Features

• 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

• 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)

Note: Version bump only for package @feathersjs/socketio

4.5.10 (2020-11-08)

Note: Version bump only for package @feathersjs/socketio

4.5.9 (2020-10-09)

Note: Version bump only for package @feathersjs/socketio

4.5.8 (2020-08-12)

Note: Version bump only for package @feathersjs/socketio

4.5.7 (2020-07-24)

Note: Version bump only for package @feathersjs/socketio

4.5.6 (2020-07-12)

Note: Version bump only for package @feathersjs/socketio

4.5.5 (2020-07-11)

Note: Version bump only for package @feathersjs/socketio

4.5.4 (2020-04-29)

Note: Version bump only for package @feathersjs/socketio

4.5.3 (2020-04-17)

Note: Version bump only for package @feathersjs/socketio

4.5.2 (2020-03-04)

Note: Version bump only for package @feathersjs/socketio

4.5.1 (2020-01-24)

Note: Version bump only for package @feathersjs/socketio

4.5.0 (2020-01-18)

Note: Version bump only for package @feathersjs/socketio

4.4.3 (2019-12-06)

Note: Version bump only for package @feathersjs/socketio

4.4.1 (2019-11-27)

Note: Version bump only for package @feathersjs/socketio

4.4.0 (2019-11-27)

Features

• authentication: Add parseStrategies to allow separate strategies for creating JWTs and parsing headers (#1708) (5e65629)

4.3.11 (2019-11-11)

Note: Version bump only for package @feathersjs/socketio

4.3.10 (2019-10-26)

Note: Version bump only for package @feathersjs/socketio

4.3.9 (2019-10-26)

Note: Version bump only for package @feathersjs/socketio

4.3.7 (2019-10-14)

Note: Version bump only for package @feathersjs/socketio

4.3.5 (2019-10-07)

Note: Version bump only for package @feathersjs/socketio

4.3.4 (2019-10-03)

Bug Fixes

• Typing improvements (#1580) (7818aec)

4.3.3 (2019-09-21)

Note: Version bump only for package @feathersjs/socketio

4.3.2 (2019-09-16)

Note: Version bump only for package @feathersjs/socketio

4.3.1 (2019-09-09)

Note: Version bump only for package @feathersjs/socketio

4.3.0 (2019-08-27)

Note: Version bump only for package @feathersjs/socketio

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

Note: Version bump only for package @feathersjs/socketio

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

Bug Fixes

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

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

Note: Version bump only for package @feathersjs/socketio

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

Note: Version bump only for package @feathersjs/socketio

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

Note: Version bump only for package @feathersjs/socketio

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

Note: Version bump only for package @feathersjs/socketio

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

Bug Fixes

• Update dependencies and fix tests (#1373) (d743a7f)

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

Bug Fixes

• Use export = in TypeScript definitions (#1285) (12d0f4b)

Features

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

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

Features

• Add params.headers to all transports when available (#1303) (ebce79b)

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

Bug Fixes

• Make Mocha a proper devDependency for every repository (#1053) (9974803)
• Update all dependencies to latest (#1206) (e51e0f6)
• package: update debug to version 3.0.0 (#83) (49f1de9)
• package: update socket.io to version 2.0.0 (#75) (d4a4b71)

chore

• drop support for Node.js 0.10 (#48) (3f7555a)

Features

• Add TypeScript definitions (#1275) (9dd6713)

BREAKING CHANGES

• This module no longer supports Node.js 0.10

3.2.9 (2019-01-02)

Note: Version bump only for package @feathersjs/socketio

3.2.8 (2018-12-16)

Note: Version bump only for package @feathersjs/socketio

3.2.7 (2018-10-25)

Bug Fixes

• Make Mocha a proper devDependency for every repository (#1053) (9974803)

3.2.6 (2018-09-21)

Note: Version bump only for package @feathersjs/socketio

3.2.5 (2018-09-17)

Note: Version bump only for package @feathersjs/socketio

3.2.4 (2018-09-02)

Note: Version bump only for package @feathersjs/socketio

3.2.3

• Migrate to Monorepo (feathers#462)

v3.2.2 (2018-06-03)

Full Changelog

Merged pull requests:

• Update uberproto to the latest version 🚀 #117 (greenkeeper[bot])

v3.2.1 (2018-04-04)

Full Changelog

Closed issues:

• Connection closed before receiving a handshake response #113
• yarn add @feathersjs/socketio gets stuck #112

Merged pull requests:

• Use latest version of Socket.io (2.1.0) #115 (daffl)

v3.2.0 (2018-02-09)

Full Changelog

Closed issues:

• My chat room sometimes the user's text has become????? #109

Merged pull requests:

• Update @feathersjs/transport-commons to the latest version 🚀 #111 (greenkeeper[bot])

v3.1.0 (2018-01-30)

Full Changelog

Closed issues:

• How to change 5000ms timeout? #107

Merged pull requests:

• Change dependency to @feathersjs/transport-commons #110 (daffl)
• Update mocha to the latest version 🚀 #108 (greenkeeper[bot])

v3.0.2 (2018-01-03)

Full Changelog

Closed issues:

• Updated from feathers-socketio to @feathersjs/socketio; error message #104
• How to stop listening to socket server from client service #103
• Options are not passed to socket-io #101
• feathers / graphql using REST / Sockets #97

Merged pull requests:

• Update Readme to correspond with latest release #106 (daffl)
• Update semistandard to the latest version 🚀 #105 (greenkeeper[bot])
• Update feathers-memory to the latest version 🚀 #102 (greenkeeper[bot])

v3.0.1 (2017-11-16)

Full Changelog

Closed issues:

• Remote address IP is always undefined #96

Merged pull requests:

• Add default export for better ES module (TypeScript) compatibility #100 (daffl)
• Updating client use example to fix imports #99 (corymsmith)

v3.0.0 (2017-11-01)

Full Changelog

Merged pull requests:

• Update dependencies for release #95 (daffl)
• Throw an error when using an incompatible version of Feathers #94 (daffl)

v2.0.1 (2017-10-31)

Full Changelog

Merged pull requests:

• Add an error when trying to use earlier versions with Feathers v3 #93 (daffl)

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

Full Changelog

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

Full Changelog

Merged pull requests:

• Rename repository and update to using npm scopes #92 (daffl)
• Updates for Feathers v3 (Buzzard) #91 (daffl)

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

Full Changelog

Merged pull requests:

• Some finishing touches for v3 #90 (daffl)

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

Full Changelog

Closed issues:

• Filter service updates by ID #87
• An in-range update of mocha is breaking the build 🚨 #86
• An in-range update of babel-cli is breaking the build 🚨 #85
• Connection closed before receiving a handshake response #84
• Maybe acting wrong please look into my test app #81
• Connecting to sockets on a path #80
• An in-range update of babel-core is breaking the build 🚨 #79
• An in-range update of mocha is breaking the build 🚨 #78
• Add Socket.io v2 support #77
• Any chance for socket.io-p2p support? #37

Merged pull requests:

• Finalizing updates for Feathers v3 #89 (daffl)
• Update mocha to the latest version 🚀 #88 (greenkeeper[bot])
• Update debug to the latest version 🚀 #83 (greenkeeper[bot])
• Update to latest plugin infrastructure #82 (daffl)

v2.0.0 (2017-05-10)

Full Changelog

Closed issues:

• An in-range update of feathers-hooks is breaking the build 🚨 #74
• An in-range update of debug is breaking the build 🚨 #73
• An in-range update of debug is breaking the build 🚨 #71

Merged pull requests:

• Update socket.io-client to the latest version 🚀 #76 (greenkeeper[bot])
• Update socket.io to the latest version 🚀 #75 (greenkeeper[bot])
• Update semistandard to the latest version 🚀 #72 (greenkeeper[bot])

v1.6.0 (2017-04-18)

Full Changelog

Closed issues:

• Add headers and remote ip address to socket.feathers #67

Merged pull requests:

• Update feathers-hooks to the latest version 🚀 #70 (greenkeeper[bot])
• Add port argument #69 (kozzztya)
• Update dependencies to enable Greenkeeper 🌴 #68 (greenkeeper[bot])

v1.5.2 (2017-03-03)

Full Changelog

Merged pull requests:

• Server-side socketio typedef to allow import \* as syntax when importing #65 (myknbani)

v1.5.1 (2017-03-02)

Full Changelog

Closed issues:

• Typescript definition bug #63

Merged pull requests:

• fix Typescript issue (#63) #64 (superbarne)
• feathers-hooks@1.8.0 breaks build 🚨 #62 (greenkeeperio-bot)

v1.5.0 (2017-03-01)

Full Changelog

Merged pull requests:

• Typescript Definitions #60 (AbraaoAlves)

v1.4.3 (2017-02-24)

Full Changelog

Closed issues:

• Get data after connection established #59
• Unable to use feathers from within React (Feathers vs SocketIO implementation setup issue) #51

Merged pull requests:

• Add option to set the maxListeners #61 (Faianca)
• Create .codeclimate.yml #56 (larkinscott)
• socket.io@1.7.1 breaks build 🚨 #54 (greenkeeperio-bot)
• Update feathers-memory to version 1.0.0 🚀 #50 (greenkeeperio-bot)
• Update feathers-commons to version 0.8.0 🚀 #49 (greenkeeperio-bot)

v1.4.2 (2016-11-02)

Full Changelog

Closed issues:

• Upgrade to socket.io 1.4 #39
• Disable/restrict failed request queue? #38
• Uncaught (in promise) Error: Timeout of 5000ms exceeded calling sites::find(…) #36
• Regarding plain websockets #34
• Clean way to subscribe to a filtered set of events #32
• "Can't find variable: Reflect" on bad requests/authentication token missing; react-native #31
• Client should convert error objects to feathers-errors #30

Merged pull requests:

• 👻😱 Node.js 0.10 is unmaintained 😱👻 #48 (greenkeeperio-bot)
• Swapping rm to rifraf and using relative path to _mocha for windows support #47 (corymsmith)
• jshint —> semistandard #46 (corymsmith)
• update feathers dev dependency #45 (ekryski)
• adding code coverage #44 (ekryski)
• socket.io-client@1.5.0 breaks build 🚨 #43 (greenkeeperio-bot)
• Update feathers-memory to version 0.8.0 🚀 #35 (greenkeeperio-bot)
• Update mocha to version 3.0.0 🚀 #33 (greenkeeperio-bot)

v1.4.1 (2016-05-23)

Full Changelog

Closed issues:

• README.md broken link to provider documentation #23
• Insecure Defaults Allow MITM Over TLS #22

Merged pull requests:

• mocha@2.5.0 breaks build 🚨 #28 (greenkeeperio-bot)
• Update feathers-socket-commons to version 2.0.0 🚀 #27 (greenkeeperio-bot)
• Update babel-plugin-add-module-exports to version 0.2.0 🚀 #26 (greenkeeperio-bot)
• fix link in README.md to feathers-socketio API docs #24 (ElliotPsyIT)

v1.4.0 (2016-04-28)

Full Changelog

Merged pull requests:

• Client timeout #21 (daffl)
• Update feathers-socket-commons to version 1.0.0 🚀 #20 (greenkeeperio-bot)
• nsp@2.3.2 breaks build 🚨 #18 (greenkeeperio-bot)
• More tests for error cases #16 (daffl)

v1.3.4 (2016-04-16)

Full Changelog

Merged pull requests:

• Increase the default number of maximum event listeners #15 (daffl)
• Update feathers-memory to version 0.7.0 🚀 #14 (greenkeeperio-bot)

v1.3.3 (2016-02-18)

Full Changelog

Closed issues:

• Needs possibility to pass options to io.listen() #12

Merged pull requests:

• Allow to pass Socket.io options #13 (daffl)

v1.3.2 (2016-02-11)

Full Changelog

Merged pull requests:

• Allow to instantiate a client instance #11 (daffl)

v1.3.1 (2016-02-09)

Full Changelog

v1.3.0 (2016-02-09)

Full Changelog

Merged pull requests:

• Update feathers-memory to version 0.6.0 🚀 #8 (greenkeeperio-bot)
• Update lodash to version 4.0.1 🚀 #7 (greenkeeperio-bot)
• Adding nsp check #6 (marshallswain)

v1.2.0 (2016-01-21)

Full Changelog

Closed issues:

• Better event filtering #2

Merged pull requests:

• Refactoring to use feathers-socket-commons that support event filtering #5 (daffl)
• Fixing .npmignore entries #3 (corymsmith)

v1.1.0 (2016-01-10)

Full Changelog

Merged pull requests:

• feathers-socketio/client service and tests #1 (daffl)

v1.0.0 (2016-01-03)

* _This Change Log was automatically generated by github_changelog_generator_