@types/next - npm Package Compare versions

Comparing version 6.1.2 to 6.1.3

next/app.d.ts

 import * as React from "react";
 import { NextContext } from ".";
-import { RouterProps } from "./router";
+import { RouterProps, DefaultQuery } from "./router";
 
-export interface AppComponentProps {
+export interface AppComponentProps<Q = DefaultQuery> {
     Component: React.ComponentType<any>;
-    router: RouterProps;
+    router: RouterProps<Q>;
     pageProps: any;
 }
 
-export interface AppComponentContext {
+export interface AppComponentContext<Q = DefaultQuery> {
     Component: React.ComponentType<any>;
-    router: RouterProps;
-    ctx: NextContext;
+    router: RouterProps<Q>;
+    ctx: NextContext<Q>;
 }
 
-export class Container extends React.Component {}
+export class Container extends React.Component { }
 
-export default class App<TProps = {}> extends React.Component<TProps & AppComponentProps> {}
+export default class App<TProps = {}, Q = DefaultQuery> extends React.Component<TProps & AppComponentProps<Q>> { }

next/config.d.ts

 export default function(): {serverRuntimeConfig: any, publicRuntimeConfig: any};

next/document.d.ts

@@ -0,0 +0,0 @@ import * as React from "react";

next/dynamic.d.ts

@@ -0,0 +0,0 @@ import * as React from "react";

next/error.d.ts

 import * as React from "react";
 export default class extends React.Component<{ statusCode: number }> {}

next/head.d.ts

@@ -0,0 +0,0 @@ import * as React from "react";

next/index.d.ts

@@ -27,7 +27,7 @@ // Type definitions for next 6.1
      */
-    interface NextContext {
+    interface NextContext<Q = QueryStringMapObject> {
         /** path section of URL */
         pathname: string;
         /** query string section of URL parsed as an object */
-        query: QueryStringMapObject;
+        query: Q;
         /** String of the actual path (including the query) shows in the browser */
@@ -47,6 +47,6 @@ asPath: string;
 
-    type NextSFC<TProps = {}> = NextStatelessComponent<TProps>;
-    interface NextStatelessComponent<TProps = {}>
+    type NextSFC<TProps = {}, Q = QueryStringMapObject> = NextStatelessComponent<TProps, Q>;
+    interface NextStatelessComponent<TProps = {}, Q = QueryStringMapObject>
         extends React.StatelessComponent<TProps> {
-        getInitialProps?: (ctx: NextContext) => Promise<TProps>;
+        getInitialProps?: (ctx: NextContext<Q>) => Promise<TProps>;
     }
@@ -53,0 +53,0 @@

next/link.d.ts

@@ -0,0 +0,0 @@ import * as url from "url";

next/package.json

 {
     "name": "@types/next",
-    "version": "6.1.2",
+    "version": "6.1.3",
     "description": "TypeScript definitions for next",
@@ -45,8 +45,8 @@ "license": "MIT",
     "dependencies": {
+        "@types/react": "*",
         "@types/node-fetch": "*",
-        "@types/node": "*",
-        "@types/react": "*"
+        "@types/node": "*"
     },
-    "typesPublisherContentHash": "4b0492d32a8ba988b49b0e6a4e79ff5f8d0dfa89a63da1316cb7784f2188e12d",
+    "typesPublisherContentHash": "1109cbedf20ef5374fa2a64f3389cc2f48a669091a64bce41fae843eef5f312a",
     "typeScriptVersion": "2.8"
 }

next/README.md

@@ -11,4 +11,4 @@ # Installation
 Additional Details
- * Last updated: Sat, 04 Aug 2018 00:56:31 GMT
- * Dependencies: http, url, node-fetch, node, react
+ * Last updated: Fri, 24 Aug 2018 17:32:20 GMT
+ * Dependencies: react, url, http, node-fetch, node
  * Global values: none
@@ -15,0 +15,0 @@

next/router.d.ts

@@ -29,3 +29,13 @@ import * as React from "react";
 
-export interface RouterProps {
+export interface DefaultQuery {
+    [key: string]:
+    | boolean
+    | boolean[]
+    | number
+    | number[]
+    | string
+    | string[];
+}
+
+export interface RouterProps<Q = DefaultQuery> {
     // url property fields
@@ -35,11 +45,3 @@ readonly pathname: string;
     readonly asPath?: string;
-    readonly query?: {
-        [key: string]:
-            | boolean
-            | boolean[]
-            | number
-            | number[]
-            | string
-            | string[];
-    };
+    readonly query?: Q;
 
@@ -83,4 +85,4 @@ // property fields
 
-export interface SingletonRouter extends RouterProps {
-    router: RouterProps | null;
+export interface SingletonRouter<Q = DefaultQuery> extends RouterProps<Q> {
+    router: RouterProps<Q> | null;
     readyCallbacks: RouterCallback[];
@@ -90,8 +92,12 @@ ready(cb: RouterCallback): void;
 
-export interface WithRouterProps {
-    router: SingletonRouter;
+export interface WithRouterProps<Q = DefaultQuery> {
+    router: SingletonRouter<Q>;
 }
 
-export function withRouter<T extends {}>(
-    Component: React.ComponentType<T & WithRouterProps>,
+// Manually disabling the no-unnecessary-generics rule so users can
+// retain type inference if they warp their component in withRouter
+// without defining props explicitly
+export function withRouter<T extends {}, Q = DefaultQuery>(
+    // tslint:disable-next-line:no-unnecessary-generics
+    Component: React.ComponentType<T & WithRouterProps<Q>>,
 ): React.ComponentType<T>;
@@ -98,0 +104,0 @@

No alert changes

Improved metrics

Total package byte prevSize

15872

increased by5.68%

Lines of code

345

increased by1.47%

No dependency changes