v3.1.1

CHANGELOG.md

@@ -1,3 +1,8 @@
+### v3.1.1
+* fix: removed circular dependency in EasyrouteProvider;
+* fix: correct type definitions for registerRouterSSR;
+* feat: added type definitions for usage with TypeScript.
+
 ### v3.1.0
 * **breaking**: easyroute-core updated to 1.4.0 - difference in hooks definitions ([changelog](https://github.com/easyroute-router/easyroute-core/blob/master/CHANGELOG.md#v140));
 * **beraking**: removed current route info access method via `export let currentRoute`;

docs-app/src/Pages/Index.svelte

@@ -44,6 +44,9 @@
         <li>
             Hash, history and silent modes
         </li>
+        <li>
+            Svelte + TypeScript support <code>v3.1.1+</code>
+        </li>
     </ul>
 
     <p>Why you should try it?</p>
@@ -103,6 +106,9 @@
             <li>
                 Режими hash, history и "тихий"
             </li>
+            <li>
+                Поддержка Svelte + TypeScript <code>v3.1.1+</code>
+            </li>
         </ul>
 
         <p>Почему стоит попробовать?</p>
@@ -122,4 +128,4 @@
         </ol>
     </article>
 
-{/if}
+{/if}

package.json

@@ -1,8 +1,9 @@
 {
   "name": "svelte-easyroute",
   "description": "Config-based router for Svelte in style of Vue Router with SSR support",
-  "version": "3.1.0",
+  "version": "3.1.1",
   "main": "./index.js",
+  "types": "./types.d.ts",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/lyohaplotinka/svelte-easyroute.git"

src/EasyrouteProvider.svelte

@@ -1,9 +1,8 @@
 <script>
-    import Router from '../index'
     import { setContext } from 'svelte'
     export let router = null
 
-    if (!router || !(router instanceof Router)) {
+    if (!router) {
         throw new Error('[Easyroute] no router instance passed into EasyrouteProvider')
     }
 
@@ -13,4 +12,4 @@
     })
 </script>
 
-<slot></slot>
+<slot></slot>

ssr/registerRouterSSR/index.d.ts

@@ -2,4 +2,4 @@ import Router from 'easyroute-core'
 
 declare function registerRouter(router: Router): void
 
-export { registerRouter }
+export default registerRouter

types.d.ts

@@ -0,0 +1,34 @@
+/// <reference types="svelte" />
+
+import { SvelteComponentTyped } from 'svelte'
+import Router from 'easyroute-core'
+
+export interface RouterOutletProps
+  extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap['div']> {
+  /**
+   * @default null
+   */
+  transition?: string | null
+
+  /**
+   * @default false
+   */
+  forceRemount?: boolean
+
+  /**
+   * default "default"
+   */
+  name?: string
+}
+
+export interface RouterLinkProps
+  extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap['a']> {
+  to: string
+}
+
+export default Router
+export class RouterOutlet extends SvelteComponentTyped<RouterOutletProps> {}
+export class RouterLink extends SvelteComponentTyped<RouterLinkProps> {}
+export class EasyrouteProvider extends SvelteComponentTyped<{
+  router: Router
+}> {}