mirror of
https://github.com/pese-git/cherrypick.git
synced 2026-01-23 21:13:35 +00:00
884df50a34
- Updated all annotation files with complete English DartDoc, field/class/method usage, practical code samples - Unified documentation style for @inject, @injectable, @instance, @singleton, @named, @scope, @params, @provide, @module - Removed Russian comments for clarity and consistency - Improved discoverability and IDE/autocomplete experience for CherryPick DI users - No functional or API changes; documentation/dev experience only
44 lines
1.7 KiB
Dart
44 lines
1.7 KiB
Dart
//
|
|
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
// https://www.apache.org/licenses/LICENSE-2.0
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
//
|
|
|
|
import 'package:meta/meta.dart';
|
|
|
|
/// Marks a parameter in a provider method to receive dynamic runtime arguments when resolving a dependency.
|
|
///
|
|
/// Use `@params()` in a DI module/factory method when the value must be supplied by the user/code at injection time,
|
|
/// not during static wiring (such as user input, navigation arguments, etc).
|
|
///
|
|
/// This enables CherryPick and its codegen to generate .withParams or .toProvideWithParams bindings — so your provider can access runtime values.
|
|
///
|
|
/// Example:
|
|
/// ```dart
|
|
/// import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
|
///
|
|
/// @module()
|
|
/// abstract class FeatureModule {
|
|
/// @provide
|
|
/// UserManager createManager(@params Map<String, dynamic> runtimeParams) {
|
|
/// return UserManager.forUserId(runtimeParams['userId']);
|
|
/// }
|
|
/// }
|
|
/// ```
|
|
/// Usage at injection/resolution:
|
|
/// ```dart
|
|
/// final manager = scope.resolve<UserManager>(params: {'userId': myId});
|
|
/// ```
|
|
@experimental
|
|
final class params {
|
|
/// Marks a method/constructor parameter as supplied at runtime by the caller.
|
|
const params();
|
|
}
|