Global

Members

(constant) MAX_GROUP_DEPTH

Description:

• Recursion cutoff for group-includes-group nesting.

Source:

• src/listManifest.js, line 88

(constant) NSFW_TOKEN :RegExp

Description:

• Matches an nsfw token: a standalone word in a list name, delimited by a path separator, dash, dot, underscore, or the start/end of the string. So d/general-nsfw, clothes-nsfw, foo.nsfw.bar all match, but nsfwish does not.

Source:

• src/gatedLists.js, line 32

Type:

• RegExp

(constant) RESERVED_ANY :string

Description:

• Reserved wildcard base: {#any} (and {#any-sfw} / {#any-nsfw}) is not a file — it runs one random generator drawn from the whole v2 catalog, mode-aware. Reserved like the lists' {keyword}.

Source:

• src/dynPromptManifest.js, line 22

Type:

• string

(constant) RESERVED_WILDCARD :string

Description:

• Reserved wildcard base. {keyword} (and {keyword-sfw} / {keyword-nsfw}) are not files — they resolve to a random word drawn from ALL loaded vocabulary (mode-aware). The name is reserved: it always supersedes any list literally named keyword, silently (no error), the same way nsfw is a reserved filename token.

Source:

• src/listManifest.js, line 101

Type:

• string

(constant) RNG

Description:

• Default randomness (Math.random-based, matching the v2 generators' lodash usage).

Source:

• src/core/dpl/dpl.js, line 18

(constant) SFW_SUFFIX

Description:

• Suffix tokens that select an exclusive SFW or NSFW-inclusive variant.

Source:

• src/listManifest.js, line 91

(constant) browserLoader :object

Description:

• Browser data loader for the engine: Vite import.meta.glob bundles. Implements readExpansion, readListLines, listNames, expansionNames, loadDynamicPrompt, dynamicPromptNames, presetNames, loadPreset.

Source:

• src/core/browserLoader.js, line 264

Type:

• object

(constant) dynPromptTags :Object.<string, {category: (string|undefined), anime: (boolean|undefined), nsfw: (boolean|undefined)}>

Description:

• Per-generator tag metadata (the analog of listTags): a category plus anime/nsfw flags, for UI badges and docs. The category is normally derivable from the folder; this map only needs entries that carry extra flags. Anything absent defaults to { anime:false, nsfw:false }.

Source:

• src/dynPromptManifest.js, line 39

Type:

• Object.<string, {category: (string|undefined), anime: (boolean|undefined), nsfw: (boolean|undefined)}>

(constant) listTags :Object.<string, {category: (string|undefined), anime: (boolean|undefined), nsfw: (boolean|undefined)}>

Description:

• Per-list metadata. Any list not listed here defaults to { anime:false, nsfw:false }. nsfw:true means the list as a whole leans adult (still drawn only when includeAdult is on if it is also gated).

Source:

• src/listManifest.js, line 42

Type:

• Object.<string, {category: (string|undefined), anime: (boolean|undefined), nsfw: (boolean|undefined)}>

(constant) nodeLoader :object

Description:

• Node data loader for the engine: filesystem reads + createRequire dynamic-prompt loading. Implements readExpansion, readListLines, listNames, expansionNames, loadDynamicPrompt, dynamicPromptNames.

Source:

• src/core/nodeLoader.js, line 188

Type:

• object

Methods

_displayProgress(noBack, isUpscale, isAnim)

Description:

• Display progress.

Source:

• src/web/frontend/main.js, line 103

Parameters:

_reIndexToUrl(url)

Description:

• Re index to url.

Source:

• src/web/frontend/main.js, line 82

Parameters:

_reindexHome()

Description:

• Reindex home.

Source:

• src/web/frontend/main.js, line 67

actionMenuSelection()

Description:

• Action menu selection.

Source:

• src/web/frontend/single.js, line 712

addRemoveButton()

Description:

• Add remove button.

Source:

• src/web/frontend/generate.js, line 559

adultAllowed() → {boolean}

Source:

• src/promptFilesAndSuggestions.js, line 221

Returns:

Type

boolean

allListNames(names) → {Array.<string>}

Source:

• src/listManifest.js, line 354

Parameters:

Returns:

Type

Array.<string>

artistRepeater(artist, alias, settings) → {string}

Description:

• Emit a random number of artist tokens — gated by settings.includeArtist and a 50% coin flip — between settings.minArtist and settings.maxArtist.

Source:

• src/helpers/keywordRepeater.js, line 71

Parameters:

Returns:

Type

string

autoGroupListDirs(listNames, enableDirsopt, disableDirsopt) → {Array.<string>}

Description:

• Folders that are IMPLIED groups: a folder with 2+ direct list files is auto-marked (referenceable as {folder} = union of its own lists). An enable-group-list marker forces a folder on (even with one list); a disable-group-list marker forces it off. Does NOT stack — only the folder's own direct lists count, not its subfolders.

Source:

• src/listManifest.js, line 163

Parameters:

Returns:

Type

Array.<string>

breakdownData(txt, name, settings, imageSettings, upscaleSettings) → {object}

Description:

• Parse the lines of an AUTOMATIC1111 parameters block into the JSON sidecar shape (prompt, negative prompt, steps, sampler, cfg, seed, size, model, denoising, …).

Source:

• src/convertMetaToJSON.js, line 60

Parameters:

Returns:

Type

object

buildIndexes(settings, directoryName) → {void}

Description:

• Walk the output directory and index every sidecar file (non-recursive).

Source:

• src/web/backend/indexImages.js, line 320

Parameters:

Returns:

Type

void

buildTree(lines, depth, startopt) → {Object}

Description:

• Recursively group depth-tagged lines into { line, children } nodes.

Source:

• src/core/dpl/dpl.js, line 129

Parameters:

Returns:

Type

Object

charRank(ch) → {number}

Description:

• Class rank for a single character: symbols (0) sort before digits (1) before letters (2). Gives a guaranteed, predictable ordering.

Source:

• src/listManifest.js, line 304

Parameters:

Returns:

Type

number

check(name, imageSettings) → {boolean}

Source:

• src/convertMetaToJSON.js, line 208

Parameters:

Returns:

Type

boolean

classifyRemoval(line, optsopt) → {Object|null}

Description:

• Classify a single list line for removal.

Source:

• src/contentSafety.js, line 376

Parameters:

Returns:

Type

Object | null

clearImages()

Description:

• Clear images.

Source:

• src/web/frontend/feed.js, line 32

compareNames(a, b) → {number}

Description:

• Natural-order comparator giving a GUARANTEED load/precedence order: symbols first, then numbers in true numeric order (so 2 before 10), then letters alphabetically. Lets users engineer a deterministic default by prefixing a name with a symbol or number.

Source:

• src/listManifest.js, line 320

Parameters:

Returns:

Type

number

compileDpl(source, bridgeopt) → {Object}

Description:

• Compile a .dpl source into a dynamic-prompt module object (same shape as a JS generator).

Source:

• src/core/dpl/dpl.js, line 412

Parameters:

Returns:

Type

Object

completePage()

Description:

• Complete page.

Source:

• src/web/frontend/single.js, line 141

computeButtonNames(names, forcedDirsopt) → {Object.<string, string>}

Description:

• Compute the SHORTEST unambiguous display token for each list, for editor buttons. By default a list shows just its filename; a name only grows a folder prefix when it would otherwise be ambiguous.

  Two stages:

  1. Manual prefix (.force-prefix) — any name under a folder marked with a .force-prefix file shows its path from the highest such ancestor down (e.g. danbooru/d/general → d/general). These are excluded from the auto step, so they never push a prefix onto anyone else.
  2. Auto prefix — the rest start at the bare filename; whenever two share a token they each step out one more folder until distinct.

  A final pass guarantees every token resolveName()s back to its own canonical name (lengthening if a forced/other name would otherwise shadow it).

Source:

• src/listManifest.js, line 453

Parameters:

Returns:

Type

Object.<string, string>

configure(_loader) → {void}

Description:

• Inject the data loader (fs in Node, glob in the browser). Call once before loadAll().

Source:

• src/promptFilesAndSuggestions.js, line 27

Parameters:

Returns:

Type

void

convert(name, txt, settings, imageSettings, upscaleSettings) → {object}

Description:

• Convert a legacy .txt metadata sidecar to .json (replacing the file on disk), or parse provided text.

Source:

• src/convertMetaToJSON.js, line 180

Parameters:

Returns:

Type

object

convertToPath(name) → {string}

Description:

• Map a user--prefixed dynamic-prompt name to its user-submitted/ path.

Source:

• src/prompt-modules/dynamic-prompt.js, line 59

Parameters:

Returns:

Type

string

copyPrompt()

Description:

• Copy prompt.

Source:

• src/web/frontend/single.js, line 651

copyShareLink()

Description:

• Copy share link.

Source:

• src/web/frontend/generate.js, line 838

createEngine(loader) → {Object}

Description:

• Create a framework-agnostic prompt engine that runs the same pipeline as the CLI.

Source:

• src/core/engine.js, line 47

Parameters:

Returns:

Type

Object

createListStore(loader) → {Object}

Description:

• Create a loader-backed list store with the original once-only depletion + alias behaviour.

Source:

• src/core/listStore.js, line 19

Parameters:

Returns:

Type

Object

danbooruReplacer(prompt, settings) → {string}

Description:

• When an anime/danbooru keyword dict is active, rewrite a trailing , Person to {d-person} so the anime character list is used instead of the generic person list.

Source:

• src/prompt-modules/dynamic-prompt.js, line 40

Parameters:

Returns:

Type

string

dataRefreshComplete(data)

Description:

• Data refresh complete.

Source:

• src/web/frontend/progress.js, line 12

Parameters:

deepLink(fromName, toName, linkType) → {void}

Description:

• Record a deep link from one file to another under a link type, creating the placeholder/array as needed.

Source:

• src/web/backend/indexImages.js, line 163

Parameters:

Returns:

Type

void

dirOpen(dirPath) → {Buffer|undefined}

Description:

• Open a folder in the OS file explorer (cross-platform).

Source:

• src/server.js, line 64

Parameters:

Returns:

Type

Buffer | undefined

displayProgress(noBack, isUpscale, isAnim)

Description:

• Display progress.

Source:

• src/web/frontend/main.js, line 127

Parameters:

downloadLists()

Description:

• Download lists.

Source:

• src/web/frontend/settings.js, line 240

downloadSettings()

Description:

• Download settings.

Source:

• src/web/frontend/settings.js, line 258

dynGroupDirs(names, enableDirsopt, disableDirsopt) → {Array.<string>}

Description:

• The category folders that are IMPLIED groups: a v2 folder with 2+ generators. Reuses the list rule (autoGroupListDirs) over the v2 names only (v1/ is excluded — it is reached via {#name-v1}, never grouped). Marker dirs force a folder on/off.

Source:

• src/dynPromptManifest.js, line 52

Parameters:

Returns:

Type

Array.<string>

dynGroupMembers(dir, names) → {Array.<string>}

Description:

• Direct-child generator names of a group folder (NOT descendants — groups don't stack).

Source:

• src/dynPromptManifest.js, line 66

Parameters:

Returns:

Type

Array.<string>

editIn(settings, keyword) → {string}

Description:

• Prompt-editing "edit-in": [kw:n] — kw appears after step n.

Source:

• src/helpers/randomEditing.js, line 30

Parameters:

Returns:

Type

string

editOut(settings, keyword) → {string}

Description:

• Prompt-editing "edit-out": [kw::n] — kw drops at step n.

Source:

• src/helpers/randomEditing.js, line 50

Parameters:

Returns:

Type

string

epochToDateString(epochTimestamp) → {*}

Description:

• Epoch to date string.

Source:

• src/web/frontend/main.js, line 23

Parameters:

Returns:

Type

*

(async) execApp() → {Promise.<object>}

Description:

• Spawn the CLI (node . --flags) with the current args to perform the actual generation, tracking execAppOngoing.

Source:

• src/server.js, line 158

Returns:

Type

Promise.<object>

(async) execMagick(argsopt, fileNamesopt, outputopt, silentopt) → {Promise.<object>}

Description:

• Run an ImageMagick (magick) command, auto-quoting args that need it.

Source:

• src/server.js, line 103

Parameters:

Returns:

Type

Promise.<object>

expandDynamicPromptV1(name, settings, imageSettings, upscaleSettings) → {string}

Description:

• Load and run a frozen v1 dynamic-prompt plugin (#name-v1); v1 bakes in fx and artists, so auto-add is forced off.

Source:

• src/prompt-modules/dynamic-prompt.js, line 98

Parameters:

Returns:

Type

string

expandDynamicPromptV2(name, settings, imageSettings, upscaleSettings) → {string}

Description:

• Load and run a v2 dynamic-prompt plugin (#name), applying danbooru substitution.

Source:

• src/prompt-modules/dynamic-prompt.js, line 74

Parameters:

Returns:

Type

string

expandExpansion(name, settings) → {string}

Description:

• Read an expansion file's raw text.

Source:

• src/prompt-modules/expansion.js, line 34

Parameters:

Returns:

Type

string

extendAnim(isSelect)

Description:

• Extend anim.

Source:

• src/web/frontend/single.js, line 482

Parameters:

fillListData(el)

Description:

• Fill list data.

Source:

• src/web/frontend/generate.js, line 345

Parameters:

fillSettingValue(el)

Description:

• Fill setting value.

Source:

• src/web/frontend/generate.js, line 364

Parameters:

find(regex, str, defopt) → {*}

Description:

• Match a regex against a string and return its first capture group, or a default.

Source:

• src/convertMetaToJSON.js, line 31

Parameters:

Returns:

Type

*

gatePool(names, isGated) → {Array.<string>}

Description:

• Drop gated (adult) names from a pool unless includeAdult is on.

Source:

• src/promptFilesAndSuggestions.js, line 232

Parameters:

Returns:

Type

Array.<string>

generate()

Description:

• Generate.

Source:

• src/web/frontend/generate.js, line 772

generationProgress()

Description:

• Generation progress.

Source:

• src/web/frontend/progress.js, line 112

getGalleryEl(prompt, imgSrc, width, height, name) → {*}

Description:

• Get gallery el.

Source:

• src/web/frontend/feed.js, line 54

Parameters:

Returns:

Type

*

getListFiles(settings) → {Array.<string>}

Description:

• Recursively list every .txt under the list dir as a "/"-joined relative name (e.g. danbooru/general), so lists can be organized into nested folders.

Source:

• src/helpers/listFiles.js, line 44

Parameters:

Returns:

Type

Array.<string>

(async) getProgress() → {Promise.<object>}

Description:

• Get generation progress (from the CLI progress server, or a stopped-state default), with the server's own execOngoing flag merged in.

Source:

• src/server.js, line 220

Returns:

Type

Promise.<object>

(async) getProgressRequest() → {Promise.<(object|undefined)>}

Description:

• Fetch generation progress from the CLI's progress server (port portProgress).

Source:

• src/server.js, line 201

Returns:

Type

Promise.<(object|undefined)>

getRndSalt() → {string}

Source:

• src/prompt-modules/prompt-salt.js, line 27

Returns:

Type

string

getUrlParameters() → {*}

Description:

• Get url parameters.

Source:

• src/web/frontend/main.js, line 10

Returns:

Type

*

hasNsfwToken(name) → {boolean}

Source:

• src/gatedLists.js, line 38

Parameters:

Returns:

Type

boolean

hasVariantSuffix(name) → {boolean}

Source:

• src/listManifest.js, line 362

Parameters:

Returns:

Type

boolean

homeFeed()

Description:

• Home feed.

Source:

• src/web/frontend/feed.js, line 216

imagesChanged()

Description:

• Images changed.

Source:

• src/web/frontend/feed.js, line 21

impliedGroupMembers(dir, readers) → {Array.<string>}

Description:

• Member reference lines for an IMPLIED group (a .force-group-list folder): the folder's OWN direct list files only (NOT descendants — implied groups don't stack), de-duplicated to base names (so -sfw/-nsfw pairs become one member resolved mode-aware), excluding real groups. The result feeds the normal group-union path.

Source:

• src/listManifest.js, line 137

Parameters:

Returns:

Type

Array.<string>

indexFile(settings, filePath) → {void}

Description:

• Index one output/*.json sidecar: register its paths + keywords and wire up its deep links to parents (upscale / variation / reroll / animation). Upscales are linked to their original, not indexed as their own entry.

Source:

• src/web/backend/indexImages.js, line 183

Parameters:

Returns:

Type

void

init(_settings) → {void}

Description:

• Provide the settings accessor used during suggestion cleanup.

Source:

• src/promptFilesAndSuggestions.js, line 57

Parameters:

Returns:

Type

void

initiateReindex()

Description:

• Initiate reindex.

Source:

• src/web/frontend/re-index.js, line 11

insertSelected()

Description:

• Insert selected.

Source:

• src/web/frontend/generate.js, line 277

insertSettings(obj, useAll)

Description:

• Insert settings.

Source:

• src/web/frontend/generate.js, line 690

Parameters:

insertStoredPrompt()

Description:

• Insert stored prompt.

Source:

• src/web/frontend/generate.js, line 668

isGatedDynPrompt(name) → {boolean}

Description:

• Gate a dynamic prompt behind includeAdult AUTOMATICALLY by its name token — the same rule lists/expansions use (isGatedList) — so a generator named e.g. subject/nude-nsfw is hidden/empty when adult is off, with no hardcoded list to keep in sync. The legacy gatedDynPrompts array is still honored as an extra escape hatch.

Source:

• src/gatedLists.js, line 63

Parameters:

Returns:

Type

boolean

isGatedList(name) → {boolean}

Source:

• src/gatedLists.js, line 51

Parameters:

Returns:

Type

boolean

isNsfw(line) → {boolean}

Source:

• src/contentSafety.js, line 406

Parameters:

Returns:

Type

boolean

isReservedAny(name) → {boolean}

Source:

• src/dynPromptManifest.js, line 28

Parameters:

Returns:

Type

boolean

isReservedWildcard(name) → {boolean}

Source:

• src/listManifest.js, line 107

Parameters:

Returns:

Type

boolean

joinPieces(pieces) → {string}

Description:

• Weighted-sort a list of { weight, text } pieces (stable; ties keep document order) and join the non-empty ones with ", ".

Source:

• src/core/dpl/dpl.js, line 258

Parameters:

Returns:

Type

string

keywordRepeater(keyword, alias, settings) → {string}

Description:

• Emit a random number of keyword tokens, between settings.keywordCount and settings.keywordMaxCount.

Source:

• src/helpers/keywordRepeater.js, line 58

Parameters:

Returns:

Type

string

labelSettings()

Description:

• Label settings.

Source:

• src/web/frontend/generate.js, line 567

lazyReloadListFile(settings, name) → {void}

Description:

• Mark a list slot empty so it is lazily re-read from disk on next pull.

Source:

• src/helpers/listFiles.js, line 147

Parameters:

Returns:

Type

void

lexLines(body) → {Array.<{depth: number, text: string, raw: string}>}

Description:

• Turn the body into indentation-tagged raw lines. The indent unit is the first indented line's leading whitespace (tab or N spaces), per the spec; depth = indent / unit.

Source:

• src/core/dpl/dpl.js, line 64

Parameters:

Returns:

Type

Array.<{depth: number, text: string, raw: string}>

loadAll() → {void}

Description:

• Load the dynamic-prompt, expansion, and list catalogs.

Source:

• src/promptFilesAndSuggestions.js, line 206

Returns:

Type

void

loadData()

Description:

• Load data.

Source:

• src/web/frontend/single.js, line 403

loadDynPromptList() → {object}

Description:

• Classify every dynamic prompt into full / partial (plus the v1 and user-submitted buckets) — the lists used by promptSuggestion() and the web file pickers.

Source:

• src/promptFilesAndSuggestions.js, line 76

Returns:

Type

object

loadExpansionFileList() → {Array.<string>}

Source:

• src/promptFilesAndSuggestions.js, line 156

Returns:

Type

Array.<string>

loadImageFeed()

Description:

• Load image feed.

Source:

• src/web/frontend/feed.js, line 121

loadListFileList() → {Array.<string>}

Description:

• Load the list names (and cache the artist-excluded subset).

Source:

• src/promptFilesAndSuggestions.js, line 166

Returns:

Type

Array.<string>

loadResults()

Description:

• Load results.

Source:

• src/web/frontend/results.js, line 43

loadSearchQuery(query)

Description:

• Load search query.

Source:

• src/web/frontend/feed.js, line 140

Parameters:

logicalListNames(physical) → {Array.<string>}

Description:

• Turn the physical on-disk names into the LOGICAL reference set, the names the rest of the app sees. A mixed list is stored as two files, <base>-sfw and <base>-nsfw, with NO <base> file — the bare {base} is implicit, and this exposes all three references (base, base-sfw, base-nsfw). A standalone <base>-nsfw with no <base>-sfw counterpart is exposed only by its gated -nsfw name (NSFW-only).

  Safety rule: a plain <p> file is only a normal SFW list when it has NO <p>-nsfw sibling; if such a sibling exists the plain file is IGNORED (not exposed, not loaded), to force the explicit -sfw/-nsfw split. Only <base>-sfw counts as an SFW source — a stray <base> next to <base>-nsfw does not.

Source:

• src/listManifest.js, line 380

Parameters:

Returns:

Type

Array.<string>

makeAnimations()

Description:

• Make animations.

Source:

• src/web/frontend/single.js, line 543

makeArt()

Description:

• Make art.

Source:

• src/web/frontend/feed.js, line 250

makeArt()

Description:

• Make art.

Source:

• src/web/frontend/results.js, line 61

makeDynamicPromptStage(loader) → {function}

Description:

• Build the #name dynamic-prompt stage bound to a loader (loader-injected port; suffix-resolved v2 / frozen v1, auto-fx/artists, danbooru substitution).

Source:

• src/core/stages/dynamicPrompt.js, line 26

Parameters:

Returns:

Type

function

makeExpansionStage(loader) → {function}

Description:

• Build the <name> expansion stage bound to a loader (loader-injected port, LoRA-safe).

Source:

• src/core/stages/expansion.js, line 22

Parameters:

Returns:

Type

function

makeListStage(store) → {function}

Description:

• Build the {name} list stage bound to a list store (loader-injected port).

Source:

• src/core/stages/list.js, line 20

Parameters:

Returns:

Type

function

makeVariations()

Description:

• Make variations.

Source:

• src/web/frontend/single.js, line 519

module:web-app/components/Gallery(props) → {JSX.Element|null}

Source:

• tmp/webapp-docs/src/components/Gallery.js, line 14

Parameters:

Returns:

Type

JSX.Element | null

module:web-app/components/Home(props) → {JSX.Element}

Description:

• The compose workspace.

Source:

• tmp/webapp-docs/src/components/Home.js, line 114

Parameters:

Returns:

Type

JSX.Element

module:web-app/components/Settings(props) → {JSX.Element}

Description:

• The full settings form.

Source:

• tmp/webapp-docs/src/components/Settings.js, line 36

Parameters:

Returns:

Type

JSX.Element

module:web-app/components/WrapperFab(props) → {JSX.Element}

Source:

• tmp/webapp-docs/src/components/WrapperFab.js, line 52

Parameters:

Returns:

Type

JSX.Element

nameToData(settings, name, skipAliasCheckopt) → {Object}

Description:

• Resolve a list name (handling the keyword/artist aliases) to its in-memory array.

Source:

• src/helpers/listFiles.js, line 178

Parameters:

Returns:

Type

Object

nlpProcess(word) → {string}

Description:

• Reduce a word to its noun-singular or verb-infinitive form via compromise. (Currently unused — kept for reference; too slow to run per keyword.)

Source:

• src/web/backend/indexImages.js, line 46

Parameters:

Returns:

Type

string

normalize(line) → {string}

Description:

• Normalize a raw list line to a lowercase, single-spaced token string.

Source:

• src/contentSafety.js, line 319

Parameters:

Returns:

Type

string

onMinusStepperClick(input)

Description:

• On minus stepper click.

Source:

• src/web/frontend/generate.js, line 596

Parameters:

onMinusStepperClick(input)

Description:

• On minus stepper click.

Source:

• src/web/frontend/settings.js, line 290

Parameters:

onNumberChangeWStep()

Description:

• On number change wstep.

Source:

• src/web/frontend/generate.js, line 635

onNumberChangeWStep()

Description:

• On number change wstep.

Source:

• src/web/frontend/settings.js, line 329

onPageButtonClick()

Description:

• On page button click.

Source:

• src/web/frontend/settings.js, line 276

onPlusStepperClick(input)

Description:

• On plus stepper click.

Source:

• src/web/frontend/generate.js, line 610

Parameters:

onPlusStepperClick(input)

Description:

• On plus stepper click.

Source:

• src/web/frontend/settings.js, line 304

Parameters:

onPromptSelectionChange()

Description:

• On prompt selection change.

Source:

• src/web/frontend/single.js, line 14

onReindexButton()

Description:

• On reindex button.

Source:

• src/web/frontend/main.js, line 57

onReroll()

Description:

• On reroll.

Source:

• src/web/frontend/single.js, line 637

onRerollSelect()

Description:

• On reroll select.

Source:

• src/web/frontend/single.js, line 644

onSettingsDownload()

Description:

• On settings download.

Source:

• src/web/frontend/settings.js, line 224

onVariationSelectionChange()

Description:

• On variation selection change.

Source:

• src/web/frontend/single.js, line 76

parseFrontMatter(source) → {Object}

Description:

• Split a leading --- YAML-ish front-matter block from the body.

Source:

• src/core/dpl/dpl.js, line 38

Parameters:

Returns:

Type

Object

parseNode(node) → {object}

Description:

• Parse one tree node's text into a typed descriptor (weight/gate/repeat/choice/ref/payload).

Source:

• src/core/dpl/dpl.js, line 157

Parameters:

Returns:

Type

object

parseSections(lines) → {object}

Description:

• Parse the lexed lines into { sectionName: nodeTree }. A heading is a text line whose next line is ={3,}; Start is the entry section. Lines under a heading nest by depth.

Source:

• src/core/dpl/dpl.js, line 92

Parameters:

Returns:

Type

object

performRandomGenerate()

Description:

• Perform random generate.

Source:

• src/web/frontend/generate.js, line 824

performRandomSearch()

Description:

• Perform random search.

Source:

• src/web/frontend/feed.js, line 199

performSearch()

Description:

• Perform search.

Source:

• src/web/frontend/feed.js, line 158

pickerListNames() → {Array.<string>}

Description:

• The list names to show in the web picker, honoring adult mode. When adult is off, every name carrying an nsfw token is hidden (the app behaves as if it doesn't exist). When on, each base that has a <base>-nsfw sibling also offers the explicit <base>-sfw reference, so the picker shows all three (default / SFW-only / NSFW).

Source:

• src/promptFilesAndSuggestions.js, line 192

Returns:

Type

Array.<string>

populateSettingsList()

Description:

• Populate settings list.

Source:

• src/web/frontend/generate.js, line 312

postBuildIndexes() → {void}

Description:

• Final pass: compute each animation's highest frame number from its frames.

Source:

• src/web/backend/indexImages.js, line 589

Returns:

Type

void

presetSelected()

Description:

• Preset selected.

Source:

• src/web/frontend/generate.js, line 290

(async) processBatch(index, total) → {Promise.<void>}

Description:

• Build one prompt through the prompt-module pipeline and, when generateImages is on and mode is StableDiffusion, generate its image(s).

Source:

• src/common.js, line 66

Parameters:

Returns:

Type

Promise.<void>

processGroup(settings, defSettings, groupName, diff) → {void}

Description:

• Copy the keys of one settings group that differ from the defaults into diff.

Source:

• src/diffSettings.js, line 16

Parameters:

Returns:

Type

void

processImageFeed(files)

Description:

• Process image feed.

Source:

• src/web/frontend/feed.js, line 69

Parameters:

processMdj(settings, lessEmphasis, keyword) → {string}

Description:

• Midjourney emphasis: append ::factor, factor = 1.05·N up (or its reciprocal down); N is rolled by emphasisLevelChance up to emphasisMaxLevels.

Source:

• src/helpers/randomEmphasis.js, line 92

Parameters:

Returns:

Type

string

processNAI(settings, lessEmphasis, keyword) → {string}

Description:

• NovelAI emphasis: same nested-bracket leveling as SD (the list stage later rewrites () to {} for NovelAI).

Source:

• src/helpers/randomEmphasis.js, line 62

Parameters:

Returns:

Type

string

processRepeat(count, keyword, alias) → {string}

Description:

• Build a comma-joined run of count list tokens.

Source:

• src/helpers/keywordRepeater.js, line 37

Parameters:

Returns:

Type

string

processSd(settings, lessEmphasis, keyword) → {string}

Description:

• StableDiffusion emphasis: wrap the keyword in N nested () (emphasis) or [] (de-emphasis); N is rolled by emphasisLevelChance up to emphasisMaxLevels.

Source:

• src/helpers/randomEmphasis.js, line 32

Parameters:

Returns:

Type

string

promptSuggestion(fullopt) → {string}

Description:

• Build a random prompt suggestion (the engine behind #random): one to three full dynamic prompts, sometimes AND-weighted, with optional garnish, then cleaned up.

Source:

• src/promptFilesAndSuggestions.js, line 261

Parameters:

Returns:

Type

string

pull(settings, name) → {string}

Description:

• Pull a random entry from a list, with once-only depletion and auto-reload when the list empties. Artist lists return "" when includeArtist is off.

Source:

• src/helpers/listFiles.js, line 221

Parameters:

Returns:

Type

string

query(keywords) → {Array.<object>}

Description:

• Search the index for images matching all query keywords (set intersection).

Source:

• src/web/backend/indexImages.js, line 361

Parameters:

Returns:

Type

Array.<object>

randomName()

Description:

• Random name.

Source:

• src/web/frontend/single.js, line 421

reIndexToUrl(url)

Description:

• Re index to url.

Source:

• src/web/frontend/main.js, line 93

Parameters:

readListFile(settings, name) → {void}

Description:

• Load a list file fully into memory (under the artist or keyword bucket).

Source:

• src/helpers/listFiles.js, line 110

Parameters:

Returns:

Type

void

readSfwBase(base, readers) → {Array.<string>|null}

Description:

• Read a plain list's SFW base lines. Safety rule: when a <base>-nsfw sibling exists, a plain <base>.txt is IGNORED — the SFW source must be the explicit <base>-sfw.txt. This enforces the naming split so a stray <base>.txt can never leak as SFW alongside NSFW (a lone <base>.txt beside <base>-nsfw.txt is thus treated as NSFW-only). With no <base>-nsfw sibling, a plain <base>.txt is a normal SFW list (with <base>-sfw.txt as a fallback). Returns null when no SFW source exists, else an array (possibly empty).

Source:

• src/listManifest.js, line 123

Parameters:

Returns:

Type

Array.<string> | null

rebuildIndexes(settings) → {void}

Description:

• Rebuild the whole index from output/*.json: build, validate, post-process, and re-index (up to 5×) while self-healing keeps changing the data.

Source:

• src/web/backend/indexImages.js, line 637

Parameters:

Returns:

Type

void

reindexHome()

Description:

• Reindex home.

Source:

• src/web/frontend/main.js, line 74

reindexProgress()

Description:

• Reindex progress.

Source:

• src/web/frontend/re-index.js, line 28

reloadListFiles(settings) → {void}

Description:

• Lazily clear every list (forces a fresh draw set on the next prompt).

Source:

• src/helpers/listFiles.js, line 158

Parameters:

Returns:

Type

void

reloadPromptFunc(list) → {void}

Description:

• Refill the per-pull pool of randomizers so each gets a turn before any repeats.

Source:

• src/prompt-modules/list.js, line 46

Parameters:

Returns:

Type

void

reloadSettings() → {void}

Description:

• (Re)build the live settings object: clone the defaults, merge user-settings.json, and migrate a legacy user-settings.js if present.

Source:

• src/loadSettings.js, line 50

Returns:

Type

void

removeDeepLink(settings, fileName, oneToOneName) → {void}

Description:

• Strip a now-invalid relationship field from a sidecar on disk (minimal rewrite) and flag that a re-index is needed.

Source:

• src/web/backend/indexImages.js, line 420

Parameters:

Returns:

Type

void

removeSettingOnClick()

Description:

• Remove setting on click.

Source:

• src/web/frontend/generate.js, line 524

renderInlineBody()

Description:

• Render the payload text of a node, substituting inline {js:path} via the bridge.

Source:

• src/core/dpl/dpl.js, line 355

renderNode(node, ctx) → {string}

Description:

• Render a single parsed node to a string (without its sibling gate, which the caller applied).

Source:

• src/core/dpl/dpl.js, line 310

Parameters:

Returns:

Type

string

renderNodes(nodes, ctx) → {string}

Description:

• Render an array of sibling nodes into one layer string (gates, choices, repeats, refs, weighted local sort). auto tracks the running auto-weight (starts at 1000).

Source:

• src/core/dpl/dpl.js, line 274

Parameters:

Returns:

Type

string

renderRef()

Description:

• Resolve a reference node (call/insert/js-block) to a string.

Source:

• src/core/dpl/dpl.js, line 368

requireLoader() → {object}

Source:

• src/promptFilesAndSuggestions.js, line 65

Throws:

If configure() has not been called.

Type

Error

Returns:

Type

object

rerollPrompt(isSelect)

Description:

• Reroll prompt.

Source:

• src/web/frontend/single.js, line 439

Parameters:

resetSavePreset()

Description:

• Reset save preset.

Source:

• src/web/frontend/generate.js, line 399

resolveListLines(name, readers, includeAdultopt, forcedopt, depthopt, seenopt) → {Array.<string>|null}

Description:

• Resolve a list/group reference to its lines, honoring the SFW/NSFW naming model and the includeAdult mode. No runtime content filtering — NSFW is a separate preprocessed <base>-nsfw.txt file that is simply included or not.

  Semantics (per reference):

  • {name} → SFW only when adult is off; SFW + <name>-nsfw when on.
  • {name-sfw} → SFW base only (always; the explicit SFW-exclusive reference).
  • {name-nsfw} → nothing when adult is off (acts as if it doesn't exist); SFW + <name>-nsfw when on (the SFW base is auto-tacked on).

  Groups propagate the resolved variant to their members, so {d} (off) is all-SFW, {d} (on) includes NSFW, and {d-sfw} is SFW even when on.

Source:

• src/listManifest.js, line 205

Parameters:

Returns:

Type

Array.<string> | null

resolveName(ref, names) → {string}

Description:

• Resolve a list reference to a canonical list name by PATH-SUFFIX matching, so a prompt can use a bare filename (general), a partial path (danbooru/general), or a full path — and folders can be nested arbitrarily deep. An exact match wins; otherwise any name whose path ends with /<ref> matches, and the shallowest (fewest folders), then alphabetically-first, match is chosen for determinism.

Source:

• src/listManifest.js, line 415

Parameters:

Returns:

Type

string

resultsLoaded(results)

Description:

• Results loaded.

Source:

• src/web/frontend/results.js, line 10

Parameters:

returnValToSetting()

Description:

• Return val to setting.

Source:

• src/web/frontend/generate.js, line 59

returnValToSetting()

Description:

• Return val to setting.

Source:

• src/web/frontend/settings.js, line 95

(async) run() → {Promise.<void>}

Description:

• Run the full generate loop: clear results, then build promptCount prompts (reloading lists between prompts as configured), awaiting each batch in turn.

Source:

• src/common.js, line 166

Returns:

Type

Promise.<void>

sampleFile(name, settings, emphasisopt) → {string}

Description:

• Pull one random entry from list name, optionally applying a single randomizer (emphasis / editing / alternating, chosen without replacement) and resolving any nested {list} tokens the randomizer leaves behind.

Source:

• src/prompt-modules/list.js, line 60

Parameters:

Returns:

Type

string

saveExpansion()

Description:

• Save expansion.

Source:

• src/web/frontend/generate.js, line 795

savePreset()

Description:

• Save preset.

Source:

• src/web/frontend/generate.js, line 414

saveSetting(path, value)

Description:

• Save setting.

Source:

• src/web/frontend/generate.js, line 17

Parameters:

saveSetting(path, value)

Description:

• Save setting.

Source:

• src/web/frontend/settings.js, line 87

Parameters:

saveSettings() → {void}

Description:

• Persist userSettings() to user-settings.json.

Source:

• src/loadSettings.js, line 138

Returns:

Type

void

saveState()

Description:

• Save state.

Source:

• src/web/frontend/generate.js, line 753

searchboxKeyPress(event)

Description:

• Searchbox key press.

Source:

• src/web/frontend/feed.js, line 171

Parameters:

selectAnimation()

Description:

• Select animation.

Source:

• src/web/frontend/single.js, line 585

selectUpscale()

Description:

• Select upscale.

Source:

• src/web/frontend/single.js, line 623

selectVariations()

Description:

• Select variations.

Source:

• src/web/frontend/single.js, line 571

sendLegacyTxtNotice() → {void}

Description:

• Print the legacy-txt conversion notice once per process.

Source:

• src/common.js, line 194

Returns:

Type

void

setValToSetting()

Description:

• Set val to setting.

Source:

• src/web/frontend/settings.js, line 190

setupNumberSteppers()

Description:

• Setup number steppers.

Source:

• src/web/frontend/generate.js, line 621

setupNumberSteppers()

Description:

• Setup number steppers.

Source:

• src/web/frontend/settings.js, line 315

showSettingOnSelect()

Description:

• Show setting on select.

Source:

• src/web/frontend/generate.js, line 488

startCase(text) → {*}

Description:

• Start case.

Source:

• src/web/frontend/generate.js, line 32

Parameters:

Returns:

Type

*

startCase(text) → {*}

Description:

• Start case.

Source:

• src/web/frontend/settings.js, line 21

Parameters:

Returns:

Type

*

startProgress() → {void}

Description:

• Create the four cli-progress bars (sampler / batch / total / prompts), seed the imageSettings.progress* fields, and begin polling.

Source:

• src/genImg.js, line 115

Returns:

Type

void

stopProgress() → {void}

Description:

• Tear down the progress bars and clear the imageSettings.progress* fields.

Source:

• src/genImg.js, line 186

Returns:

Type

void

swapOut(settings, keyword) → {string}

Description:

• Prompt-editing "swap": [kw:kw:n] — re-assert the keyword at step n.

Source:

• src/helpers/randomEditing.js, line 40

Parameters:

Returns:

Type

string

toComparitiveKeywords(prompt) → {Array.<string>}

Description:

• Tokenize a search query into comparison keywords (word-boundary only, so girl and 1girl both match), de-duplicated.

Source:

• src/web/backend/indexImages.js, line 121

Parameters:

Returns:

Type

Array.<string>

toKeywords(prompt) → {Array.<string>}

Description:

• Tokenize a prompt into the de-duplicated, sorted keyword list used for the index (splits on word and letter boundaries; drops 1-char and pure-digit tokens).

Source:

• src/web/backend/indexImages.js, line 66

Parameters:

Returns:

Type

Array.<string>

toggleDetailedProgress()

Description:

• Toggle detailed progress.

Source:

• src/web/frontend/progress.js, line 132

updateFiles(directoryName) → {void}

Description:

• Recursively copy legacy .txt output sidecars to .json and remove the .txt.

Source:

• src/common.js, line 207

Parameters:

Returns:

Type

void

(async) updateProgress() → {Promise.<void>}

Description:

• Poll the SD WebUI /progress endpoint and push the numbers into the cli-progress bars and imageSettings.progress*; reschedules itself while a render is ongoing.

Source:

• src/genImg.js, line 57

Returns:

Type

Promise.<void>

updateSearchSuggestion()

Description:

• Update search suggestion.

Source:

• src/web/frontend/feed.js, line 182

updateStats()

Description:

• Update stats.

Source:

• src/web/frontend/feed.js, line 224

(async) upscale(fileId) → {Promise.<void>}

Description:

• Upscale an already-generated image by file id.

Source:

• src/common.js, line 145

Parameters:

Returns:

Type

Promise.<void>

upscaleFile()

Description:

• Upscale file.

Source:

• src/web/frontend/single.js, line 599

userSettings() → {void}

Description:

• Create user-settings.json from default-user-settings.json if it is missing.

Source:

• src/createMissingUserSettings.js, line 28

Returns:

Type

void

userSettings() → {object}

Description:

• Compute the settings that differ from defaults, with internal-only / runtime fields (progress, lastCmd, animation bookkeeping, …) stripped.

Source:

• src/loadSettings.js, line 96

Returns:

Type

object

validateDeepLink(settings, fileName, oneToOneName) → {void}

Description:

• Drop a deep link (and its on-disk field) when its target no longer exists.

Source:

• src/web/backend/indexImages.js, line 444

Parameters:

Returns:

Type

void

validateIndexes(settings) → {void}

Description:

• Validate every indexed file: drop placeholders with no image, promote orphaned upscales, and prune dead deep links.

Source:

• src/web/backend/indexImages.js, line 545

Parameters:

Returns:

Type

void

validateUpscaleDeepLink(settings, fileName) → {void}

Description:

• Orphan an upscale whose parent vanished: rename <id>-upscaled → <id> and strip its upscaleOf so it becomes a standalone index entry.

Source:

• src/web/backend/indexImages.js, line 468

Parameters:

Returns:

Type

void

weightOf()

Description:

• A node's explicit weight, or null (used for refs that carry a weight).

Source:

• src/core/dpl/dpl.js, line 380

weightedSampleN()

Description:

• Pick n distinct options weighted by each option's leading gate %, else uniform.

Source:

• src/core/dpl/dpl.js, line 385