Back to Qwik

Qwik City.Static.Api

packages/qwik-city/src/static/qwik-city.static.api.md

1.7.11.2 KB
Original Source

API Report File for "@builder.io/qwik-city"

Do not edit this file. It is a report generated by API Extractor.

ts
/// <reference types="node" />

import type { RenderOptions } from '@builder.io/qwik/server';

// @public
export function generate(opts: StaticGenerateOptions): Promise<StaticGenerateResult>;

// @public (undocumented)
export interface StaticGenerateOptions extends StaticGenerateRenderOptions {
  basePathname?: string;
  qwikCityPlanModulePath: string;
  renderModulePath: string;
  // (undocumented)
  rootDir?: string;
}

// @public (undocumented)
export interface StaticGenerateRenderOptions extends RenderOptions {
  emit404Pages?: boolean;
  emitData?: boolean;
  emitHtml?: boolean;
  exclude?: string[];
  include?: string[];
  log?: 'debug';
  maxTasksPerWorker?: number;
  maxWorkers?: number;
  origin: string;
  outDir: string;
  sitemapOutFile?: string | null;
}

// @public (undocumented)
export interface StaticGenerateResult {
  // (undocumented)
  duration: number;
  // (undocumented)
  errors: number;
  // (undocumented)
  rendered: number;
  // (undocumented)
  staticPaths: string[];
}

// (No @packageDocumentation comment for this package)