Variable: PlayRouterProvider

API / @xmachines/play-vue-router / index / PlayRouterProvider

const PlayRouterProvider: DefineComponent<
  ExtractPropTypes<{
    actor: {
      required: true;
      type: PropType<RoutableActor>;
    };
    basePath: {
      default: undefined;
      required: false;
      type: StringConstructor;
    };
    basePathParams: {
      default: undefined;
      required: false;
      type: PropType<Record<string, string | number>>;
    };
    compiledCache: {
      default: undefined;
      required: false;
      type: PropType<PatternCache<URLPatternLike>>;
    };
    patternCache: {
      default: undefined;
      required: false;
      type: PropType<PatternCache<ParsedPattern>>;
    };
    renderer: {
      required: true;
      type: PropType<(actor, router) => VNodeChild>;
    };
    routeMap: {
      required: true;
      type: PropType<RouteMap>;
    };
    router: {
      required: true;
      type: PropType<RouterClassic>;
    };
  }>,
  () => VNodeChild,
  {},
  {},
  {},
  ComponentOptionsMixin,
  ComponentOptionsMixin,
  {},
  string,
  PublicProps,
  ToResolvedProps<
    ExtractPropTypes<{
      actor: {
        required: true;
        type: PropType<RoutableActor>;
      };
      basePath: {
        default: undefined;
        required: false;
        type: StringConstructor;
      };
      basePathParams: {
        default: undefined;
        required: false;
        type: PropType<Record<string, string | number>>;
      };
      compiledCache: {
        default: undefined;
        required: false;
        type: PropType<PatternCache<URLPatternLike>>;
      };
      patternCache: {
        default: undefined;
        required: false;
        type: PropType<PatternCache<ParsedPattern>>;
      };
      renderer: {
        required: true;
        type: PropType<(actor, router) => VNodeChild>;
      };
      routeMap: {
        required: true;
        type: PropType<RouteMap>;
      };
      router: {
        required: true;
        type: PropType<RouterClassic>;
      };
    }>,
    {}
  >,
  {
    basePath: string;
    basePathParams: Record<string, string | number>;
    compiledCache: PatternCache<URLPatternLike>;
    patternCache: PatternCache<ParsedPattern>;
  },
  {},
  {},
  {},
  string,
  ComponentProvideOptions,
  true,
  {},
  any
>;

Defined in: packages/play-vue-router/src/play-router-provider.ts:18

PlayRouterProvider — the Vue wrapper of VueRouterBridge.

Note: the defineComponent function of Vue accepts no generic type parameter. Therefore the renderer prop has the RoutableActor constraint. Give a concrete actor, and TypeScript checks its structure at the call site.