# feathers-client

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

Latest version **2.4.0** (published 2017-09-02) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install feathers-client
pnpm add feathers-client
yarn add feathers-client
bun add feathers-client
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.4.0 |
| Published | 2017-09-02 |
| First published | 2015-06-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >= 4 |
| Dependencies | 7 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 112 |
| Author | Feathers contributors |
| Maintainers | daffl, ekryski, marshallswain |
| Keywords | feathers, feathers-plugin, batch, rest, api |

## Links

- npm: https://www.npmjs.com/package/feathers-client
- Repository: https://github.com/feathersjs/feathers-client
- Issues: https://github.com/feathersjs/feathers-client/issues
- npm.io page: https://npm.io/package/feathers-client

## Dependencies (7)

- [feathers](https://npm.io/package/feathers.md) 2.2.0
- [feathers-rest](https://npm.io/package/feathers-rest.md) 1.8.0
- [feathers-hooks](https://npm.io/package/feathers-hooks.md) 2.0.2
- [feathers-errors](https://npm.io/package/feathers-errors.md) 2.9.1
- [feathers-primus](https://npm.io/package/feathers-primus.md) 2.2.0
- [feathers-socketio](https://npm.io/package/feathers-socketio.md) 2.0.0
- [feathers-authentication-client](https://npm.io/package/feathers-authentication-client.md) ^0.3.1

## Recent versions

- 2.4.0 (latest) — 2017-09-02
- 2.0.0-pre.2 (pre) — 2017-03-08
- 2.3.0 — 2017-07-04
- 2.2.0 — 2017-04-25
- 2.1.0 — 2017-04-18
- 2.0.0 — 2017-04-11
- 2.0.0-pre.1 — 2017-01-11
- 2.0.1-0 — 2017-01-11
- 1.9.0 — 2016-12-31
- 1.8.0 — 2016-11-26
- 1.7.2 — 2016-11-08
- 1.7.1 — 2016-11-02
- 1.7.0 — 2016-11-02
- 1.6.2 — 2016-10-22
- 1.6.1 — 2016-09-15
- … 33 more at https://npm.io/package/feathers-client/versions

## README

# feathers-client

[![Greenkeeper badge](https://badges.greenkeeper.io/feathersjs/feathers-client.svg)](https://greenkeeper.io/)

[![Build Status](https://travis-ci.org/feathersjs/feathers-client.png?branch=master)](https://travis-ci.org/feathersjs/feathers-client)
[![Code Climate](https://codeclimate.com/github/feathersjs/feathers-client.png)](https://codeclimate.com/github/feathersjs/feathers-client)
[![Test Coverage](https://codeclimate.com/github/feathersjs/feathers-client/badges/coverage.svg)](https://codeclimate.com/github/feathersjs/feathers-client/coverage)
[![Dependency Status](https://img.shields.io/david/feathersjs/feathers-client.svg?style=flat-square)](https://david-dm.org/feathersjs/feathers-client)
[![Download Status](https://img.shields.io/npm/dm/feathers-client.svg?style=flat-square)](https://www.npmjs.com/package/feathers-client)
[![Slack Status](http://slack.feathersjs.com/badge.svg)](http://slack.feathersjs.com)

[![Sauce Test Status](https://saucelabs.com/browser-matrix/feathersjs.svg)](https://saucelabs.com/u/feathersjs)

> A client for Feathers services supporting many different transport libraries.

## About

While Feathers and its modules can be used on the client with an NPM compatible module loader like [Browserify](http://browserify.org/), [Webpack](https://webpack.github.io/) or [StealJS](http://stealjs.com), `feathers-client` consolidates a standard set of client plugins into a single distributable that can be used standalone in the browser or with other module loaders (like [RequireJS](http://requirejs.org/)) that don't support NPM. The following modules are included:

- [feathers](https://github.com/feathersjs/feathers) as `feathers` (or the default module export)
- [feathers-hooks](https://github.com/feathersjs/feathers-hooks) as `feathers.hooks`
- [feathers-authentication](https://github.com/feathersjs/feathers-authentication) as `feathers.authentication`
- [feathers-rest](https://github.com/feathersjs/feathers-rest) as `feathers.rest`
- [feathers-socketio](https://github.com/feathersjs/feathers-socketio) as `feathers.socketio`
- [feathers-primus](https://github.com/feathersjs/feathers-primus) as `feathers.primus`

In the browser a client that connects to the local server via websockets can be initialized like this:

```html
<script type="text/javascript" src="/socket.io/socket.io.js"></script>
<script type="text/javascript" src="//cdn.rawgit.com/feathersjs/feathers-client/v1.1.0/dist/feathers.js"></script>
<script type="text/javascript">
  var socket = io();
  var client = feathers()
    .configure(feathers.hooks())
    .configure(feathers.socketio(socket));
  var todoService = client.service('todos');
  
  todoService.on('created', function(todo) {
    console.log('Someone created a todo', todo);
  });
  
  todoService.create({
    description: 'Todo from client'
  });
</script>
```

For the full documentation see [the Feathers documentation](http://docs.feathersjs.com/clients/feathers.html).

## License

Copyright (c) 2015 [Feathers contributors](https://github.com/feathersjs/feathers-client/graphs/contributors)

Licensed under the [MIT license](LICENSE).

---
_Source: https://npm.io/package/feathers-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._