kotlin-actions-toolkit/actions.core/Summary

Summary

external class Summary(source)

Constructors

Summary

constructor()

Functions

addBreak

fun addBreak(): Summary

Adds an HTML line break (
) to the summary buffer

addCodeBlock

fun addCodeBlock(code: String, lang: String = definedExternally): Summary

Adds an HTML codeblock to the summary buffer

addDetails

fun addDetails(label: String, content: String): Summary

Adds a collapsable HTML details element to the summary buffer

addEOL

fun addEOL(): Summary

Adds the operating system-specific end-of-line marker to the buffer

addHeading

fun addHeading(text: String, level: Number = definedExternally): Summary

Adds an HTML section heading element

fun addHeading(text: String, level: String = definedExternally): Summary

addImage

fun addImage(src: String, alt: String, options: SummaryImageOptions = definedExternally): Summary

Adds an HTML image tag to the summary buffer

addLink

fun addLink(text: String, href: String): Summary

Adds an HTML anchor tag to the summary buffer

addList

fun addList(items: ReadonlyArray<String>, ordered: Boolean = definedExternally): Summary

Adds an HTML list to the summary buffer

addQuote

fun addQuote(text: String, cite: String = definedExternally): Summary

Adds an HTML blockquote to the summary buffer

addRaw

fun addRaw(text: String, addEOL: Boolean = definedExternally): Summary

Adds raw text to the summary buffer

addSeparator

fun addSeparator(): Summary

Adds an HTML thematic break (

) to the summary buffer

addTable

fun addTable(rows: ReadonlyArray<SummaryTableRow>): Summary

Adds an HTML table to the summary buffer

clear

fun clear(): Promise<Summary>

Clears the summary buffer and wipes the summary file

emptyBuffer

fun emptyBuffer(): Summary

Resets the summary buffer without writing to summary file

isEmptyBuffer

fun isEmptyBuffer(): Boolean

If the summary buffer is empty

stringify

fun stringify(): String

Returns the current summary buffer as a string

write

fun write(options: SummaryWriteOptions = definedExternally): Promise<Summary>

Writes text in the buffer to the summary buffer file and empties buffer. Will append by default.