ServeOptions

tcmts.cli.sync.ServeOptions · #dzromuvh · type

export interface ServeOptions {
  host: string;
  port: number;
  token: string;
  allowRun: boolean;
  tls?: { cert: string; key: string };
  /** a directory GET requests are answered from (a docs site), beside the codebase's routes */
  site?: string;
  /**
   * a path of the site its pages moved under: a GET for a path it doesn't have, that it has under this (or an app in
   * `proxies` serves there), goes there
   */
  moved?: string;
  /** anyone can pull and read contributions, without a token (writing still takes one) */
  public?: boolean;
  /** whether to print the token (one made up for this run; not one the caller gave) */
  showToken?: boolean;
  /**
   * paths whose requests, to anyone, go to a server beside it (an app `tcm start --base` serves there): to whichever
   * of several answers (an app's version and its next, while one replaces the other)
   */
  proxies?: { path: string; to: string[] }[];
  /**
   * other codebases' web UIs, under paths of the server, to anyone: each the codebase in `dir`, read-only
   * ({@link webUi}'s `shown`)
   */
  forges?: { path: string; dir: string }[];
}

used by

• tcmts.cli.sync.serve