API Reference

Configuration Types

These are the public configuration shapes exported from reactus/types.

These are the public configuration shapes exported from reactus/types.

DevelopConfig

Used by dev().

FieldTypeRequiredDefault from Server.configure()
basePathstringNo'/'
clientRoutestringNo'/client'
clientTemplatestringNobuilt-in client template
cssFilesstring[]Noundefined
cwdstringNoprocess.cwd()
documentTemplatestringNobuilt-in document template
fsFileSystemNoNodeFS
optimizeDepsDepOptimizationOptionsNoundefined
pluginsPluginOption[]No[]
viteInlineConfigNoundefined
watchIgnorestring[]No[]

BuildConfig

Used by build().

FieldTypeRequiredDefault from Server.configure()
assetPathstringNopath.join(cwd, '.reactus/assets')
basePathstringNo'/'
clientPathstringNopath.join(cwd, '.reactus/client')
clientTemplatestringNobuilt-in client template
cssFilesstring[]Noundefined
cwdstringNoprocess.cwd()
fsFileSystemNoNodeFS
optimizeDepsDepOptimizationOptionsNoundefined
pagePathstringNopath.join(cwd, '.reactus/page')
pageTemplatestringNobuilt-in page template
pluginsPluginOption[]No[]

ProductionConfig

Used by serve().

FieldTypeRequiredDefault from Server.configure()
clientRoutestringNo'/client'
cssRoutestringNo'/assets'
cwdstringNoprocess.cwd()
documentTemplatestringNobuilt-in document template
fsFileSystemNoNodeFS
pagePathstringNopath.join(cwd, '.reactus/page')
pluginsPluginOption[]No[]

ServerConfig

This is the full merged shape used by Server and the default engine() export.

It includes every field from development, build, and production, plus:

  • production: boolean

Notes

  • The wrapper functions accept Partial<...Config> and pass those values through Server.configure().
  • In practice, you can omit many fields and rely on defaults, but it is usually clearer to set cwd, clientRoute, and your output paths explicitly.