TMetaData class

Structured metadata attached to any TPromptable.

Carries a name, description, optional tags, aliases, and emoji. Serialized as YAML frontmatter when rendering Markdown output.

Inheritance
  • Object
  • TWriteable
  • TSerializable
  • TMetaData
Annotations
  • @JsonSerializable.new(includeIfNull: false, explicitToJson: true)

Constructors

TMetaData({required String? description, required String? name, List<String>? aliases, String? emoji, List<String>? tags})
const
TMetaData.fromJson(Map<String, dynamic> json)
factory

Properties

aliases → List<String>?
final
description → String?
final
emoji → String?
final
hashCode → int
The hash code for this object.
no setterinherited
mdFactory → TMdFactory<TWriteable>?
Returns a function that builds a Markdown string from a JSON map.
finalinherited
name → String?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags → List<String>?
final
xmlBuilder → String Function(TWriteable writeable, bool includeMeta)?
Returns a function that builds an XML string from a JSON map.
finalinherited
yamlBuilder → String Function(TWriteable writeable, bool includeMetaData)?
Returns a function that builds a YAML string from a JSON map.
finalinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Converts the object to a Firestore-compatible map.
override
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

Constants

fromJsonFactory → const TMetaData Function(Map<String, dynamic> json)
toJsonFactory → const Map<String, dynamic> Function(TMetaData instance)