Instruction class
Behavioural guidance containing principles, rules, mindset, and examples.
- Inheritance
-
- Object
- TWriteable
- TSerializable
- TPromptable
- Instruction
- Implementers
- Annotations
-
- @JsonSerializable.new(includeIfNull: false, explicitToJson: true)
Constructors
-
Instruction(String name, {TMetaData? metaData, List<
String> ? principles, List<String> ? rules, List<String> ? reasons, List<String> ? mindset, List<String> ? approach, List<String> ? responsibilities, List<String> ? understandings, List<String> ? examples, Template? template, Instruction? child, List<Instruction> ? children}) -
const
-
Instruction.fromJson(Map<
String, dynamic> json) -
factory
Properties
-
approach
→ List<
String> ? -
final
- cascadeDescriptionToMetaData → bool
-
finalinherited
- cascadeNameToMetaData → bool
-
finalinherited
- child → Instruction?
-
final
-
children
→ List<
Instruction> ? -
final
- description → String?
-
finalinherited
-
examples
→ List<
String> ? -
final
- fileName → String
-
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- jsonKey → String
-
no setterinherited
-
mdFactory
→ TMdFactory<
TWriteable> -
Returns a function that builds a Markdown string from a JSON map.
no setterinherited
- metaData → TMetaData?
-
finalinherited
-
mindset
→ List<
String> ? -
final
- name → String
-
finalinherited
-
principles
→ List<
String> ? -
final
-
reasons
→ List<
String> ? -
final
-
responsibilities
→ List<
String> ? -
final
-
rules
→ List<
String> ? -
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- template → Template?
-
final
-
understandings
→ List<
String> ? -
final
- value → String?
-
finalinherited
-
values
→ List<
String> ? -
finalinherited
- xmlBuilder → String Function(TWriteable writeable, bool includeMeta)?
-
Returns a function that builds an XML string from a JSON map.
finalinherited
- xmlKey → String
-
no setterinherited
- yamlBuilder → String Function(TWriteable writeable, bool includeMetaData)?
-
Returns a function that builds a YAML string from a JSON map.
finalinherited
- yamlKey → String
-
no setterinherited
Methods
-
mdFrontMatter(
) → Map< String, dynamic> -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
ref(
{String? openRef, String? closeRef, required TBodyType bodyType}) → String -
inherited
-
refJson(
{String? openRef, String? closeRef}) → String -
inherited
-
refMd(
{String? openRef, String? closeRef}) → String -
inherited
-
refXml(
{String? openRef, String? closeRef}) → String -
inherited
-
refYaml(
{String? openRef, String? closeRef}) → String -
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