SSR / foldkit-ssr/vite

SiteModule

interface · packages/ssr/src/vite.ts:168

interface SiteModule {
  readonly config:
    | ResumableConfig<any, any>
    | ((
        path: string,
      ) => ResumableConfig<any, any> | Promise<ResumableConfig<any, any>>)
  readonly plan: ResumePlan<any, any>
  readonly buildId?: string | undefined
  readonly origin: string
  readonly paths:
    | ReadonlyArray<SitePath>
    | (() => ReadonlyArray<SitePath> | Promise<ReadonlyArray<SitePath>>)
  readonly template?: ((built: string) => string) | undefined
  readonly head?: Head | undefined
  readonly flags?: ((path: string) => unknown) | undefined
  readonly files?: 'directory' | 'flat' | undefined
  readonly sitemap?: boolean | undefined
  readonly robots?: boolean | undefined
}

A site description as a module exports it, for the plugin to evaluate.

In the guides

Members

SiteModule.config

property · packages/ssr/src/vite.ts:169

readonly config:
  | ResumableConfig<any, any>
  | ((
      path: string,
    ) => ResumableConfig<any, any> | Promise<ResumableConfig<any, any>>)

SiteModule.plan

property · packages/ssr/src/vite.ts:172

readonly plan: ResumePlan<any, any>

SiteModule.buildId

property · packages/ssr/src/vite.ts:173

readonly buildId?: string | undefined

SiteModule.origin

property · packages/ssr/src/vite.ts:174

readonly origin: string

SiteModule.paths

property · packages/ssr/src/vite.ts:175

readonly paths:
  | ReadonlyArray<SitePath>
  | (() => ReadonlyArray<SitePath> | Promise<ReadonlyArray<SitePath>>)

SiteModule.template

property · packages/ssr/src/vite.ts:177

readonly template?: ((built: string) => string) | undefined

property · packages/ssr/src/vite.ts:178

readonly head?: Head | undefined

SiteModule.flags

property · packages/ssr/src/vite.ts:179

readonly flags?: ((path: string) => unknown) | undefined

SiteModule.files

property · packages/ssr/src/vite.ts:180

readonly files?: 'directory' | 'flat' | undefined

SiteModule.sitemap

property · packages/ssr/src/vite.ts:181

readonly sitemap?: boolean | undefined

SiteModule.robots

property · packages/ssr/src/vite.ts:182

readonly robots?: boolean | undefined