petrol 1.0.0 copy "petrol: ^1.0.0" to clipboard
petrol: ^1.0.0 copied to clipboard

A minimal, simple, and small dependency injection library for Dart and Flutter apps.

Fuel #

Sweetly simple dependency injection.

Features #

  • Zero dependencies. No third party dependencies, not even the standard library. Pure Dart, works outside of Flutter.
  • Implicit registration. Dependencies will automatically register as singletons the moment they're injected. No need to explicitly register them all at the start of your program, consequentially making them lazy loaded.
  • Minimal implementation. Fits within ~2.5 kilobytes with a dead simple API and documentation, minification not included.
  • No build_runner. A simple abstraction that utilizes Dart's type system.

Q&A #

  • Factories?. petrol does not explicitly provide a method for registering factories. Provide the dependency as is since petrol expects you to not tightly couple dependencies and dependents a la dependency injection.
  • Asynchronous injectors? petrol will not explicitly provide support for asynchronous injectors. Since injectors in petrol are just functions, futures can be resolved within the injector via the .then method.
  • Eager loading? Call the use method at the start of your program a la traditional usage of service locators.
  • Updates? Likely not. The API will intentionally remain small to do one thing, and one thing well; more complex requirements are better served by the get_it package. It is unlikely bugs will occur with how short & simple the implementation of this package is.
  • Do I need this? Not necessarily. This package merely provides you with the convenience of having an architectural pattern already implemented for you that you can also implement yourself within a few lines of code.
  • What's with the name? Originally there was going to be a direct fuel injection joke but pub thought fuel was too similar to fuels. gas didn't sound right despite the shorter name. That left me with the name petrol.

Installation #

# For Flutter projects
flutter pub add fuel

# Otherwise
dart pub add fuel

Notice #

Licensed under the BSD 3 Clause license.

3
likes
130
pub points
9%
popularity

Publisher

unverified uploader

A minimal, simple, and small dependency injection library for Dart and Flutter apps.

Repository (GitHub)
View/report issues

Documentation

API reference

License

BSD-3-Clause (license)

More

Packages that depend on petrol