MessageBuilder
Defined in: packages/client/src/builders/message-builder.ts:17
Builds a byte-budgeted text: title, lines, fields, footer; build(budget) errors, truncates or splits per
setOverflow.
Constructors
Constructor
new MessageBuilder(): MessageBuilder;Returns
MessageBuilder
Accessors
overflow
Get Signature
get overflow(): OverflowMode;Defined in: packages/client/src/builders/message-builder.ts:69
Returns
Methods
addField()
addField(name, value): this;Defined in: packages/client/src/builders/message-builder.ts:46
Parameters
name
string
Field label
value
string
Field value
Returns
this
addLine()
addLine(text): this;Defined in: packages/client/src/builders/message-builder.ts:31
Parameters
text
string
One line
Returns
this
addLines()
addLines(texts): this;Defined in: packages/client/src/builders/message-builder.ts:37
Parameters
texts
Iterable<string>
One line each
Returns
this
build()
build(budget): string[];Defined in: packages/client/src/builders/message-builder.ts:82
Parameters
budget
number
Budget in UTF-8 bytes
Returns
string[]
measure()
measure(budget?): object;Defined in: packages/client/src/builders/message-builder.ts:74
Parameters
budget?
number = DM_TEXT_BUDGET
Budget in UTF-8 bytes. Default the DM budget
Returns
object
bytes
bytes: number;limit
limit: number;parts
parts: number;setFooter()
setFooter(text): this;Defined in: packages/client/src/builders/message-builder.ts:52
Parameters
text
string
Last line
Returns
this
setOverflow()
setOverflow(mode, options?): this;Defined in: packages/client/src/builders/message-builder.ts:61
Parameters
mode
error, truncate or split when the text exceeds the budget
options?
maxParts for split. Default 3
maxParts?
number
Returns
this
setTitle()
setTitle(text): this;Defined in: packages/client/src/builders/message-builder.ts:25
Parameters
text
string
First line
Returns
this
toString()
toString(): string;Defined in: packages/client/src/builders/message-builder.ts:100
Returns
string