memory.md

In Memory

feathers-memory is a service adapters that stores its data in-memory. It can be used for temporary data that doesn't need to be persisted and testing purposes. It also works great with client-side Feathers applications.

$ npm install --save feathers-memory

Getting Started

You can create an in-memory service with no options:

const memory = require('feathers-memory');

app.use('/messages', memory());

This will create a messages datastore with the default configuration.

Options

The following options can be passed when creating a new memory service:

• id (default: 'id') [optional] - The name of the id field property.
• startId (default: 0) [optional] - An id number to start with that will be incremented for new record.
• store [optional] - An object with id to item assignments to pre-initialize the data store
• paginate [optional] - A pagination object containing a default and max page size (see the Pagination chapter)

Complete Example

Here is an example of a Feathers server with a messages in-memory service that supports pagination:

$ npm install feathers body-parser feathers-rest feathers-socketio feathers-memory

// app.js
const feathers = require('feathers');
const bodyParser = require('body-parser');
const rest = require('feathers-rest');
const socketio = require('feathers-socketio');
const memory = require('feathers-memory');

// Create a feathers instance.
const app = feathers()
  // Enable REST services
  .configure(rest())
  // Enable REST services
  .configure(socketio())
  // Turn on JSON parser for REST services
  .use(bodyParser.json())
  // Turn on URL-encoded parser for REST services
  .use(bodyParser.urlencoded({ extended: true }));

// Create an in-memory Feathers service with a default page size of 2 items
// and a maximum size of 4
app.use('/messages', memory({
  paginate: {
    default: 2,
    max: 4
  }
}));

// Create a dummy Message
app.service('messages').create({
  text: 'Server message',
  complete: false
}).then(function(message) {
  console.log('Created message', message);
});

// Start the server.
const port = 3030;

app.listen(port, function() {
  console.log(`Feathers server listening on port ${port}`);
});

Run the example with npm start and go to localhost:3030/messages. You will see the test Message that we created at the end of that file.