Class RoutePattern

packages/route-pattern/src/lib/route-pattern.ts:80–130

 * `source`, `toString()`, `toJSON()`, and {@link getRoutePatternCaptures} for inspection.
 */
export class RoutePattern<source extends string = string> {
  declare readonly [brand]: source

  /** Parsed parts of this pattern. Internal; not part of the public API. */
  readonly _parts: RoutePatternParts

  /**
   * Create a new `RoutePattern` from its parsed parts.
   *
   * The parts are not part of the public API. Use {@link RoutePattern.parse} to create a pattern
   * from a source string.
   *
   * @param parts The parsed parts of the pattern.
   */
  constructor(parts: RoutePatternParts) {
    this._parts = parts
  }

  /**
   * Create a new `RoutePattern` by parsing a source string.
   *
   * @param source The route pattern source string.
   * @returns The parsed route pattern.
   */
  static parse<source extends string>(source: source): RoutePattern<source> {
    return parsePattern(source)
  }

  /** Normalized string representation of this pattern. */
  get source(): string {
    return serializePattern(this._parts)
  }

  /**
   * Returns a string representing this route pattern.
   *
   * @returns The same normalized pattern string as `RoutePattern.source`.
   */
  toString(): string {
    return this.source
  }

  /**
   * Returns a JSON-serializable object containing each serialized part of this route pattern.
   *
   * @returns The serialized protocol, hostname, port, pathname, and search.
   */
  toJSON(): RoutePatternJSON {
    return serializePatternParts(this._parts)
  }
}

export function createRoutePattern<source extends string>(
  parts: RoutePatternParts,