Function matchUrlToService

matchUrlToService<
    const Service extends
        Readonly<
            {
                endpoints: Record<EndpointPathBase, any>;
                webSockets: Record<EndpointPathBase, any>;
            },
        >,
>(
    this: void,
    service: Service,
    url: string,
):
    | undefined
    | _RequireAtLeastOne<
        {
            endpointPath: keyof Service["endpoints"];
            webSocketPath: keyof Service["webSockets"];
        },
        "webSocketPath"
        | "endpointPath",
    >
Given a raw path or URL, finds an endpoint or WebSocket path that will match in the given service. If no match is found, this returns undefined.
Type Parameters
- const Service extends Readonly<
      {
          endpoints: Record<EndpointPathBase, any>;
          webSockets: Record<EndpointPathBase, any>;
      },
  >
Parameters
- this: void
- service: Service
- url: string
  The URL or path to match against.
Returns
    | undefined
    | _RequireAtLeastOne<
        {
            endpointPath: keyof Service["endpoints"];
            webSocketPath: keyof Service["webSockets"];
        },
        "webSocketPath"
        | "endpointPath",
    >
Package
@rest-vir/implement-service
- Defined in packages/define-service/src/service/match-url.ts:15