From a3a242ff0b04e506b2a5942ad3ba2814f5d6ecf5 Mon Sep 17 00:00:00 2001 From: Alexey Solovyov Date: Fri, 19 Mar 2021 03:38:11 +0500 Subject: [PATCH] v3.1.1 --- CHANGELOG.md | 5 +++++ docs-app/src/Pages/Index.svelte | 8 +++++++- package.json | 3 ++- src/EasyrouteProvider.svelte | 5 ++--- ssr/registerRouterSSR/index.d.ts | 2 +- types.d.ts | 34 ++++++++++++++++++++++++++++++++ 6 files changed, 51 insertions(+), 6 deletions(-) create mode 100644 types.d.ts diff --git a/CHANGELOG.md b/CHANGELOG.md index d5ed4c1..373e4e6 100644 --- a/CHANGELOG.md +++ b/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`; diff --git a/docs-app/src/Pages/Index.svelte b/docs-app/src/Pages/Index.svelte index 2a04e9b..e588424 100644 --- a/docs-app/src/Pages/Index.svelte +++ b/docs-app/src/Pages/Index.svelte @@ -44,6 +44,9 @@
  • Hash, history and silent modes
  • +
  • + Svelte + TypeScript support v3.1.1+ +
  • Why you should try it?

    @@ -103,6 +106,9 @@
  • Режими hash, history и "тихий"
  • +
  • + Поддержка Svelte + TypeScript v3.1.1+ +
  • Почему стоит попробовать?

    @@ -122,4 +128,4 @@ -{/if} \ No newline at end of file +{/if} diff --git a/package.json b/package.json index dbf2a19..3d17f9b 100644 --- a/package.json +++ b/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" diff --git a/src/EasyrouteProvider.svelte b/src/EasyrouteProvider.svelte index 08ac519..4ee45bd 100644 --- a/src/EasyrouteProvider.svelte +++ b/src/EasyrouteProvider.svelte @@ -1,9 +1,8 @@ - \ No newline at end of file + diff --git a/ssr/registerRouterSSR/index.d.ts b/ssr/registerRouterSSR/index.d.ts index 6b5a18c..c031d98 100644 --- a/ssr/registerRouterSSR/index.d.ts +++ b/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 diff --git a/types.d.ts b/types.d.ts new file mode 100644 index 0000000..eb9ae18 --- /dev/null +++ b/types.d.ts @@ -0,0 +1,34 @@ +/// + +import { SvelteComponentTyped } from 'svelte' +import Router from 'easyroute-core' + +export interface RouterOutletProps + extends svelte.JSX.HTMLAttributes { + /** + * @default null + */ + transition?: string | null + + /** + * @default false + */ + forceRemount?: boolean + + /** + * default "default" + */ + name?: string +} + +export interface RouterLinkProps + extends svelte.JSX.HTMLAttributes { + to: string +} + +export default Router +export class RouterOutlet extends SvelteComponentTyped {} +export class RouterLink extends SvelteComponentTyped {} +export class EasyrouteProvider extends SvelteComponentTyped<{ + router: Router +}> {}