Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents the functions and Stores returned by router, used for programatically interacting with it

Hierarchy

  • IRouterReturn

Index

Properties

Properties

component

component: Readable<SvelteComponent | null>

Represents a Readable Store that outputs the current Component, if there is a matching route

NOTE: If the Store outputs undefined, you should treat that as a 404 error

goto

goto: goto

Represents a bound goto function, with its IGotoOptions.base_url / IGotoOptions.hash already set

href

href: Readable<string> | Writable<string>

Represents a Readable (Browser) / Writable (Server) Store that outputs the current full href string

page

page: object

Represents an object of Readable Stores relating to the current webpage details

Type declaration

  • host: Readable<string>

    Represents a Readable Store of the current hostname of a router instance, usually taken from [[IRouterOptions.url]] or Location.host

  • params: Readable<IRouterParameters>

    Represents a Readable Store of the current parsed URL parameters of a router instance

  • path: Readable<string>

    Represents a Readable Store of the current pathname of a router instance

  • query: Readable<IQueryParams>

    Represents a Readable Store of the current query string, parsed into a key-value mapping, from a router instance

url

url: Readable<URL>

Represents a Readable Store that outputs a URL instance of the current IRouterReturn.href value

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc