Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.38 KB

File metadata and controls

37 lines (24 loc) · 1.38 KB

tardis-node

Public npm package (tardis-dev). Provides async iterator API for historical replay and real-time streaming of cryptocurrency market data, with exchange-specific mappers for normalization.

Build & Test

npm run build        # tsc
npm test             # build + jest
npm run check-format # prettier check

Editing Rules

  • Keep backward compatibility for public API signatures — this is a published npm package
  • Maintain cache key stability (filters are normalized/sorted intentionally)
  • Preserve memory-safe streaming behavior (avoid large in-memory buffering)
  • Exchange additions must update realtime feed + mapper tables consistently
  • Format after every edit — run npx prettier --write on modified files after each change

Validation

  • npm run build && npm test
  • npm run check-format

Operational Docs

Publishing

Published via GitHub Actions (publish.yaml). Do not publish manually unless explicitly requested.

Keeping Docs Current

When you change code, check if any docs in this repo become stale as a result — if so, update them. When following a workflow doc, if the steps don't match reality, fix the doc so the next run is better.