@vttforge/core / syncKeywordJournal

Function: syncKeywordJournal()

syncKeywordJournal(packageId, keywords, name?): Promise<"created" | "updated" | "unchanged" | "skipped">

Create the keywords journal, or rewrite its page when the content changed. Runs on the GM's client only; other clients return at once.

The journal and its page are found by a flag under the package's scope, not by name or position, so the GM can rename the journal and add pages of their own; only the flagged page is ever rewritten.

Parameters

packageId

string

keywords

readonly Keyword[]

name?

string

Returns

Promise<"created" | "updated" | "unchanged" | "skipped">