Main Navigation Guide Recipes API Errors Stability Transparency Design System vttforge.dev

Appearance

Sidebar Navigation

API reference

Overview

@vttforge/core

Classes

SystemConfig

VttfError

Interfaces

ActorConfig

ApplicationV2Members

ArrayFieldCtor

ArrayFieldInstance

ArrayFieldOptions

BaseApplicationMembers

BaseDocumentSheetMembers

BooleanFieldCtor

BooleanFieldInstance

ColorFieldCtor

ColorFieldInstance

CombatConfig

DataFieldOptions

DocumentSheetOptions

DocumentSheetV2Members

DragDropConfig

EmbeddedDataFieldCtor

EmbeddedDataFieldInstance

EmbeddedDocumentFieldCtor

EmbeddedDocumentFieldInstance

EnricherRegistration

ErrorManifest

FieldInstance

FieldsApi

FilePathFieldCtor

FilePathFieldInstance

FilePathFieldOptions

ForeignDocumentFieldCtor

ForeignDocumentFieldInstance

ForeignDocumentFieldOptions

FoundryConfig

GameApi

GameSettingsApi

HooksApi

HTMLFieldCtor

HTMLFieldInstance

ItemConfig

Migration

MigrationLogger

MigrationRunner

MigrationRunnerOptions

ModuleRegistration

NumberFieldCtor

NumberFieldInstance

NumberFieldOptions

SchemaFieldCtor

SchemaFieldInstance

SetFieldCtor

SetFieldInstance

SettingConfig

SheetBaseCtor

SheetBaseMembers

SheetBaseStatics

SheetRegistration

StatusEffectConfig

StringFieldCtor

StringFieldInstance

StringFieldOptions

SystemRegistration

SystemSettingOptions

TypeDataModelHooks

TypedSchemaFieldCtor

TypedSchemaFieldInstance

TypedTypeDataModelCtor

VttfErrorEntry

Type Aliases

BooleanFieldOptions

ColorFieldOptions

ConfigCollection

DataModelClass

DocumentClass

DocumentSheetKind

EmbeddedDataFieldOptions

EmbeddedDocumentFieldOptions

HookCallback

HTMLFieldOptions

InferField

InferSchema

Prettify

SchemaFieldOptions

SetFieldOptions

SettingScope

SheetDocumentKind

TypedSchemaFieldOptions

TypedTypeDataModel

VttfErrorCode

VttforgeClass

Variables

ERROR_MANIFEST_VERSION

VTTFORGE_CORE_VERSION

VTTFORGE_SHEET_CLASS

Functions

ActorDataModel

BaseActorSheet

BaseApplication

BaseDocumentSheet

BaseItemSheet

BaseTypeDataModel

createMigrationRunner

docsUrlFor

DocumentSheet

fields

getErrorEntry

getErrorManifest

ItemDataModel

listErrorEntries

moduleSubType

OnHook

registerEnrichers

registerModule

registerSheets

registerSystem

SystemSetting

@vttforge/types

Interfaces

ApplicationV2Members

DocumentSheetV2Members

Type Aliases

VttforgeClass

Variables

VTTFORGE_TYPES_VERSION

@vttforge/cli

Classes

ScaffoldError

Interfaces

AuditOptions

AuditReport

AuditResult

BuildOptions

DevOptions

EmitZipOptions

EmitZipResult

FoundryManifest

InitOptions

LintOptions

LintResult

ResolvedInitOptions

RuleResult

RunAuditOptions

Type Aliases

PackageType

ReportFormat

RuleFn

Severity

TemplateVariant

Variables

SEVERITY_RANK

VTTFORGE_CLI_VERSION

Functions

emitReleaseZip

emitZip

formatReport

readManifest

runAudit

runAuditCommand

runBuild

runDev

runInit

runLintCommand

runManifestRules

runSourceRules

@vttforge/vite-plugin

Interfaces

VttforgeOptions

Variables

VTTFORGE_VITE_PLUGIN_VERSION

Functions

default

@vttforge/testing

Interfaces

BatchOptions

MockDocument

MockDocumentOptions

MockFoundry

MockFoundryOptions

QuenchContext

RecordedEnricher

RecordedHook

RecordedSetting

RecordedSheet

Functions

createMockActor

createMockItem

registerBatch

withMockFoundry

On this page

@vttforge/cli / ReportFormat

Type Alias: ReportFormat

ReportFormat = "json" | "markdown"

Pager

Previous pagePackageType

Next pageRuleFn

MIT licensed.

Not affiliated with Foundry Gaming LLC or with The Forge hosting service.

Type Alias: ReportFormat ​

Type Alias: ReportFormat