@reqray/store-memory 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +25 -5
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -1,12 +1,32 @@
1
1
  # @reqray/store-memory
2
2
 
3
- Reqray in-memory store: the ring buffer the panel reads from, and the transport that fills it.
3
+ The default store of Reqray: a ring buffer in process memory that holds the
4
+ most recent requests and answers the panel's queries.
4
5
 
5
- Part of [Reqray](https://github.com/reqray/reqray) — a dev panel and request-inspection tool for
6
- Node.js. It instruments HTTP, SQL, outgoing calls and cache on its own, shows
7
- every request as a waterfall, and finds N+1 down to the file and the line.
6
+ Part of [Reqray](https://github.com/reqray/reqray) — a dev panel and request inspector for Node.js. It
7
+ instruments HTTP, SQL, outgoing calls and cache on its own, shows every
8
+ request as a waterfall, and finds N+1 down to the file and the line.
8
9
 
9
- Documentation, screenshots and a demo that runs with one command are in the
10
+ You do not normally install this yourself — the adapters depend on it and use
11
+ it when no other transport is given. It keeps the last 500 requests and
12
+ forgets them when the process restarts.
13
+
14
+ ```js
15
+ import { memoryTransport } from '@reqray/store-memory';
16
+
17
+ const store = memoryTransport({ capacity: 2000 });
18
+ ```
19
+
20
+ Pinned requests survive the ring, up to 50 of them: pinning suspends the
21
+ promise that memory is bounded, so it gets a bound of its own.
22
+
23
+ For a history that survives a restart, use
24
+ [`@reqray/store-sqlite`](https://www.npmjs.com/package/@reqray/store-sqlite).
25
+
26
+ ## More
27
+
28
+ Everything else — the detectors, security defaults, measured overhead and a
29
+ demo that runs with one command — is in the
10
30
  [main README](https://github.com/reqray/reqray#readme).
11
31
 
12
32
  ## License
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@reqray/store-memory",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Reqray in-memory store: the ring buffer the panel reads from, and the transport that fills it.",
5
5
  "license": "MIT",
6
6
  "keywords": [
@@ -48,8 +48,8 @@
48
48
  "access": "public"
49
49
  },
50
50
  "dependencies": {
51
- "@reqray/core": "^0.1.0",
52
- "@reqray/protocol": "^0.1.0"
51
+ "@reqray/protocol": "^0.1.1",
52
+ "@reqray/core": "^0.1.1"
53
53
  },
54
54
  "devDependencies": {
55
55
  "@types/node": "^26.2.0",