Fix typings: router.resolve() and context.next() always return a promise now (#187)

Author: frenzzy

CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [Unreleased][unreleased]
+
+- Fix typings: `router.resolve()` and `context.next()` always return a promise now
+  ([#187](https://github.com/kriasoft/universal-router/pull/187))
+
 ## [9.0.0] - 2020-02-27
 
 - Update [path-to-regexp](https://github.com/pillarjs/path-to-regexp) from v3 to v6, see

dist/universal-router-sync.js.map

@@ -17,13 +17,6 @@ import {
   RegexpToFunctionOptions,
 } from 'path-to-regexp'
 
-/**
- * Params is a key/value object that represents extracted URL parameters.
- */
-export interface RouteParams {
-  [paramName: string]: string | string[]
-}
-
 /**
  * In addition to a URL path string, any arbitrary data can be passed to
  * the `router.resolve()` method, that becomes available inside action functions.
@@ -39,6 +32,15 @@ export interface ResolveContext extends RouterContext {
   pathname: string
 }
 
+/**
+ * Params is a key/value object that represents extracted URL parameters.
+ */
+export interface RouteParams {
+  [paramName: string]: string | string[]
+}
+
+export type RouteResult<T> = T | null | undefined | Promise<T | null | undefined>
+
 export interface RouteContext<R = any, C extends RouterContext = RouterContext>
   extends ResolveContext {
   /**
@@ -67,8 +69,6 @@ export interface RouteContext<R = any, C extends RouterContext = RouterContext>
   next: (resume?: boolean) => Promise<R>
 }
 
-export type RouteResult<T> = T | Promise<T | null | undefined> | null | undefined
-
 /**
  * A Route is a singular route in your application. It contains a path, an
  * action function, and optional children which are an array of Route.
@@ -267,7 +267,7 @@ class UniversalRouter<R = any, C extends RouterContext = RouterContext> {
    * the first route that matches provided URL path string and whose action function
    * returns anything other than `null` or `undefined`.
    */
-  resolve(pathnameOrContext: string | ResolveContext): RouteResult<R> {
+  resolve(pathnameOrContext: string | ResolveContext): Promise<RouteResult<R>> {
     const context: ResolveContext = {
       router: this,
       ...this.options.context,
@@ -290,7 +290,7 @@ class UniversalRouter<R = any, C extends RouterContext = RouterContext> {
       resume: boolean,
       parent: Route<R, C> | false = !matches.done && matches.value.route,
       prevResult?: RouteResult<R>,
-    ): RouteResult<R> {
+    ): Promise<RouteResult<R>> {
       const routeToSkip = prevResult === null && !matches.done && matches.value.route
       matches = nextMatches || matchResult.next(routeToSkip)
       nextMatches = null

dist/universal-router-sync.min.js.map

@@ -17,13 +17,6 @@ import {
   RegexpToFunctionOptions,
 } from 'path-to-regexp'
 
-/**
- * Params is a key/value object that represents extracted URL parameters.
- */
-export interface RouteParams {
-  [paramName: string]: string | string[]
-}
-
 /**
  * In addition to a URL path string, any arbitrary data can be passed to
  * the `router.resolve()` method, that becomes available inside action functions.
@@ -39,6 +32,15 @@ export interface ResolveContext extends RouterContext {
   pathname: string
 }
 
+/**
+ * Params is a key/value object that represents extracted URL parameters.
+ */
+export interface RouteParams {
+  [paramName: string]: string | string[]
+}
+
+export type RouteResultSync<T> = T | null | undefined
+
 export interface RouteContext<R = any, C extends RouterContext = RouterContext>
   extends ResolveContext {
   /**
@@ -64,11 +66,9 @@ export interface RouteContext<R = any, C extends RouterContext = RouterContext>
   /**
    * Middleware style function which can continue resolving.
    */
-  next: (resume?: boolean) => R
+  next: (resume?: boolean) => RouteResultSync<R>
 }
 
-export type RouteResultSync<T> = T | null | undefined
-
 /**
  * A Route is a singular route in your application. It contains a path, an
  * action function, and optional children which are an array of Route.