@feathersjs/client

Important: The code for this module has been moved into the main Feathers repository at feathersjs/feathers (package direct link). Please open issues and pull requests there. No changes in your existing Feathers applications are necessary.

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, Webpack or StealJS, @feathersjs/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) that don't support NPM. The following modules are included:

• @feathersjs/feathers as feathers (or the default module export)
• @feathersjs/errors as feathers.errors
• @feathersjs/rest-client as feathers.rest
• @feathersjs/socketio-client as feathers.socketio
• @feathers/primus-client as feathers.primus
• @feathersjs/authentication-client as feathers.authentication

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

<script type="text/javascript" src="https://github.com/feathersjs-ecosystem/client/raw/master//unpkg.com/socket.io-client@1.7.3/dist/socket.io.js"></script>
<script type="text/javascript" src="https://github.com/feathersjs-ecosystem/client/raw/master//unpkg.com/@feathersjs/client@^3.0.0/dist/feathers.js"></script>
<script type="text/javascript">
  var socket = io();
  var client = feathers()
    .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.

License

Copyright (c) 2018 Feathers contributors

Licensed under the MIT license.