Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@feathersjs/client

feathersjs29.8kMIT5.0.34TypeScript support: included

A module that consolidates Feathers client modules for REST (jQuery, Request, Superagent) and Websocket (Socket.io, Primus) connections

feathers, feathers-plugin

readme

Feathers - The API and real-time application framework

CI Maintainability Test Coverage Download Status Discord

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.

changelog

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

5.0.33 (2025-02-24)

Bug Fixes

5.0.32 (2025-02-01)

Note: Version bump only for package @feathersjs/client

5.0.31 (2024-10-31)

Bug Fixes

5.0.30 (2024-09-02)

Note: Version bump only for package @feathersjs/client

5.0.29 (2024-07-10)

Note: Version bump only for package @feathersjs/client

5.0.28 (2024-07-10)

Note: Version bump only for package @feathersjs/client

5.0.27 (2024-06-18)

Note: Version bump only for package @feathersjs/client

5.0.26 (2024-06-09)

Note: Version bump only for package @feathersjs/client

5.0.25 (2024-05-03)

Note: Version bump only for package @feathersjs/client

5.0.24 (2024-03-13)

Note: Version bump only for package @feathersjs/client

5.0.23 (2024-02-25)

Bug Fixes

5.0.22 (2024-02-15)

Note: Version bump only for package @feathersjs/client

5.0.21 (2024-01-25)

Note: Version bump only for package @feathersjs/client

5.0.20 (2024-01-24)

Note: Version bump only for package @feathersjs/client

5.0.19 (2024-01-23)

Note: Version bump only for package @feathersjs/client

5.0.18 (2024-01-22)

Note: Version bump only for package @feathersjs/client

5.0.17 (2024-01-22)

Note: Version bump only for package @feathersjs/client

5.0.16 (2024-01-22)

Note: Version bump only for package @feathersjs/client

5.0.15 (2024-01-22)

Note: Version bump only for package @feathersjs/client

5.0.14 (2024-01-05)

Note: Version bump only for package @feathersjs/client

5.0.13 (2023-12-29)

Note: Version bump only for package @feathersjs/client

5.0.12 (2023-11-28)

Note: Version bump only for package @feathersjs/client

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

5.0.9 (2023-09-27)

Note: Version bump only for package @feathersjs/client

5.0.8 (2023-07-19)

Note: Version bump only for package @feathersjs/client

5.0.7 (2023-07-14)

Note: Version bump only for package @feathersjs/client

5.0.6 (2023-06-15)

Note: Version bump only for package @feathersjs/client

5.0.5 (2023-04-28)

Note: Version bump only for package @feathersjs/client

5.0.4 (2023-04-12)

Note: Version bump only for package @feathersjs/client

5.0.3 (2023-04-05)

Bug Fixes

5.0.2 (2023-03-23)

Note: Version bump only for package @feathersjs/client

5.0.1 (2023-03-15)

Note: Version bump only for package @feathersjs/client

5.0.0 (2023-02-24)

Note: Version bump only for package @feathersjs/client

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

Note: Version bump only for package @feathersjs/client

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

Note: Version bump only for package @feathersjs/client

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

Bug Fixes

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

Note: Version bump only for package @feathersjs/client

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

Note: Version bump only for package @feathersjs/client

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

Note: Version bump only for package @feathersjs/client

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

Note: Version bump only for package @feathersjs/client

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

Note: Version bump only for package @feathersjs/client

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

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

Note: Version bump only for package @feathersjs/client

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

Note: Version bump only for package @feathersjs/client

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

Note: Version bump only for package @feathersjs/client

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

Note: Version bump only for package @feathersjs/client

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

Note: Version bump only for package @feathersjs/client

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

Note: Version bump only for package @feathersjs/client

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

Note: Version bump only for package @feathersjs/client

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

Note: Version bump only for package @feathersjs/client

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

  • client: Fix @feathersjs/client types field (#2596) (d719f54)

Features

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

Note: Version bump only for package @feathersjs/client

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

Note: Version bump only for package @feathersjs/client

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

Features

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

Note: Version bump only for package @feathersjs/client

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

Note: Version bump only for package @feathersjs/client

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

Note: Version bump only for package @feathersjs/client

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

Note: Version bump only for package @feathersjs/client

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

Note: Version bump only for package @feathersjs/client

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

Note: Version bump only for package @feathersjs/client

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

Note: Version bump only for package @feathersjs/client

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

Note: Version bump only for package @feathersjs/client

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

Note: Version bump only for package @feathersjs/client

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

Note: Version bump only for package @feathersjs/client

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)

Features

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

Bug Fixes

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

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

Note: Version bump only for package @feathersjs/client

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

  • Feathers v5 core refactoring and features (#2255) (2dafb7c)

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

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

chore

  • package: Remove @feathersjs/primus packages from core (#1919) (d20b7d5), closes #1899

Features

  • core: use @feathers/hooks and add async type (#1929) (a5c4756)

BREAKING CHANGES

  • package: Remove primus packages to be moved into the ecosystem.

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

chore

  • package: Remove @feathersjs/primus packages from core (#1919) (d20b7d5), closes #1899

Features

  • core: use @feathers/hooks and add async type (#1929) (a5c4756)

BREAKING CHANGES

  • package: Remove primus packages to be moved into the ecosystem.

4.5.11 (2020-12-05)

Note: Version bump only for package @feathersjs/client

4.5.10 (2020-11-08)

Bug Fixes

  • package: Fix clean script in non Unix environments (#2110) (09b62c0)

4.5.9 (2020-10-09)

Note: Version bump only for package @feathersjs/client

4.5.8 (2020-08-12)

Note: Version bump only for package @feathersjs/client

4.5.7 (2020-07-24)

Note: Version bump only for package @feathersjs/client

4.5.6 (2020-07-12)

Note: Version bump only for package @feathersjs/client

4.5.5 (2020-07-11)

Note: Version bump only for package @feathersjs/client

4.5.4 (2020-04-29)

Note: Version bump only for package @feathersjs/client

4.5.3 (2020-04-17)

Note: Version bump only for package @feathersjs/client

4.5.2 (2020-03-04)

Note: Version bump only for package @feathersjs/client

4.5.1 (2020-01-24)

Note: Version bump only for package @feathersjs/client

4.5.0 (2020-01-18)

Note: Version bump only for package @feathersjs/client

4.4.3 (2019-12-06)

Note: Version bump only for package @feathersjs/client

4.4.1 (2019-11-27)

Note: Version bump only for package @feathersjs/client

4.4.0 (2019-11-27)

Note: Version bump only for package @feathersjs/client

4.3.11 (2019-11-11)

Note: Version bump only for package @feathersjs/client

4.3.10 (2019-10-26)

Note: Version bump only for package @feathersjs/client

4.3.9 (2019-10-26)

Note: Version bump only for package @feathersjs/client

4.3.7 (2019-10-14)

Note: Version bump only for package @feathersjs/client

4.3.5 (2019-10-07)

Note: Version bump only for package @feathersjs/client

4.3.4 (2019-10-03)

Note: Version bump only for package @feathersjs/client

4.3.3 (2019-09-21)

Note: Version bump only for package @feathersjs/client

4.3.2 (2019-09-16)

Note: Version bump only for package @feathersjs/client

4.3.1 (2019-09-09)

Note: Version bump only for package @feathersjs/client

4.3.0 (2019-08-27)

Note: Version bump only for package @feathersjs/client

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

Note: Version bump only for package @feathersjs/client

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

Note: Version bump only for package @feathersjs/client

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

Note: Version bump only for package @feathersjs/client

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

Note: Version bump only for package @feathersjs/client

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

Bug Fixes

  • Fix feathers-memory dependency that did not get updated (9422b13)

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

Note: Version bump only for package @feathersjs/client

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

Bug Fixes

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

Bug Fixes

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

Bug Fixes

  • Improve authentication parameter handling (#1333) (6e77204)

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

Bug Fixes

Features

3.7.8 (2019-01-26)

Note: Version bump only for package @feathersjs/client

3.7.7 (2019-01-02)

Bug Fixes

3.7.6 (2018-12-16)

Bug Fixes

  • chore: Properly configure and run code linter (#1092) (fd3fc34)

3.7.5 (2018-10-26)

Note: Version bump only for package @feathersjs/client

3.7.4 (2018-10-25)

Bug Fixes

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

3.7.3 (2018-09-24)

Note: Version bump only for package @feathersjs/client

3.7.2 (2018-09-21)

Note: Version bump only for package @feathersjs/client

Change Log

v3.7.1 (2018-09-21)

Full Changelog

v3.7.0 (2018-09-18)

Full Changelog

Closed issues:

  • Cannot patch multiple items #267

Merged pull requests:

v3.6.0 (2018-09-03)

Full Changelog

Merged pull requests:

v3.5.6 (2018-08-13)

Full Changelog

v3.5.5 (2018-08-02)

Full Changelog

Closed issues:

  • IE11: TypeError: Object doesn't support property or method 'from' #270

Merged pull requests:

v3.5.4 (2018-07-19)

Full Changelog

Merged pull requests:

  • Update all dependencies to latest #268 (daffl)

v3.5.3 (2018-06-28)

Full Changelog

Merged pull requests:

v3.5.2 (2018-06-16)

Full Changelog

Closed issues:

  • service times out when sending any request to the server, not on localhost #264

Merged pull requests:

v3.5.1 (2018-06-03)

Full Changelog

Closed issues:

  • 'exports' is undefined #261
  • I got error from NuxtJS when I use FeathersJS client V3 #260

Merged pull requests:

v3.5.0 (2018-05-17)

Full Changelog

Merged pull requests:

v3.4.5 (2018-05-04)

Full Changelog

Merged pull requests:

v3.4.4 (2018-03-27)

Full Changelog

Merged pull requests:

v3.4.3 (2018-03-07)

Full Changelog

Closed issues:

  • Can't capture event on client side #253

Merged pull requests:

v3.4.2 (2018-02-16)

Full Changelog

Closed issues:

  • Feathers client now working with HTTPS self signed certs #250

Merged pull requests:

v3.4.1 (2018-02-10)

Full Changelog

Merged pull requests:

v3.4.0 (2018-02-09)

Full Changelog

Merged pull requests:

v3.3.2 (2018-02-09)

Full Changelog

Merged pull requests:

v3.3.1 (2018-02-05)

Full Changelog

Merged pull requests:

v3.3.0 (2018-01-26)

Full Changelog

Merged pull requests:

v3.2.0 (2018-01-24)

Full Changelog

Closed issues:

  • Index.d.ts has a lack of return-type annotation #238
  • feathers rest client call get but server execute find #237
  • EventEmitter memory leak detected #236

Merged pull requests:

v3.1.2 (2018-01-02)

Full Changelog

Closed issues:

  • Socket.io on iOS and Firefox don't work #225

Merged pull requests:

v3.1.1 (2017-12-05)

Full Changelog

Merged pull requests:

v3.1.0 (2017-11-16)

Full Changelog

Merged pull requests:

v3.0.0 (2017-11-01)

Full Changelog

Merged pull requests:

  • Update dependencies for release #214 (daffl)

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

Full Changelog

Closed issues:

  • help data - angularjs #210
  • npm packages are installed even if they already exist when creating a new sequelize mysql service #209
  • Do you need feathers setup on the server to use feathers on the client? #196
  • Reorganization of client-side repositories #137

Merged pull requests:

v2.4.0 (2017-09-02)

Full Changelog

Closed issues:

  • Feathers Authentication returning NotFound: Page not found #188
  • Typescript import build error #179

Merged pull requests:

v2.3.0 (2017-07-04)

Full Changelog

Closed issues:

  • An in-range update of socket.io-client is breaking the build 🚨 #181
  • Drop socket.io #177
  • Providing client connection metadata for service event filtering purpose #172
  • Support offline mode #29

Merged pull requests:

v2.2.0 (2017-04-25)

Full Changelog

Merged pull requests:

v2.1.0 (2017-04-18)

Full Changelog

Closed issues:

  • implementation of feathers client in angular-2 #135

Merged pull requests:

v2.0.0 (2017-04-11)

Full Changelog

Closed issues:

  • Bundled feathers.js - Socket Authentication with Local Strategy Always Times Out #155

Merged pull requests:

v2.0.0-pre.2 (2017-03-08)

Full Changelog

Closed issues:

  • Authentication should be removed #136

Merged pull requests:

v2.0.0-pre.1 (2017-01-11)

Full Changelog

Closed issues:

  • Socket.io timeout does nothing when there is JWT token available #129

Merged pull requests:

v1.9.0 (2016-12-31)

Full Changelog

Closed issues:

  • Typings don't include configure method #130

Merged pull requests:

v1.8.0 (2016-11-26)

Full Changelog

Closed issues:

  • How to get hooks socketio etc from feathers object #118
  • send back to server additional fields in 'params' besides 'query' #115

Merged pull requests:

v1.7.2 (2016-11-08)

Full Changelog

Merged pull requests:

v1.7.1 (2016-11-02)

Full Changelog

Closed issues:

  • Bower: Version mismatch #104

Merged pull requests:

v1.7.0 (2016-11-02)

Full Changelog

Closed issues:

  • How to access feathers-client #102
  • Set up Saucelabs #97

Merged pull requests:

v1.6.2 (2016-10-22)

Full Changelog

Closed issues:

  • Browser Support #96
  • How to destroy feathers and socketio client? #95
  • Use tests from feathers-commons #26

Merged pull requests:

v1.6.1 (2016-09-15)

Full Changelog

Closed issues:

  • documentation on how to build client #87

Merged pull requests:

v1.6.0 (2016-09-09)

Full Changelog

Closed issues:

  • How to declare the app in a static way? #86
  • feathers client and requireJS #85
  • SocketIO timeout based on service #84

Merged pull requests:

v1.5.3 (2016-08-31)

Full Changelog

Closed issues:

  • Use of feathers-client with es6 (JSPM) #78

Merged pull requests:

v1.5.2 (2016-08-12)

Full Changelog

Closed issues:

  • [Question] Large client-side bundle filesize when requiring feathers client #71

Merged pull requests:

v1.5.1 (2016-07-14)

Full Changelog

Merged pull requests:

v1.5.0 (2016-07-05)

Full Changelog

Closed issues:

  • Refresh browser #68

v1.4.1 (2016-06-27)

Full Changelog

v1.4.0 (2016-06-24)

Full Changelog

Closed issues:

  • feathers.min.js? #64
  • Facebook login #62

Merged pull requests:

v1.3.2 (2016-06-09)

Full Changelog

Merged pull requests:

v1.3.1 (2016-06-04)

Full Changelog

Merged pull requests:

v1.3.0 (2016-05-30)

Full Changelog

Merged pull requests:

v1.2.1 (2016-05-19)

Full Changelog

Closed issues:

  • Feathers-client not return correct error object. #44

Merged pull requests:

  • Lock versions for Greenkeeper to make a PR for every release #50 (daffl)
  • Update babel-plugin-add-module-exports to version 0.2.0 🚀 #46 (greenkeeperio-bot)

v1.2.0 (2016-04-29)

Full Changelog

Closed issues:

  • Socket.io timeouts? #42
  • Add batch support #4

Merged pull requests:

v1.1.0 (2016-04-03)

Full Changelog

Merged pull requests:

v1.0.0 (2016-03-14)

Full Changelog

Merged pull requests:

  • Use a gcc version that can build bcrypt #30 (daffl)

v1.0.0-pre.3 (2016-03-14)

Full Changelog

v1.0.0-pre.2 (2016-03-04)

Full Changelog

Closed issues:

  • Can't get $regex to work in find function with feathers-nedb in the background #28
  • feathers.fetch is undefined #27
  • Add documentation for using in React Native #10

v0.5.3 (2016-02-12)

Full Changelog

v1.0.0-pre.1 (2016-02-11)

Full Changelog

v0.5.2 (2016-02-09)

Full Changelog

Merged pull requests:

v0.5.1 (2016-01-15)

Full Changelog

Closed issues:

  • REST base.js missing ${options.base} leads to broken relative url #21
  • Add hook support #20
  • $sort does not work for find() #19

Merged pull requests:

v0.5.0 (2016-01-05)

Full Changelog

Closed issues:

  • how to use in typescript #17

Merged pull requests:

v0.4.0 (2015-12-11)

Full Changelog

Fixed bugs:

  • Importing in ES6 is broken #14

Closed issues:

  • .babelrc messes with react-native #15

v0.3.3 (2015-11-27)

Full Changelog

Closed issues:

  • npm package is broken. #12

Merged pull requests:

v0.3.2 (2015-11-26)

Full Changelog

Closed issues:

  • Update lodash #11

v0.3.1 (2015-11-26)

Full Changelog

Closed issues:

  • Working with can-connect #8

v0.3.0 (2015-11-15)

Full Changelog

Closed issues:

  • Use Promises #7

Merged pull requests:

  • Migration to ES6 and using Promises #9 (daffl)

v0.2.1 (2015-10-06)

Full Changelog

Merged pull requests:

  • Make client depend on feathers-commons, remove arguments.js #6 (daffl)

v0.2.0 (2015-07-18)

Full Changelog

v0.1.3 (2015-07-06)

Full Changelog

Merged pull requests:

v0.1.2 (2015-06-22)

Full Changelog

Closed issues:

  • Publish to NPM and Bower #1

v0.1.1 (2015-06-21)

Full Changelog

v0.0.1 (2015-06-21)

Full Changelog

v0.1.0 (2015-06-06)

* This Change Log was automatically generated by [githubchangelog_generator](https://github.com/skywinder/Github-Changelog-Generator)_