mirror of
https://github.com/pese-git/cherrypick.git
synced 2026-01-24 05:25:19 +00:00
264c4bbb88
- Add detailed English doc comments for all main annotations (inject, injectable, instance, provide, scope, etc) - Add fully documented example/example.dart illustrating real-world DI scenario - Clarify stub sections (Module class, generated mixins) - Aligns package with pub.dev quality and best practice requirements No breaking changes.
44 lines
1.4 KiB
Dart
44 lines
1.4 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 field for dependency injection by CherryPick's code generator.
|
|
///
|
|
/// Use `@inject()` on fields within a class marked with `@injectable()`.
|
|
/// Such fields will be automatically injected from the DI [Scope]
|
|
/// when using the generated mixin or calling `.injectFields()`.
|
|
///
|
|
/// Example:
|
|
/// ```dart
|
|
/// import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
|
///
|
|
/// @injectable()
|
|
/// class LoginScreen with _\$LoginScreen {
|
|
/// @inject()
|
|
/// late final AuthService authService;
|
|
///
|
|
/// @inject()
|
|
/// @named('main')
|
|
/// late final ApiClient api;
|
|
/// }
|
|
///
|
|
/// // After running build_runner, call:
|
|
/// // LoginScreen().injectFields();
|
|
/// ```
|
|
@experimental
|
|
final class inject {
|
|
/// Creates an [inject] annotation for field injection.
|
|
const inject();
|
|
}
|