Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor TypeScript typings to use ES style exports #1204

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 13 additions & 17 deletions types/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,21 +1,17 @@
import "./vue";
import * as R from "./router";

// `VueRouter` in `export = VueRouter` must be a namespace
// All available types are exported via this namespace
declare namespace VueRouter {
export type RouterMode = R.RouterMode;
export type RawLocation = R.RawLocation;
export type RedirectOption = R.RedirectOption;
export type RouterOptions = R.RouterOptions;
export type RouteConfig = R.RouteConfig;
export type RouteRecord = R.RouteRecord;
export type Location = R.Location;
export type Route = R.Route;
export type NavigationGuard = R.NavigationGuard;
}
import { VueRouter } from "./router";

// TS cannot merge imported class with namespace, declare a subclass to bypass
declare class VueRouter extends R.VueRouter {}
export default VueRouter

export = VueRouter;
export {
RouterMode,
RawLocation,
RedirectOption,
RouterOptions,
RouteConfig,
RouteRecord,
Location,
Route,
NavigationGuard
} from "./router";
2 changes: 1 addition & 1 deletion types/router.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Vue = require("vue");
import Vue from "vue";
import { ComponentOptions, PluginFunction } from "vue";

type Component = ComponentOptions<Vue> | typeof Vue;
Expand Down
4 changes: 2 additions & 2 deletions types/test/index.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import Vue = require("vue");
import Vue from "vue";
import { ComponentOptions } from "vue";

import VueRouter = require("../index");
import VueRouter from "../index";
import { Route, RouteRecord, RedirectOption } from "../index";

Vue.use(VueRouter);
Expand Down
4 changes: 2 additions & 2 deletions types/vue.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
* Augment the typings of Vue.js
*/

import Vue = require("vue");
import VueRouter = require("./index");
import Vue from "vue";
import VueRouter from "./index";
import { Route, RawLocation, NavigationGuard } from "./index";

declare module "vue/types/vue" {
Expand Down