NavigateBaseOptions

import type { NavigateBaseOptions } from "@shadow-js/router";

interface NavigateBaseOptions {
  /** Replace the current entry instead of pushing. */
  readonly replace?: boolean;
  /**
   * How a relative `to` (one that does not start with `/`) is resolved. `"path"`: against the
   * current pathname, as a directory (`edit` from `/posts/7` is `/posts/7/edit`). `"route"`: against
   * the pattern of the deepest route matched there, whose params are kept unless `params` overrides
   * them. Absolute targets are not changed. Default: the target is resolved as a URL against the
   * current location. Needs the `relative` feature (`relativeLinks()` from `@shadow-js/router/relative`).
   */
  readonly relative?: "path" | "route";
  /** Stored in `history.state` for the new entry. */
  readonly state?: unknown;
  /** Search to merge onto the target's own query, serialized with the codec. `undefined` removes a key. */
  readonly search?: SearchPatch;
  /** Hash to set, with or without `#`. */
  readonly hash?: string;
  /**
   * `false` commits this navigation without a view transition, even when the `transitions` feature is on. Default:
   * the navigation transitions. Ignored without that feature.
   */
  readonly viewTransition?: boolean | undefined;
}