@fictjs/router 0.3.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -444,9 +444,6 @@ interface RouteJSXProps {
444
444
  * This is a configuration component, it doesn't render anything directly.
445
445
  */
446
446
  declare function Route(_props: RouteJSXProps): FictNode;
447
- /**
448
- * Outlet component - renders the child route
449
- */
450
447
  declare function Outlet(): FictNode;
451
448
  interface NavigateComponentProps {
452
449
  to: To;
@@ -631,9 +628,16 @@ declare function Form(props: FormProps): FictNode;
631
628
  /**
632
629
  * Use the router context
633
630
  */
631
+ /**
632
+ * Use the router context
633
+ *
634
+ * @fictReturn { location: 'signal', params: 'signal', matches: 'signal', isRouting: 'signal', pendingLocation: 'signal' }
635
+ */
634
636
  declare function useRouter(): RouterContextValue;
635
637
  /**
636
638
  * Use the route context
639
+ *
640
+ * @fictReturn { match: 'signal', data: 'signal', outlet: 'signal', error: 'signal' }
637
641
  */
638
642
  declare function useRoute(): RouteContextValue;
639
643
  /**
@@ -650,6 +654,8 @@ declare function useLocation(): () => Location;
650
654
  declare function useParams<P extends string = string>(): () => Params<P>;
651
655
  /**
652
656
  * Get the current search parameters
657
+ *
658
+ * @fictReturn [0: 'signal']
653
659
  */
654
660
  declare function useSearchParams(): [
655
661
  () => URLSearchParams,
package/dist/index.d.ts CHANGED
@@ -444,9 +444,6 @@ interface RouteJSXProps {
444
444
  * This is a configuration component, it doesn't render anything directly.
445
445
  */
446
446
  declare function Route(_props: RouteJSXProps): FictNode;
447
- /**
448
- * Outlet component - renders the child route
449
- */
450
447
  declare function Outlet(): FictNode;
451
448
  interface NavigateComponentProps {
452
449
  to: To;
@@ -631,9 +628,16 @@ declare function Form(props: FormProps): FictNode;
631
628
  /**
632
629
  * Use the router context
633
630
  */
631
+ /**
632
+ * Use the router context
633
+ *
634
+ * @fictReturn { location: 'signal', params: 'signal', matches: 'signal', isRouting: 'signal', pendingLocation: 'signal' }
635
+ */
634
636
  declare function useRouter(): RouterContextValue;
635
637
  /**
636
638
  * Use the route context
639
+ *
640
+ * @fictReturn { match: 'signal', data: 'signal', outlet: 'signal', error: 'signal' }
637
641
  */
638
642
  declare function useRoute(): RouteContextValue;
639
643
  /**
@@ -650,6 +654,8 @@ declare function useLocation(): () => Location;
650
654
  declare function useParams<P extends string = string>(): () => Params<P>;
651
655
  /**
652
656
  * Get the current search parameters
657
+ *
658
+ * @fictReturn [0: 'signal']
653
659
  */
654
660
  declare function useSearchParams(): [
655
661
  () => URLSearchParams,