_index.g
library
Extensions
BodyJsonOnResponseExtension
CalculateBestCentereOnLocationPackageExtension LocationUtils
CalculateGeometricCentereOnLocationPackageExtension LocationUtils
CalculateHavershire3DDistanceOnLocationPackageExtension LocationUtils
CalculateZoomToFitOnLocationPackageExtension LocationUtils
CalculatorOnScreenSizeExtension ScreenSize
ConvertOnStringCaseTypeExtension StringCaseType
DataRefModelExtension DataRefModel
FirstWhereOrNullOnIterableExtension Iterable <T >
FirstWhereOrNullOnListExtension List <T >
FirstWhereOrNullOnMapExtension Map <K , V >
FirstWhereOrNullOnSetExtension Set <T >
GenericTypeOnIterableExtension Iterable <T >
GenericTypeOnMapExtension Map <K , V >
JoinWithLastSeparatorOnIterableExtension Iterable
LNullIfEmptyOnListExtension List <T >
MapIOnIterableExtension Iterable <A >
MapIOnListExtension List <A >
MapIOnMapExtension Map <A1 , A2 >
MapIOnSetExtension Set <A >
MapKeysAndValyesOnMapExtension Map <K1 , V1 >
MapWithDefaultOnMapExtension Map <K , V >
MaybeAddToIterableExtension Iterable <T >
MaybeAddToListExtension List <T >
MaybeAddToMapExtension Map <T1 , T2 >
MaybeAddToSetExtension Set <T >
MiscOnStringExtension String
NonNullKeysOnMapExtension Map <K? , V >
NonNullsOnMapExtension Map <K? , V? >
NonNullValuesOnMapExtension Map <K , V? >
NullIfEmptyOnIterableExtension Iterable <T >
NullIfEmptyOnMapExtension Map <T1 , T2 >
NullIfEmptyOnQueueExtension Queue <T >
NullIfEmptyOnSetExtension Set <T >
NullIfEmptyOnStringExtension String
ParseDurationOnStringExtension String
PrepOnStringExtension String
ReplaceAllPatternsOnStringExtension String
ReplaceDataOnStringExtension String
ResponseHandleExceptionsOnFutureExtension Future <Response >
SecondToNinthElementOnIterableExtension Iterable <T >
SetNestedValueOnMapExtension Map
StringCaseConversionsOnStringExtension String
TakeLastOnIterableExtension Iterable <String
ToClassOnTFieldRecordExtension TFieldRecord
ToFutureOnStreamExtension Stream <T >
ToMapOnIterableExtension Iterable <MapEntry <K , V >
ToTrimmedOrNullOnObjectExtension Object
TryMergeOnIterableExtension Iterable <Iterable <T > ?
TryOrNullOnFunctionExtension Function
TryReduceOnIterableExtension Iterable <T >
UniqueOnMapEntryIterableExtension Iterable <MapEntry <K , V >
UtilsOnDateTimeExtension DateTime
ValueOfOnEnumExtension Iterable <T >
WithAnsiStyleOnStringExtension String
Constants
alwaysThrows → const _AlwaysThrows
Used to annotate a function f. Indicates that f always throws an
exception. Any functions that override f, in class inheritance, are also
expected to conform to this contract.
awaitNotRequired → const _AwaitNotRequired
Used to annotate a Future -returning function (including constructors,
getters, methods, and operators), or a Future -typed field (including
top-level, instance, and static) f. Indicates that the Future value that
f returns does not need to be awaited. Any methods that override f in
class inheritance, are also expected to conform to this contract.
CAMEL_CASE → const String
A key representing camel case.
CAMEL_CASE_EXAMPLE → const String
Camel case example.
checked → const _Checked
Used to annotate a parameter of an instance method that overrides another
method.
CONTENT_TYPE_APPLICATION_JSON → const Map <String String
doNotStore → const _DoNotStore
Used to annotate a method, getter, top-level function, or top-level getter
to indicate that the value obtained by invoking it should not be stored in a
field or top-level variable. The annotation can also be applied to a class
to implicitly annotate all of the valid members of the class, or applied to
a library to annotate all of the valid members of the library, including
classes. If a value returned by an element marked as doNotStore is
returned from a function or getter, that function or getter should be
similarly annotated.
doNotSubmit → const _DoNotSubmit
Used to annotate an optional parameter, method, getter or top-level getter
or function that is not intended to be accessed in checked-in code, but
might be ephemerally used during development or local testing.
experimental → const _Experimental
Used to annotate a library, or any declaration that is part of the public
interface of a library (such as top-level members, class members, and
function parameters) to indicate that the annotated API is experimental and
may be removed or changed at any-time without updating the version of the
containing package, despite the fact that it would otherwise be a breaking
change.
factory → const _Factory
Used to annotate an instance or static method m. Indicates that m must
either be abstract or must return a newly allocated object or null. In
addition, every method that either implements or overrides m is implicitly
annotated with this same annotation.
immutable → const Immutable
Used to annotate a class C. Indicates that C and all subtypes of C
must be immutable.
internal → const _Internal
Used to annotate a declaration which should only be used from within the
package in which it is declared, and which should not be exposed from said
package's public API.
isTest → const _IsTest
Used to annotate a test framework function that runs a single test.
isTestGroup → const _IsTestGroup
Used to annotate a test framework function that runs a group of tests.
literal → const _Literal
Used to annotate a const constructor c. Indicates that any invocation of
the constructor must use the keyword const unless one or more of the
arguments to the constructor is not a compile-time constant.
LOWER_DOT_CASE → const String
A key representing lower dot case.
LOWER_DOT_CASE_EXAMPLE → const String
Lower dot case example.
LOWER_KEBAB_CASE → const String
A key representing lower kebab case.
LOWER_KEBAB_CASE_EXAMPLE → const String
Lower kebab case example.
LOWER_SNAKE_CASE → const String
A key representing lower snake case.
LOWER_SNAKE_CASE_EXAMPLE → const String
Lower snake case example.
MIN_MOBILE_ASPECT_RATIO → const double
The smallest of the following common aspect ratios for mobile phones (4.0 / 3.0)
mustBeConst → const _MustBeConst
Used to annotate a parameter which should be constant.
mustBeOverridden → const _MustBeOverridden
Used to annotate an instance member m declared on a class or mixin C.
Indicates that every concrete subclass of C must directly override m.
mustCallSuper → const _MustCallSuper
Used to annotate an instance member (method, getter, setter, operator, or
field) m. Indicates that every invocation of a member that overrides m
must also invoke m. In addition, every method that overrides m is
implicitly annotated with this same annotation.
nonVirtual → const _NonVirtual
Used to annotate an instance member (method, getter, setter, operator, or
field) m in a class C or mixin M. Indicates that m should not be
overridden in any classes that extend or mixin C or M.
optionalTypeArgs → const _OptionalTypeArgs
Used to annotate a class, mixin, extension, function, method, or typedef
declaration C. Indicates that any type arguments declared on C are to
be treated as optional.
PASCAL_CASE → const String
A key representing pascal case.
PASCAL_CASE_EXAMPLE → const String
Pascal case example.
PATH_CASE → const String
A key representing path case.
PATH_CASE_EXAMPLE → const String
Path case example.
protected → const _Protected
Used to annotate an instance member in a class or mixin which is meant to
be visible only within the declaring library, and to other instance members
of the class or mixin, and their subtypes.
redeclare → const _Redeclare
Used to annotate an instance member of an extension type that
redeclares a member from a superinterface.
reopen → const _Reopen
Annotation for intentionally loosening restrictions on subtyping that would
otherwise cause lint warnings to be produced by the implicit_reopen lint.
required → const Required
Used to annotate a named parameter p in a method or function f.
Indicates that every invocation of f must include an argument
corresponding to p, despite the fact that p would otherwise be an
optional parameter.
sealed → const _Sealed
Annotation marking a class as not allowed as a super-type
outside of the current package.
T_CAMEL_CASE_STRING → const String
T_LOWER_CASE_STRING → const String
T_LOWER_KEBAB_CASE_STRING → const String
T_LOWER_SNAKE_CASE_STRING → const String
T_PASCAL_CASE_STRING → const String
T_SEARCHABLE_STRING → const String
T_UPPER_CASE_STRING → const String
T_UPPER_KEBAB_CASE_STRING → const String
T_UPPER_SNAKE_CASE_STRING → const String
UPPER_DOT_CASE → const String
A key representing upper dot case.
UPPER_DOT_CASE_EXAMPLE → const String
Upper dot case example.
UPPER_KEBAB_CASE → const String
A key representing upper kebab case.
UPPER_KEBAB_CASE_EXAMPLE → const String
Upper kebab case example.
UPPER_SNAKE_CASE → const String
A key representing upper snake case.
UPPER_SNAKE_CASE_EXAMPLE → const String
Upper snake case example.
useResult → const UseResult
Used to annotate a method, field, or getter within a class, mixin, or
extension, or a or top-level getter, variable or function to indicate that
the value obtained by invoking it should be used. A value is considered used
if it is assigned to a variable, passed to a function, or used as the target
of an invocation, or invoked (if the result is itself a function).
virtual → const _Virtual
Used to annotate a field that is allowed to be overridden in Strong Mode.
visibleForOverriding → const _VisibleForOverriding
Used to annotate an instance member that was made public so that it could be
overridden but that is not intended to be referenced from outside the
defining library.
visibleForTesting → const _VisibleForTesting
Used to annotate a declaration that was made public, so that it is more
visible than otherwise necessary, to make code testable.
Properties
let → T? Function<T >(dynamic input
Alias for letOrNull .
final
letAs → T? Function<T >(dynamic input
Alias for letAsOrNull .
final
letAsJMap → Map <String dynamic > ? Function(dynamic input
Alias for letAsJMapOrNull .
final
letBool → bool ? Function(dynamic input
Alias for letBoolOrNull .
final
letDateTime → DateTime ? Function(dynamic input
Alias for letDateTimeOrNull .
final
letDouble → double ? Function(dynamic input
Alias for letDoubleOrNull .
final
letDuration → Duration ? Function(dynamic input
Alias for letDurationOrNull .
final
letFirestoreTimestamp → FirestoreTimestamp ? Function(dynamic input
Alias for letFirestoreTimestampOrNull .
final
letInt → int ? Function(dynamic input
Alias for letIntOrNull .
final
letIterable → Iterable <T > ? Function<T >(dynamic input , {bool filterNulls = false , dynamic nullFallback
Alias for letIterableOrNull .
final
letList → List <T > ? Function<T >(dynamic input , {bool filterNulls = false , T? nullFallback
Alias for letListOrNull .
final
letMap → Map <K , V > ? Function<K , V >(dynamic input , {bool filterNulls = false , dynamic nullFallback
Alias for letMapOrNull .
final
letNum → num ? Function(dynamic input
Alias for letNumOrNull .
final
letSet → Set <T > ? Function<T >(dynamic input , {bool filterNulls = false , T? nullFallback
Alias for letSetOrNull .
final
letUri → Uri ? Function(dynamic input
Alias for letUriOrNull .
final
minMobileAspectRatio → double
The smallest of the following common aspect ratios for mobile phones (4.0 / 3.0)
no setter
prepRegExp → RegExp
final
Functions
castAsOrNull <T > (dynamic input → T?
Similar to letAsOrNull , but uses a try-catch block internally.
combinedOrderedStringId (List <String ids → String
Generates an ordered ID from a list of unordered IDs, that can be
used to identify the list of IDs.
combinePathSets (List <Set <String pathSets → Set <String
Combines multiple pathSets into a single set, returning all possible
combinations.
convertToStringCaseType (String value , StringCaseType ?stringCaseType → String
Converts a string to a specific case type.
csvToMap (String input → Map <int List <String
Converts a CSV string to a map.
dayAgo (DateTime date , String tr (String String locale → String
Returns a string representing the day ago from the given date. Requires a
translation function tr to translate the string into the given locale.
debugLog (dynamic message , [Symbol ?group , Rec ?rec → void
⚪️ Logs a message to the console.
debugLogAlert (dynamic message , [Symbol ?group , Rec ?rec → void
🟠 Logs an alert message to the console.
debugLogError (dynamic message , [Symbol ?group , Rec ?rec → void
🔴 Logs an error message to the console.
debugLogIgnore (dynamic message , [Symbol ?group , Rec ?rec → void
🟡 Logs an ignore message to the console.
debugLogInfo (dynamic message , [Symbol ?group , Rec ?rec → void
🟣 Logs an info message to the console.
debugLogMessage (dynamic message , [Symbol ?group , Rec ?rec → void
🟤 Logs a debug message to the console.
debugLogStart (dynamic message , [Symbol ?group , Rec ?rec → void
🔵 Logs a start message to the console.
debugLogStop (dynamic message , [Symbol ?group , Rec ?rec → void
⚫ Logs a stop message to the console.
debugLogSuccess (dynamic message , [Symbol ?group , Rec ?rec → void
🟢 Logs a success message to the console.
expandFlattenedJson (Map input , {String separator = '.' → Map
Expands a flattened JSON map, e.g. {'a.b': 1} to {a.b: 1, b: 1}.
expandJson (Map input , {String separator = '.' → Map
Expands a Json map, e.g. {'a': {'b': 1}} to {a.b: 1, b: 1}.
Extracts nested scopes from a source string based on opening and
closing delimiters.
flattenJson (Map input , {String separator = '.' → Map
Flattens a nested JSON object into a single-level map with string keys.
getBaseName (String path → String
Returns the base name of a given file path.
getDirPath (String path → String
Returns the directory path of a given file path.
getFileNameWithoutExtension (String filePath → String
Converts the given filePath to a consistent, local path format.
getFirstDate (Iterable <DateTime ?dates → DateTime ?
Returns the first date in the list of dates.
getLastDate (Iterable <DateTime ?dates → DateTime ?
Returns the last date in the list of dates.
getSetDifference <T > (Set <T > before , Set <T > after → Set <T >
Returns the difference between two sets.
isMatchingFileName (String filePath , String begType , String endType → ({String fileName , bool status }
Checks if the file name extracted from filePath matches the specified
beginning type begType and ending type endType.
isNullable <T > ()
→ bool
Returns true if T is nullable.
isPrivateFileName (String filePath → bool
Checks if the provided filePath is a private file (starts with an
underscore).
isSameDay (DateTime date1 , DateTime date2 → bool
Checks if two dates are on the same day.
isSameMonth (DateTime date1 , DateTime date2 → bool
Checks if two dates are on the same month.
isSameWeek (DateTime date1 , DateTime date2 → bool
Checks if two dates are on the same week.
jsonDecode (String source , {Object ?reviver (Object ?key , Object ?value → dynamic
Parses the string and returns the resulting Json object.
jsonEncode (Object ?object , {Object ?toEncodable (Object ?nonEncodable → String
Converts object to a JSON string.
letAsJMapOrNull (dynamic input → Map <String dynamic > ?
Let's you cast input to a Map<String, dynamic> type if possible, or
returns null if the cast cannot be performed.
letAsOrNull <T > (dynamic input → T?
Let's you cast input to a T type if possible, or returns null if the
cast cannot be performed.
letBoolOrNull (dynamic input → bool ?
Let's you convert input to a bool type if possible, or returns null if
the conversion cannot be performed.
letDateTimeOrNull (dynamic input → DateTime ?
Let's you convert input to a DateTime type if possible, or returns null
if the conversion cannot be performed.
letDoubleOrNull (dynamic input → double ?
Let's you convert input to a double type if possible, or returns null if
the conversion cannot be performed.
letDurationOrNull (dynamic input → Duration ?
Let's you convert input to a Duration type if possible, or returns null
if the conversion cannot be performed.
letFirestoreTimestampOrNull (dynamic input → FirestoreTimestamp ?
Let's you convert input to a FirestoreTimestamp type if possible, or
returns null if the conversion cannot be performed.
letIntOrNull (dynamic input → int ?
Let's you convert input to an int type if possible, or returns null if
the conversion cannot be performed.
letIterableFromCommaSeparatedString (String input → Iterable <String
Let's you convert input to an Iterable of Strings if possible, or returns
null if the conversion cannot be performed.
letIterableOrNull <T > (dynamic input , {bool filterNulls = false , dynamic nullFallback → Iterable <T > ?
Let's you convert input to an Iterable type if possible, or returns null
if the conversion cannot be performed.
letListOrNull <T > (dynamic input , {bool filterNulls = false , T? nullFallback → List <T > ?
Let's you convert input to a List type if possible, or returns null if
the conversion cannot be performed.
letMapOrNull <K , V > (dynamic input , {bool filterNulls = false , dynamic nullFallback → Map <K , V > ?
Let's you convert input to a Map type if possible, or returns null if
the conversion cannot be performed.
letNumOrNull (dynamic input → num ?
Let's you convert input to a num type if possible, or returns null if the
conversion cannot be performed.
letOrNull <T > (dynamic input → T?
Let's you convert input to a T type if possible, or returns null if the
conversion cannot be performed.
letSetOrNull <T > (dynamic input , {bool filterNulls = false , T? nullFallback → Set <T > ?
Let's you convert input to a Set type if possible, or returns null if
the conversion cannot be performed.
letUriOrNull (dynamic input → Uri ?
Let's you convert input to a Uri type if possible, or returns null if
the conversion cannot be performed.
mapToCsv (Map input → String
Converts a map to a CSV string.
mapToJson <T1 , T2 > (Map <T1 , T2 > input , {Set <Type typesAllowed = const {} , String ?keyConverter (dynamic → Json
Converts a map to a Json map by recursively converting its keys and values
to Json compatible types.
matchesAnyExtension (String filePath , Set <String extensions , {bool caseSensitive = true → bool
Checks if the provided filePath matches any of the specified extensions.
matchesAnyPathPattern (String path , Set <String pathPatterns → bool
Checks if the provided path matches any of the specified pathPatterns.
maybeAddToIterable <T > (Iterable <T > ?source , Iterable <T > ?add → Iterable <T > ?
Adds add to source if both are not null.
maybeAddToList <T > (List <T > ?source , List <T > ?add → List <T > ?
Adds add to source if both are not null.
maybeAddToMap <T1 , T2 > (Map <T1 , T2 > ?source , Map <T1 , T2 > ?add → Map <T1 , T2 > ?
Adds add to source if both are not null.
maybeAddToSet <T > (Set <T > ?source , Set <T > ?add → Set <T > ?
Adds add to source if both are not null.
mergeDataDeep (dynamic a , dynamic b , [dynamic elseFilter (dynamic → dynamic
Merges two data structures deeply.
mergeDataDeepIncludeCallsToJson (dynamic a , dynamic b → dynamic
Merges two data structures deeply and tries to perform toJson on objects.
mergeDataDeepIncludeCallsToMap (dynamic a , dynamic b → dynamic
Merges two data structures deeply and tries to perform toMap on objects.
mergeIterables (dynamic a , dynamic b → Iterable
Merges two iterables into one iterable.
mergeListsSetsOrQueues (Iterable a , Iterable b → Iterable
Merges two Iterables into one. Supported Iterable types are List, Set, and
Queue.
mergeMapsDeep <K , V > (List <Map <K , V > maps → Map <K , V >
Merges all maps deeply.
nullFilteredList <T > (Iterable input → List <T >
Converts input to a List with non-null elements if T is non-null.
nullFilteredMap <K , V > (Map input → Map <K , V >
Converts input to a Map with non-null keys and values if K and V are
non-null.
nullFilteredSet <T > (Iterable input → Set <T >
Converts input to a Set with non-null elements if T is non-null.
nullIfEmpty <T > (T value → T?
Returns null if value is empty, otherwise returns value.
pathContainsComponent (String path , Set <String components → bool
Checks if the provided path contains any of the specified components.
This operation is case-insensitive.
pollingStream <T > (Future <T > callback (), Duration interval → Stream <T >
Creates a Stream that polls a callback at a specified interval.
printBlack (Object ?message → void
Prints the message in black using AnsiStyle .
printBlue (Object ?message → void
Prints the message in blue using AnsiStyle .
printCyan (Object ?message → void
Prints the message in cyan using AnsiStyle .
printGreen (Object ?message → void
Prints the message in green using AnsiStyle .
printLightBlack (Object ?message → void
Prints the message in light black using AnsiStyle .
printLightBlue (Object ?message → void
Prints the message in light blue using AnsiStyle .
printLightCyan (Object ?message → void
Prints the message in light cyan using AnsiStyle .
printLightGreen (Object ?message → void
Prints the message in light green using AnsiStyle .
printLightPurple (Object ?message → void
Prints the message in light purple using AnsiStyle .
printLightRed (Object ?message → void
Prints the message in light red using AnsiStyle .
printLightWhite (Object ?message → void
Prints the message in light white using AnsiStyle .
printLightYellow (Object ?message → void
Prints the message in light yellow using AnsiStyle .
printPurple (Object ?message → void
Prints the message in purple using AnsiStyle .
printRed (Object ?message → void
Prints the message in red using AnsiStyle .
printWhite (Object ?message → void
Prints the message in white using AnsiStyle .
printYellow (Object ?message → void
Prints the message in yellow using AnsiStyle .
recursiveReplace (Map input , {ReplacePatternsSettings settings = const ReplacePatternsSettings() → Map
Performs recursive replacement of string values within a map using
placeholders defined by the map's own key-value pairs. It supports nested
structures (maps and lists) and replaces placeholders in strings with
corresponding values.
replaceData (String input , Map <Pattern dynamic > data → String
Replaces the keys of data in input with the corresponding values.
replacePatterns (String input , Map data , {ReplacePatternsSettings settings = const ReplacePatternsSettings() → String
Replaces placeholders in a string with corresponding values from a provided
map, supporting default values and custom delimiters.
sortDates (List <DateTime dates → List <DateTime
Checks if two dates are on the same year.
streamToFuture <T > (Stream <T > stream → Future <T >
Waits for the first value from the Stream and returns it as a Future .
timeAgo (DateTime date , String tr (String String locale → String
Returns a string representing the time ago from the given date. Requires a
translation function tr to translate the string into the given locale.
toLocalSystemPathFormat (String path → String
Replaces all forward slashes in path with the local path separator.
toUnixSystemPathFormat (String path → String
Replaces all backslashes in path with forward slashes.
toWindowsSystemPathFormat (String path → String
Replaces all forward slashes in path with backslashes.
trimmedOrNull (Object ?input → String ?
Converts the input to a string if it's not null and trims it or returns
null if the result is empty.
tryToJson (dynamic object → dynamic
Tries to convert an object to a json map by calling its toJson method if it
exists.
tryToMap (dynamic object → dynamic
Tries to convert an object to a map by calling its toMap method if it exists.
typeEquality <T1 , T2 > ()
→ bool
Returns true if T1 and T2 are the same type.
uniqueEntries <K , V > (Iterable <MapEntry <K , V > entries → List <MapEntry <K , V >
uniqueKeys <K , V > (Iterable <MapEntry <K , V > entries → List <MapEntry <K , V >
uniqueValues <K , V > (Iterable <MapEntry <K , V > entries → List <MapEntry <K , V >
