@feathersjs/memory 5.0.3 → 5.0.4

package/CHANGELOG.md

@@ -3,6 +3,13 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [5.0.4](https://github.com/feathersjs/feathers/compare/v5.0.3...v5.0.4) (2023-04-12)
+
+### Bug Fixes
+
+- Make sure all Readme files are up to date ([#3154](https://github.com/feathersjs/feathers/issues/3154)) ([a5f0b38](https://github.com/feathersjs/feathers/commit/a5f0b38bbf2a11486415a39533bcc6c67fb51e3e))
+- **memory:** Fix memory adapter readme ([#3153](https://github.com/feathersjs/feathers/issues/3153)) ([a9d826a](https://github.com/feathersjs/feathers/commit/a9d826a7dbe7df4501fbf82a47d2c3a77ca9e0c0))
+
 ## [5.0.3](https://github.com/feathersjs/feathers/compare/v5.0.2...v5.0.3) (2023-04-05)
 
 ### Bug Fixes

package/README.md

@@ -4,96 +4,17 @@
 [![Download Status](https://img.shields.io/npm/dm/@feathersjs/memory.svg?style=flat-square)](https://www.npmjs.com/package/@feathersjs/memory)
 [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/qa8kez8QBx)
 
-A [Feathers](https://feathersjs.com) service adapter for in-memory data storage that works on all platforms.
+> A Feathers service adapter for in-memory data storage that works on all platforms.
+
+## Installation
 
 ```bash
 $ npm install --save @feathersjs/memory
 ```
 
-> **Important:** `@feathersjs/memory` implements the [Feathers Common database adapter API](https://docs.feathersjs.com/api/databases/common.html) and [querying syntax](https://docs.feathersjs.com/api/databases/querying.html).
-
-## API
-
-### `service([options])`
-
-Returns a new service instance initialized with the given options.
-
-```js
-const service = require('@feathersjs/memory')
-
-app.use('/messages', service())
-app.use('/messages', service({ id, startId, store, events, paginate }))
-```
-
-**Options:**
-
-- `id` (_optional_, default: `'id'`) - The name of the id field property.
-- `startId` (_optional_, default: `0`) - An id number to start with that will be incremented for every new record (unless it is already set).
-- `store` (_optional_) - An object with id to item assignments to pre-initialize the data store
-- `events` (_optional_) - A list of [custom service events](https://docs.feathersjs.com/api/events.html#custom-events) sent by this service
-- `paginate` (_optional_) - A [pagination object](https://docs.feathersjs.com/api/databases/common.html#pagination) containing a `default` and `max` page size
-- `whitelist` (_DEPRECATED_) - renamed to `allow`
-- `allow` (_optional_) - A list of additional query parameters to allow
-- `multi` (_optional_) - Allow `create` with arrays and `update` and `remove` with `id` `null` to change multiple items. Can be `true` for all methods or an array of allowed methods (e.g. `[ 'remove', 'create' ]`)
-
-## Example
-
-Here is an example of a Feathers server with a `messages` in-memory service that supports pagination:
-
-```
-$ npm install @feathersjs/feathers @feathersjs/express @feathersjs/socketio @feathersjs/errors @feathersjs/memory
-```
-
-In `app.js`:
-
-```js
-const feathers = require('@feathersjs/feathers')
-const express = require('@feathersjs/express')
-const socketio = require('@feathersjs/socketio')
-
-const memory = require('@feathersjs/memory')
-
-// Create an Express compatible Feathers application instance.
-const app = express(feathers())
-// Turn on JSON parser for REST services
-app.use(express.json())
-// Turn on URL-encoded parser for REST services
-app.use(express.urlencoded({ extended: true }))
-// Enable REST services
-app.configure(express.rest())
-// Enable REST services
-app.configure(socketio())
-// 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
-    }
-  })
-)
-// Set up default error handler
-app.use(express.errorHandler())
-
-// Create a dummy Message
-app
-  .service('messages')
-  .create({
-    text: 'Message created on server'
-  })
-  .then((message) => console.log('Created message', message))
-
-// Start the server.
-const port = 3030
-
-app.listen(port, () => {
-  console.log(`Feathers server listening on port ${port}`)
-})
-```
+## Documentation
 
-Run the example with `node app` and go to [localhost:3030/messages](http://localhost:3030/messages).
+See [FeathersJS Memory Adapter API documentation](https://feathersjs.com/api/databases/memory.html) for more details.
 
 ## License
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@feathersjs/memory",
   "description": "An in memory service store",
-  "version": "5.0.3",
+  "version": "5.0.4",
   "homepage": "https://github.com/feathersjs/feathers",
   "main": "lib/",
   "types": "lib/",
@@ -49,14 +49,14 @@
     "lib": "lib"
   },
   "dependencies": {
-    "@feathersjs/adapter-commons": "^5.0.3",
-    "@feathersjs/commons": "^5.0.3",
-    "@feathersjs/errors": "^5.0.3",
+    "@feathersjs/adapter-commons": "^5.0.4",
+    "@feathersjs/commons": "^5.0.4",
+    "@feathersjs/errors": "^5.0.4",
     "sift": "^17.0.1"
   },
   "devDependencies": {
-    "@feathersjs/adapter-tests": "^5.0.3",
-    "@feathersjs/feathers": "^5.0.3",
+    "@feathersjs/adapter-tests": "^5.0.4",
+    "@feathersjs/feathers": "^5.0.4",
     "@types/mocha": "^10.0.1",
     "@types/node": "^18.15.11",
     "mocha": "^10.2.0",
@@ -64,5 +64,5 @@
     "ts-node": "^10.9.1",
     "typescript": "^5.0.3"
   },
-  "gitHead": "a6ba4dfd08f537a7d4778bed4c45091cbe3802aa"
+  "gitHead": "376e89040991db500f1f327aa699322543315039"
 }