TPromptable class abstract

Inheritance
  • Object
  • TWriteable
  • TSerializable
  • TPromptable
Implementers

Constructors

TPromptable({required String name, String? description, TMetaData? metaData, bool cascadeNameToMetaData = true, bool cascadeDescriptionToMetaData = true, List<String>? values, String? value})
const

Properties

cascadeDescriptionToMetaData → bool
final
cascadeNameToMetaData → bool
final
description → String?
final
fileName → String
no setter
hashCode → int
The hash code for this object.
no setterinherited
jsonKey → String
no setter
mdFactory → TMdFactory<TWriteable>
Returns a function that builds a Markdown string from a JSON map.
no setteroverride
metaData → TMetaData?
final
name → String
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
value → String?
final
values → List<String>?
final
xmlBuilder → String Function(TWriteable writeable, bool includeMeta)?
Returns a function that builds an XML string from a JSON map.
finalinherited
xmlKey → String
no setter
yamlBuilder → String Function(TWriteable writeable, bool includeMetaData)?
Returns a function that builds a YAML string from a JSON map.
finalinherited
yamlKey → String
no setter

Methods

mdFrontMatter() → Map<String, dynamic>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
ref({String? openRef, String? closeRef, required TBodyType bodyType}) → String
refJson({String? openRef, String? closeRef}) → String
refMd({String? openRef, String? closeRef}) → String
refXml({String? openRef, String? closeRef}) → String
refYaml({String? openRef, String? closeRef}) → String
toJson() → Map<String, dynamic>
Converts the object to a Firestore-compatible map.
inherited
toMd({TMdFactory<TWriteable>? mdFactory, bool includeMetaData = true, int headingLevel = 1, KeyValueBuilderDef? titleBuilder, KeyValueBuilderDef? listItemBuilder, String metaDataKey = TSDefaults.metaDataKey, String emojiKey = TSDefaults.emojiKey, String nameKey = TSDefaults.nameKey, String descriptionKey = TSDefaults.descriptionKey, String valueKey = TSDefaults.valueKey, String valuesKey = TSDefaults.valuesKey, String itemsKey = TSDefaults.itemsKey}) → String
Converts this object to a Markdown string.
inherited
toString() → String
A string representation of this object.
inherited
toXml({bool includeMetaData = true, KeyValueBuilderDef? keyBuilder, KeyValueBuilderDef? listItemBuilder, String metaDataKey = TSDefaults.metaDataKey}) → String
Converts this object to an XML string.
inherited
toYaml({bool includeMetaData = true, KeyValueBuilderDef? keyBuilder, String metaDataKey = TSDefaults.metaDataKey, KeyValueBuilderDef? listItemBuilder}) → String
Converts this object to a YAML string.
inherited
validate<T>() → TurboResponse<T>?
Validates the object's data before writing to Firestore.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited