can-connect-feathers/service/service

The feathers-service behavior maps can-connect's DataInterface methods to FeathersJS's Service Interface methods.

| DataInterface method | Feathers method | HTTP method | Example Path |
|----------------------|-----------------|-------------|--------------|
| .getListData()       | .find()         | GET         | /todos       |
| .getData()           | .get()          | GET         | /todos/{id}  |
| .createData()        | .create()       | POST        | /todos       |
| .updateData()        | .update()       | PUT         | /todos/{id}  |
| not yet implemented  | .patch()        | PATCH       | /todos/{id}  |
| .destroyData()       | .remove()       | DELETE      | /todos/{id}  | 

Use

Setting up the Feathers Client is a prerequisite for using this behavior. See the can-connect-feathers page for an example of a basic Feathers Client configuration. With the Feathers client setup, it can be used with the feathers-service behavior as demonstrated in the example, below. Also note that the real-time behavior is included to receive real-time push events from the server.

// models/todo.js
var connect = require('can-connect');
var DefineMap = require('can-define/map/');
var DefineList = require('can-define/list/list');
var set = require("can-set");

// Bring in the feathers service behavior
var feathersServiceBehavior = require('can-connect-feathers/service');
var dataParse = require('can-connect/data/parse/');
var constructor = require('can-connect/constructor/');
var constructorStore = require('can-connect/constructor/store/');
var constructorCallbacksOnce = require('can-connect/constructor/callbacks-once/');
var canMap = require('can-connect/can/map/');
var canRef = require('can-connect/can/ref/');
var dataCallbacks = require('can-connect/data/callbacks/');
var realtime = require('can-connect/real-time/');

// Bring in the feathersClient instance.
var feathersClient = require('./feathers');

// Use feathersClient.service(url) to create a service
var todoService = feathersClient.service('/api/todos');

var Todo = DefineMap.extend('Todo', {
  _id: 'string',
  description: 'string',
  complete: 'boolean'
});

Todo.algebra = new set.Algebra(
  set.comparators.id('_id')
);

Todo.List = DefineList.extend({'*': Todo});

Todo.connection = connect([
  // Include the feathers service behavior in the behaviors list.
  feathersServiceBehavior,
  dataParse,
  constructor,
  constructorStore,
  constructorCallbacksOnce,
  canMap,
  canRef,
    // Include both the dataCallbacks and realtime behaviors.
  dataCallbacks,
  realtime
], {
  idProp: '_id',
  Map: Todo,
  List: Todo.List,
  // Pass the service as the `feathersService` property.
  feathersService: todoService,
  name: 'todos',
  algebra: Todo.algebra
});

module.exports = Todo;

In the above example, both Todo and Todo.connection will have methods for handling data, as described in the basic use section.