flutter_vaden library

Classes

Api
Provides OpenAPI documentation for a controller.
ApiClient
ApiContent
Describes the content type and schema of a request or response body.
ApiOperation
Provides OpenAPI documentation for an endpoint operation.
ApiParam
Provides OpenAPI documentation for a path parameter.
ApiQuery
Provides OpenAPI documentation for a query parameter.
ApiResponse
Describes a possible response from an API endpoint.
ApiSecurity
Specifies the security schemes required for an API endpoint.
ApplicationRunner
Defines a contract for components that should execute automatically during application startup.
AutoInjector
Automatic Dependency Injection System, but without build_runner :)
[tag]: AutoInject instance identity.
[on]: Helps with instance registration.
[paramObservers]: List of functions that listen and transform parameters while they are being parsed when requested by the get() method.

BaseComponent
Base interface for all component annotations.
Bean
Marks a method in a Configuration class as a bean factory.
Bind<T>
BindConfig<T>
Body
Binds the request body to a method parameter.
CommandLineRunner
Defines a contract for components that should execute based on command-line arguments during application startup.
CommonModule<T extends VadenApplication>
The CommonModule abstract class defines the structure for creating modules that can register their own dependency injections and route configurations. This allows for modularization and better organization of code in a Vaden-based application.
Component
Marks a class as a general component in the application.
Configuration
Marks a class as a configuration component in the application.
Context
Binds a context value from the request to a method parameter.
ControllerAdvice
Marks a class as a controller advice for global exception handling.
Delete
Marks a method as a handler for HTTP DELETE requests.
Disposable
Interface for classes that need to release resources when they are no longer needed.
DSON
Data Serialization Object Notation (DSON) system for Vaden.
DTO
Marks a class as a Data Transfer Object (DTO).
ExceptionHandler
Marks a method in a ControllerAdvice class as an exception handler.
FlutterVadenApplication
Get
Marks a method as a handler for HTTP GET requests.
Marks a method as a handler for HTTP HEAD requests.
Binds a header value from the request to a method parameter.
InheritedAutoInjector
Injector
Register and get binds
JsonIgnore
Excludes a field from JSON serialization and deserialization.
JsonKey
Specifies the JSON key name for a field in a DTO.
LayersGraph
Mount
Mounts a Router instance at the specified path.
NamedParam
Options
Marks a method as a handler for HTTP OPTIONS requests.
Param
Binds a path parameter from the request URL to a method parameter.
ParamParse<P, R>
Abstract class for parameter parsing and serialization in Vaden.
Parse
Marks a ParamParse class as globally discoverable.
Patch
Marks a method as a handler for HTTP PATCH requests.
PositionalParam
Post
Marks a method as a handler for HTTP POST requests.
Put
Marks a method as a handler for HTTP PUT requests.
Query
Binds a query parameter from the request URL to a method parameter.
Repository
Marks a class as a repository in the application.
Scope
Specifies the bind type for a component in the dependency injection container. This annotation is used to define how a component should be bound in the dependency injection container, such as whether it should be a singleton, lazy singleton, or instance. Example:
Service
Marks a class as a service in the application.
UseGuards
Applies guards to a controller or endpoint.
UseMiddleware
Applies middleware to a controller or endpoint.
UseParse
Specifies which custom ParamParse class should be used for a DTO field.
VadenApplication
VadenModule
Defines a Vaden module that can import other modules.

Enums

BindType

Functions

changeParam<T>(T newValue) → ParamTransform

Typedefs

DisposeCallback<T> = void Function(T value)
FromJsonFunction<T> = T Function(Map<String, dynamic> json)
Type definition for a function that converts a JSON map to an object of type T.
NotifierCallback<T> = dynamic Function(T value)
ParamTransform = Param? Function(Param param)
ToJsonFunction<T> = Map<String, dynamic> Function(T object)
Type definition for a function that converts an object of type T to a JSON map.
ToOpenApiNormalMap = Map<String, dynamic>
Type definition for a map that represents the OpenAPI schema for a type.

Exceptions / Errors

AutoInjectorException
AutoInjection Exception with ToString auto configured
message : message of exception
stackTrace : traces of exception
InjectorAlreadyCommited
AutoInjecton Exception for Injector Already Commited.
Store all parent classNames message : message of exception
stackTrace : traces of exception
injectorTag : tag of the current injector
UnregisteredInstance
AutoInjection Exception for Unregistered instance.
Store all parent classNames message : message of exception
stackTrace : traces of exception
classNames : all parent class names
UnregisteredInstanceByKey
AutoInjection Exception for Unregistered instance.
Store all parent classNames message : message of exception
stackTrace : traces of exception
UpwardResolutionCycle
AutoInjection Exception thrown when an addInjector(..., resolveUpward: true) edge would create a cycle in the upward (ancestor) resolution chain.
Upward resolution must form a tree: a child resolves against its ancestor as a fallback, never the other way around. A mutual upward link would make resolution recurse forever, so it is rejected eagerly at composition time.
injectorTag : tag of the injector at which the cycle was detected