Skip to content

feat: standardize API typing and input variants for v0.3 gate #7#9

Merged
TDamiao merged 1 commit intomainfrom
feat/issue-7-typing-ux
Feb 26, 2026
Merged

feat: standardize API typing and input variants for v0.3 gate #7#9
TDamiao merged 1 commit intomainfrom
feat/issue-7-typing-ux

Conversation

@TDamiao
Copy link
Owner

@TDamiao TDamiao commented Feb 26, 2026

Summary

  • add explicit public types for candle inputs and OHLCV object variants
  • add a public API wrapper layer (src/api.ts) so core indicators accept consistent input styles
  • support both long candle keys (open/high/low/close/volume/time) and aliases (o/h/l/c/v/t)
  • centralize actionable numeric/input validation messaging
  • document typing/input variants in README and add contract tests for both styles

Validation

  • npm.cmd run build
  • node --test --test-concurrency=1 --test-isolation=none test/contracts.test.mjs
  • node --test --test-concurrency=1 --test-isolation=none test/golden.test.mjs

Notes

  • In this sandbox, npm test with default isolation fails with spawn EPERM; test commands above pass with --test-isolation=none.

Closes #7

@TDamiao TDamiao merged commit a53ca55 into main Feb 26, 2026
4 checks passed
@TDamiao TDamiao deleted the feat/issue-7-typing-ux branch February 26, 2026 18:56
@TDamiao TDamiao mentioned this pull request Feb 26, 2026
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

v0.3 Gate: API Typing and Developer UX

1 participant