Class: LlamaText

Constructors

new LlamaText()

new LlamaText(...values: readonly LlamaTextInputValue[]): LlamaText

Can also be called without new

Parameters

Parameter	Type
...values	readonly LlamaTextInputValue[]

Returns

LlamaText

Defined in

utils/LlamaText.ts:19

Properties

values

readonly values: readonly LlamaTextValue[];

Defined in

utils/LlamaText.ts:14

Methods

concat()

concat(value: LlamaTextInputValue): LlamaText

Parameters

Parameter	Type
value	LlamaTextInputValue

Returns

LlamaText

Defined in

utils/LlamaText.ts:24

---

mapValues()

mapValues(mapper: (this: readonly LlamaTextValue[], value: LlamaTextValue, index: number, values: readonly LlamaTextValue[]) => LlamaTextInputValue): LlamaText

Parameters

Parameter	Type
mapper	(this: readonly LlamaTextValue[], value: LlamaTextValue, index: number, values: readonly LlamaTextValue[]) => LlamaTextInputValue

Returns

LlamaText

Defined in

utils/LlamaText.ts:28

---

joinValues()

joinValues(separator: LlamaTextValue | LlamaText): LlamaText

Joins the values with the given separator.

Note that the values are squashed when they are loaded into the LlamaText, so the separator is not added between adjacent strings.

To add the separator on values before squashing them, use LlamaText.joinValues instead.

Parameters

Parameter	Type
separator	LlamaTextValue | LlamaText

Returns

LlamaText

Defined in

utils/LlamaText.ts:48

---

toString()

toString(): string

Returns

string

Defined in

utils/LlamaText.ts:65

---

toJSON()

toJSON(): LlamaTextJSON

Returns

LlamaTextJSON

Defined in

utils/LlamaText.ts:78

---

tokenize()

tokenize(tokenizer: Tokenizer, options?: "trimLeadingSpace"): Token[]

Parameters

Parameter	Type
tokenizer	Tokenizer
options?	"trimLeadingSpace"

Returns

Token[]

Defined in

utils/LlamaText.ts:94

---

compare()

compare(other: LlamaText): boolean

Parameters

Parameter	Type
other	LlamaText

Returns

boolean

Defined in

utils/LlamaText.ts:118

---

trimStart()

trimStart(): LlamaText

Returns

LlamaText

Defined in

utils/LlamaText.ts:122

---

trimEnd()

trimEnd(): LlamaText

Returns

LlamaText

Defined in

utils/LlamaText.ts:160

---

includes()

includes(value: LlamaText): boolean

Parameters

Parameter	Type
value	LlamaText

Returns

boolean

Defined in

utils/LlamaText.ts:198

---

fromJSON()

static fromJSON(json: LlamaTextJSON): LlamaText

Parameters

Parameter	Type
json	LlamaTextJSON

Returns

LlamaText

Defined in

utils/LlamaText.ts:265

---

compare()

static compare(a: LlamaText, b: LlamaText): boolean

Parameters

Parameter	Type
a	LlamaText
b	LlamaText

Returns

boolean

Defined in

utils/LlamaText.ts:287

---

fromTokens()

static fromTokens(tokenizer: Tokenizer, tokens: Token[]): LlamaText

Attempt to convert tokens to a LlamaText while preserving special tokens.

Non-standard special tokens that don't have a text representation are ignored.

Parameters

Parameter	Type
tokenizer	Tokenizer
tokens	Token[]

Returns

LlamaText

Defined in

utils/LlamaText.ts:309

---

joinValues()

static joinValues(separator: string | LlamaText, values: readonly LlamaTextInputValue[]): LlamaText

Join values with the given separator before squashing adjacent strings inside the values

Parameters

Parameter	Type
separator	string | LlamaText
values	readonly LlamaTextInputValue[]

Returns

LlamaText

Defined in

utils/LlamaText.ts:362

---

isLlamaText()

static isLlamaText(value: unknown): value is LlamaText

Parameters

Parameter	Type
value	unknown

Returns

value is LlamaText

Defined in

utils/LlamaText.ts:379