penkovsky_sa/cherrypick
1
0
Fork 0
mirror of https://github.com/pese-git/cherrypick.git synced 2026-01-23 21:13:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update EN/RU quick start and tutorial with Fast Map-based lookup section; clarify performance benefit in README

Browse Source
This commit is contained in:
Sergey Penkovsky
2025-08-05 19:41:24 +03:00
parent ffff33c744
commit 52a55219ab
3 changed files with 22 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
cherrypick/README.md
View File

@@ -94,6 +94,13 @@ final subScope = rootScope.openSubScope('featureScope')
final dataBloc = await subScope.resolveAsync<DataBloc>();
```
### Fast Dependency Lookup (Performance Improvement)
> **Performance Note:**
> As of the latest version, CherryPick uses a Map-based resolver index for dependency lookup. This means calls to `resolve<T>()` and related methods are now O(1) operations, regardless of the number of modules or bindings in your scope. Previously, the library had to iterate over all modules and bindings to locate the requested dependency, which could impact performance as your project grew.
>
> This optimization is internal and does not change any library APIs or usage patterns, but it significantly improves resolution speed in larger applications.
### Dependency Lookup API
- `resolve<T>()` — Locates a dependency instance or throws if missing.

8
doc/full_tutorial_en.md
View File

@@ -177,6 +177,14 @@ final service = scope.tryResolve<OptionalService>(); // returns null if not exis
---
### Fast Dependency Lookup (Performance Improvement)
> **Performance Note:**
> As of the latest version, CherryPick uses a Map-based resolver index for dependency lookup. This means calls to `resolve<T>()`, `tryResolve<T>()` and similar methods are now O(1) operations, regardless of the number of modules or bindings within your scope. Previously it would iterate over all modules and bindings, which could reduce performance as your project grew. This optimization is internal and does not affect the public API or usage patterns, but significantly improves resolution speed for larger applications.
---
## Dependency injection with annotations & code generation
CherryPick supports DI with annotations, letting you eliminate manual DI setup.

7
doc/full_tutorial_ru.md
View File

@@ -178,6 +178,13 @@ final service = scope.tryResolve<OptionalService>(); // вернет null, ес
---
### Быстрый поиск зависимостей (Performance Improvement)
> **Примечание по производительности:**
> В последних версиях CherryPick для поиска зависимости внутри scope используется Map-индекс. Благодаря этому методы `resolve<T>()`, `tryResolve<T>()` и аналогичные теперь работают за O(1), независимо от количества модулей и биндингов в вашем проекте. Ранее для поиска приходилось перебирать весь список вручную, что могло замедлять работу крупных приложений. Это внутреннее улучшение не меняет внешнего API или паттернов использования, но заметно ускоряет разрешение зависимостей на больших проектах.
---
## Внедрение зависимостей через аннотации и автогенерацию
CherryPick поддерживает DI через аннотации, что позволяет полностью избавиться от ручного внедрения зависимостей.