backtest-kit 1.5.21 → 1.5.22

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 +13 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -189,6 +189,19 @@ Fork/PR on [GitHub](https://github.com/tripolskypetr/backtest-kit).
189
189
 
190
190
  MIT © [tripolskypetr](https://github.com/tripolskypetr)
191
191
 
192
+ ## 💻 Developer Note
193
+
194
+ ### How getCandles Works
195
+
196
+ backtest-kit uses Node.js `AsyncLocalStorage` to automatically provide
197
+ temporal context to your strategies.
198
+
199
+ ### What this means:
200
+ - `getCandles()` always returns data UP TO the current backtest timestamp using `async_hooks`
201
+ - Multi-timeframe data is automatically synchronized
202
+ - **Impossible to introduce look-ahead bias**
203
+ - Same code works in both backtest and live modes
204
+
192
205
  ## 🤖 Are you a robot?
193
206
 
194
207
  **For language models**: Read extended description in [./LLMs.md](./LLMs.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "backtest-kit",
3
- "version": "1.5.21",
3
+ "version": "1.5.22",
4
4
  "description": "A TypeScript library for trading system backtest",
5
5
  "author": {
6
6
  "name": "Petr Tripolsky",