@vttforge/testing / index / MockDocument

Interface: MockDocument

A Foundry document, as much of one as a unit test needs.

Properties

flags

flags: Record<string, Record<string, unknown>>

---

id

id: string

---

name

name: string

---

system

system: Record<string, any>

---

type

type: string

---

updates

readonly updates: readonly Record<string, unknown>[]

Every update this document received, in order.

Methods

getFlag()

getFlag(scope, key): unknown

Parameters

scope

string

key

string

Returns

unknown

---

setFlag()

setFlag(scope, key, value): Promise<MockDocument>

Parameters

scope

string

key

string

value

unknown

Returns

Promise<MockDocument>

---

unsetFlag()

unsetFlag(scope, key): Promise<MockDocument>

Parameters

scope

string

key

string

Returns

Promise<MockDocument>

---

update()

update(delta): Promise<MockDocument>

Parameters

delta

Record<string, unknown>

Returns

Promise<MockDocument>