impaktfull_architecture library

Classes

Enums

Mixins

Extensions

Constants

dev → const Environment: preset instance of common env name
disposeMethod → const DisposeMethod: const instance of DisposeMethod with default arguments
factoryMethod → const FactoryMethod: const instance of FactoryMethod with default values
factoryParam → const FactoryParam: const instance of FactoryParam with default arguments
ignoreParam → const IgnoreParam: const instance of IgnoreParam
injectable → const Injectable: const instance of Injectable with default arguments
injectableInit → const InjectableInit: const instance of InjectableInit with default arguments
kEnvironmentsFilterName → const String
kEnvironmentsName → const String: instance name for the Set of environment keys that's registered internally inside of GetItHelper
lazySingleton → const LazySingleton: const instance of LazySingleton with default arguments
microPackageInit → const InjectableInit: const instance of InjectableInit.microPackage with default arguments
module → const Module: const instance of Module with default arguments
named → const Named: const instance of Named with default arguments
order → const Order: const instance of Order with default arguments
postConstruct → const PostConstruct: const instance of PostConstruct with default arguments
preResolve → const PreResolve: const instance of PreResolve with default arguments
prod → const Environment: preset instance of common env name
singleton → const Singleton: const instance of Singleton with default arguments
vg → const VectorGraphicUtilities: The VectorGraphicUtilities instance.

Properties

context → Context: The system path context.
final
current → String: Gets the path to the current working directory.
no setter
disablePathProviderPlatformOverride ← bool: no getter
locale → Locale: no setter
localizationLookup ↔ Localization Function<Localization>(BuildContext context): getter/setter pair
posix → Context: A default context for manipulating POSIX paths.
final
separator → String: Gets the path separator for the current platform. This is \ on Windows and / on other platforms (including the browser).
no setter
sprintf ↔ PrintFormat: getter/setter pair
style → Style: Returns the Style of the current context.
no setter
svg → Svg: Instance for Svg's utility methods, which can produce a DrawableRoot or PictureInfo from String or Uint8List.
final
theme → ImpaktfullUiTheme<Object>: no setter
themeLookup ↔ Theme Function<Theme>(BuildContext context): getter/setter pair
url → Context: A default context for manipulating URLs.
final
windows → Context: A default context for manipulating Windows paths.
final

Functions

absolute(String part1, [String? part2, String? part3, String? part4, String? part5, String? part6, String? part7, String? part8, String? part9, String? part10, String? part11, String? part12, String? part13, String? part14, String? part15]) → String: Returns a new path with the given path parts appended to current.
basename(String path) → String: Gets the part of path after the last separator.
basenameWithoutExtension(String path) → String: Gets the part of path after the last separator, and without any trailing file extension.
canLaunch(String urlString) → Future<bool>: Checks whether the specified URL can be handled by some app installed on the device.
canLaunchUrl(Uri url) → Future<bool>: Checks whether the specified URL can be handled by some app installed on the device.
canLaunchUrlString(String urlString) → Future<bool>: String version of canLaunchUrl.
canonicalize(String path) → String: Canonicalizes path.
closeInAppWebView() → Future<void>: Closes the current in-app web view, if one was previously opened by launchUrl.
closeWebView() → Future<void>: Closes the current WebView, if one was previously opened via a call to launch.
configureImpaktfullArchitecture(GetItHelper gh, {bool isWeb = kIsWeb}) → Future<void>
defaultDioExceptionReadableStringBuilder(DioException e) → String: The default implementation of building a readable string of DioException.
dirname(String path) → String: Gets the part of path before the last separator.
equals(String path1, String path2) → bool: Returns true if path1 points to the same location as path2, and false otherwise.
extension(String path, [int level = 1]) → String: Gets the file extension of path: the portion of basename from the last . to the end (including the . itself).
fromUri(Object? uri) → String: Returns the path represented by uri, which may be a String or a Uri.
getApplicationCacheDirectory() → Future<Directory>: Path to a directory where the application may place application-specific cache files.
getApplicationDocumentsDirectory() → Future<Directory>: Path to a directory where the application may place data that is user-generated, or that cannot otherwise be recreated by your application.
getApplicationSupportDirectory() → Future<Directory>: Path to a directory where the application may place application support files.
getDayForMonthWithFallback(int year, int month, int day) → int
getDownloadsDirectory() → Future<Directory?>: Path to the directory where downloaded files can be stored.
getExternalCacheDirectories() → Future<List<Directory>?>: Paths to directories where application specific cache data can be stored externally.
getExternalStorageDirectories({StorageDirectory? type}) → Future<List<Directory>?>: Paths to directories where application specific data can be stored externally.
getExternalStorageDirectory() → Future<Directory?>: Path to a directory where the application may access top level storage.
getLibraryDirectory() → Future<Directory>: Path to the directory where application can store files that are persistent, backed up, and not visible to the user, such as sqlite.db.
getTemporaryDirectory() → Future<Directory>: Path to the temporary directory on the device that is not backed up and is suitable for storing caches of downloaded files.
getUserAgent() → String?
hash(String path) → int: Returns a hash code for path such that, if equals returns true for two paths, their hash codes are the same.
isAbsolute(String path) → bool: Returns true if path is an absolute path and false if it is a relative path.
isRelative(String path) → bool: Returns true if path is a relative path and false if it is absolute. On POSIX systems, absolute paths start with a / (forward slash). On Windows, an absolute path starts with \\, or a drive letter followed by :/ or :\.
isRootRelative(String path) → bool: Returns true if path is a root-relative path and false if it's not.
isWithin(String parent, String child) → bool: Returns true if child is a path beneath parent, and false otherwise.
join(String part1, [String? part2, String? part3, String? part4, String? part5, String? part6, String? part7, String? part8, String? part9, String? part10, String? part11, String? part12, String? part13, String? part14, String? part15, String? part16]) → String: Joins the given path parts into a single path using the current platform's separator. Example:
joinAll(Iterable<String> parts) → String: Joins the given path parts into a single path using the current platform's separator. Example:
launch(String urlString, {bool? forceSafariVC, bool forceWebView = false, bool enableJavaScript = false, bool enableDomStorage = false, bool universalLinksOnly = false, Map<String, String> headers = const <String, String>{}, Brightness? statusBarBrightness, String? webOnlyWindowName}) → Future<bool>: Parses the specified URL string and delegates handling of it to the underlying platform.
launchUrl(Uri url, {LaunchMode mode = LaunchMode.platformDefault, WebViewConfiguration webViewConfiguration = const WebViewConfiguration(), BrowserConfiguration browserConfiguration = const BrowserConfiguration(), String? webOnlyWindowName}) → Future<bool>: Passes url to the underlying platform for handling.
launchUrlString(String urlString, {LaunchMode mode = LaunchMode.platformDefault, WebViewConfiguration webViewConfiguration = const WebViewConfiguration(), BrowserConfiguration browserConfiguration = const BrowserConfiguration(), String? webOnlyWindowName}) → Future<bool>: String version of launchUrl.
normalize(String path) → String: Normalizes path, simplifying it by handling .., and ., and removing redundant path separators whenever possible.
prettyUri(Object? uri) → String: Returns a terse, human-readable representation of uri.
relative(String path, {String? from}) → String: Attempts to convert path to an equivalent relative path from the current directory.
rootPrefix(String path) → String: Returns the root of path, if it's absolute, or the empty string if it's relative.
setExtension(String path, String extension) → String: Returns path with the trailing extension set to extension.
setImpaktfullUiLocale(Locale? locale) → void
setImpaktfullUiTestTheme(ImpaktfullUiTheme<Object>? theme) → void
setImpaktfullUiTheme(ImpaktfullUiTheme<Object>? theme) → void
setPathUrlStrategy() → void
split(String path) → List<String>: Splits path into its components using the current platform's separator.
supportsCloseForLaunchMode(LaunchMode mode) → Future<bool>: Returns true if closeInAppWebView is supported for mode in the current platform implementation.
supportsLaunchMode(LaunchMode mode) → Future<bool>: Returns true if mode is supported by the current platform implementation.
throwIf(bool condition, Object error) → void: Two handy functions that help me to express my intention clearer and shorter to check for runtime errors
throwIfNot(bool condition, Object error) → void
toBeginningOfSentenceCase<T extends String?>(T input, [String? locale]) → T: Convert a string to beginning of sentence case, in a way appropriate to the locale.
toUri(String path) → Uri: Returns the URI that represents path.
withoutExtension(String path) → String: Removes a trailing extension from the last part of path.

Typedefs

Create<T> = T Function(BuildContext context): A function that creates an object of type T.
DefaultTransformer = SyncTransformer
DeferredStartListening<T, R> = VoidCallback Function(InheritedContext<R?> context, void setState(R value), T controller, R? value): A callback used to handle the subscription of controller.
DioError = DioException: DioError describes the exception info when a request failed.
DioErrorType = DioExceptionType: Deprecated in favor of DioExceptionType and will be removed in future major versions.
DioExceptionReadableStringBuilder = String Function(DioException e): The readable string builder's signature of DioException.readableStringBuilder.
DioMediaType = MediaType: The type (alias) for specifying the content-type of the MultipartFile.
Dispose<T> = void Function(BuildContext context, T value): A function that disposes an object of type T.
DisposingFunc<T> = FutureOr Function(T param): Signature for disposing function because closures like (x){} have a return type of Null we don't use FutureOr<void>
EnvironmentFilterFunc = bool Function(Set<String>)
ErrorBuilder<T> = T Function(BuildContext context, Object? error): A callback used to build a valid value from an error.
FactoryFunc<T> = T Function(): Signature of the factory function used by non async factories
FactoryFuncAsync<T> = Future<T> Function(): Signature of the factory function used by async factories
FactoryFuncParam<T, P1, P2> = T Function(P1 param1, P2 param2): For Factories that expect up to two parameters if you need only one use void for the one you don't use
FactoryFuncParamAsync<T, P1, P2> = Future<T> Function(P1 param1, P2 param2): For async Factories that expect up to two parameters if you need only one use void for the one you don't use
HeaderForEachCallback = void Function(String name, List<String> values): The signature that iterates header fields.
ImpaktfullUiMarkdownLinkCallback = FutureOr<void> Function(String url)
InterceptorErrorCallback = void Function(DioException error, ErrorInterceptorHandler handler): The signature of Interceptor.onError.
InterceptorSendCallback = void Function(RequestOptions options, RequestInterceptorHandler handler): The signature of Interceptor.onRequest.
InterceptorSuccessCallback = void Function(Response response, ResponseInterceptorHandler handler): The signature of Interceptor.onResponse.
JsonDecodeCallback = FutureOr Function(String): The callback definition for decoding a JSON string.
JsonEncodeCallback = FutureOr<String> Function(Object): The callback definition for encoding a JSON object.
Locator = T Function<T>(): A generic function that can be called to read providers, without having a reference on BuildContext.
NetworkManagerClientFactory = NetworkManagerClient Function()
PrintFormatFormatter = Formatter Function(dynamic arg, dynamic options)
ProgressCallback = void Function(int count, int total): The type of a progress listening callback when sending or receiving data.
ProviderBuilder<R> = Widget Function(BuildContext context, R value, Widget child)
ProxyProviderBuilder<T, R> = R Function(BuildContext context, T value, R? previous)
ProxyProviderBuilder2<T, T2, R> = R Function(BuildContext context, T value, T2 value2, R? previous)
ProxyProviderBuilder3<T, T2, T3, R> = R Function(BuildContext context, T value, T2 value2, T3 value3, R? previous)
ProxyProviderBuilder4<T, T2, T3, T4, R> = R Function(BuildContext context, T value, T2 value2, T3 value3, T4 value4, R? previous)
ProxyProviderBuilder5<T, T2, T3, T4, T5, R> = R Function(BuildContext context, T value, T2 value2, T3 value3, T4 value4, T5 value5, R? previous)
ProxyProviderBuilder6<T, T2, T3, T4, T5, T6, R> = R Function(BuildContext context, T value, T2 value2, T3 value3, T4 value4, T5 value5, T6 value6, R? previous)
RequestEncoder = FutureOr<List<int>> Function(String request, RequestOptions options): The type of a request encoding callback.
ResponseDecoder = FutureOr<String?> Function(List<int> responseBytes, RequestOptions options, ResponseBody responseBody): The type of a response decoding callback.
ScopeDisposeFunc = FutureOr Function(): Signature for disposing function on scope level
ShouldRebuild<T> = bool Function(T previous, T next): Used by providers to determine whether dependents needs to be updated when the value exposed changes
StartListening<T> = VoidCallback Function(InheritedContext<T?> element, T value): A callback used to start the listening of an object and return a function that cancels the subscription.
SvgErrorWidgetBuilder = Widget Function(BuildContext context, Object error, StackTrace stackTrace): Builder function to create an error widget. This builder is called when the image failed loading.
UpdateShouldNotify<T> = bool Function(T previous, T current): A function that returns true when the update from previous to current should notify listeners, if any.
ValidateStatus = bool Function(int? status): The type of a response status code validate callback.

Exceptions / Errors

BaseLocalizedError<Localization>
BaseNetworkError<Localization>
DioException: DioException describes the exception info when a request failed.
MissingPlatformDirectoryException: An exception thrown when a directory that should always be available on the current platform cannot be obtained.
NotNullableError<T>: A TypeError thrown by _checkNotNullable.
PathException: An exception class that's thrown when a path operation is unable to be computed accurately.
ProviderNotFoundException: The error that will be thrown if Provider.of fails to find a Provider as an ancestor of the BuildContext used.
ProviderNullException: Called Provider.of<T> instead of Provider.of<T?> but the provider returned null.
SimpleLocalizedError
SimpleLocalizedMessageError
WaitingTimeOutException

impaktfull_architecture library

Classes

Enums

Mixins

Extensions

Constants

Properties

Functions

Typedefs

Exceptions / Errors

impaktfull_architecture package

impaktfull_architecture library