Index class
Index describes a search index.
- Annotations
-
- @freezed
Constructors
- Index({required String indexPath, required String name, required String language, @Default(false) bool? keepStopWords, @Default(false) bool? caseSensitive, @Default(false) bool? noStem})
-
Default Constructor
constfactory
-
Index.fromJson(Map<
String, dynamic> json) -
Unmarshalls from json to Index
factory
Properties
- caseSensitive → bool?
-
CaseSensitive preserves case across this index. By default, all entries and
queries are lower cased.
no setterinherited
-
copyWith
→ $IndexCopyWith<
Index> -
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- indexPath → String
-
IndexPath is the collection path in Firestore for this index. Each index must
use a unique path.
no setterinherited
- keepStopWords → bool?
-
KeepStopWords prevents stop words from being removed from this index.
no setterinherited
- language → String
-
Language of the index.
no setterinherited
- name → String
-
Name is an internal human readable name for this index. End users will never see
this.
no setterinherited
- noStem → bool?
-
NoStem prevents words from being reduced. Only effective if a Language is
specified.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited