Guard.md

@guardrails-ai/core / Exports / Guard

Class: Guard<T>

Type parameters

Name
T

Table of contents

Constructors

• constructor

Properties

• _history
• pyGuard

Accessors

• history

Methods

• cloneHistory
• cloneProperties
• parse
• fromRail
• fromRailString
• fromString

Constructors

constructor

• new Guard<T>(pyGuard): Guard<T>

Type parameters

Name
T

Parameters

Name	Type
pyGuard	any

Returns

Guard<T>

Defined in

src/guard.ts:16

Properties

_history

• Private _history: Stack<Call<T>>

Defined in

src/guard.ts:14

---

pyGuard

• Private pyGuard: any

Defined in

src/guard.ts:13

Accessors

history

• get history(): Stack<Call<T>>

Returns

Stack<Call<T>>

Defined in

src/guard.ts:117

Methods

cloneHistory

▸ cloneHistory(): Promise<void>

Returns

Promise<void>

Defined in

src/guard.ts:110

---

cloneProperties

▸ cloneProperties(): Promise<void>

Returns

Promise<void>

Defined in

src/guard.ts:105

---

parse

▸ parse(llmOutput, opts?): Promise<ValidationOutcome<T>>

Parameters

Name	Type
llmOutput	string
opts	ParseOptions

Returns

Promise<ValidationOutcome<T>>

Defined in

src/guard.ts:69

---

fromRail

▸ fromRail(railFile, opts?): Promise<Guard<string | Dictionary>>

Parameters

Name	Type
railFile	string
opts	FromRailOptions

Returns

Promise<Guard<string | Dictionary>>

Defined in

src/guard.ts:21

---

fromRailString

▸ fromRailString(railString, opts?): Promise<Guard<string | Dictionary>>

Parameters

Name	Type
railString	string
opts	FromRailOptions

Returns

Promise<Guard<string | Dictionary>>

Defined in

src/guard.ts:33

---

fromString

▸ fromString(validators, opts?): Promise<Guard<string>>

Parameters

Name	Type
validators	any[]
opts	FromStringOptions

Returns

Promise<Guard<string>>

Defined in

src/guard.ts:47