@rn-perf-kit/core 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 -0
  2. package/package.json +21 -2
package/README.md ADDED
@@ -0,0 +1,25 @@
1
+ # @rn-perf-kit/core
2
+
3
+ [![npm version](https://img.shields.io/npm/v/@rn-perf-kit/core.svg?style=flat-square&color=CB3837)](https://www.npmjs.com/package/@rn-perf-kit/core)
4
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
5
+
6
+ > Core timeline, high-throughput ring buffer, unified event model, monotonic clock synchronization, and tier-aware budget engine for **rn-perf-kit**.
7
+
8
+ Part of the [rn-perf-kit](https://github.com/arpitkumarsahu/rn-perf-kit) monorepo.
9
+
10
+ ## Installation
11
+
12
+ ```sh
13
+ npm install @rn-perf-kit/core
14
+ ```
15
+
16
+ ## Features
17
+
18
+ - **Timeline & RingBuffer**: Pre-allocated fixed-capacity buffer that records up to 10,000 events with zero GC pressure on the hot path.
19
+ - **Monotonic Clock Sync**: Math that maps native nanosecond timestamps (from Android Choreographer and iOS CADisplayLink) onto JavaScript `performance.now()` with sub-millisecond precision.
20
+ - **Unified Event Model**: Typed unions covering renders, commits, frame metrics, stalls, layout effects, store actions, network requests, and route changes.
21
+ - **Budget Engine**: Evaluates metrics against hardware capability tiers (`LOW`, `MID`, `HIGH`).
22
+
23
+ ## Documentation
24
+
25
+ Full guides and API reference are available at [github.com/arpitkumarsahu/rn-perf-kit](https://github.com/arpitkumarsahu/rn-perf-kit#readme).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rn-perf-kit/core",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Core timeline, ring buffer, event model and budget engine for rn-perf-kit",
5
5
  "main": "./src/index.ts",
6
6
  "types": "./src/index.ts",
@@ -16,5 +16,24 @@
16
16
  "@types/jest": "^29.0.0",
17
17
  "jest": "^29.0.0",
18
18
  "ts-jest": "^29.0.0"
19
- }
19
+ },
20
+ "author": "Arpit Kumar Sahu <aarpitkumarsahu99@gmail.com>",
21
+ "license": "MIT",
22
+ "repository": {
23
+ "type": "git",
24
+ "url": "git+https://github.com/arpitkumarsahu/rn-perf-kit.git",
25
+ "directory": "packages/core"
26
+ },
27
+ "bugs": {
28
+ "url": "https://github.com/arpitkumarsahu/rn-perf-kit/issues"
29
+ },
30
+ "homepage": "https://github.com/arpitkumarsahu/rn-perf-kit#readme",
31
+ "keywords": [
32
+ "react-native",
33
+ "performance",
34
+ "timeline",
35
+ "ring-buffer",
36
+ "clock-sync",
37
+ "budgets"
38
+ ]
20
39
  }