arlac77 / svelte-websocket-store

svelte-websocket-store Svelte store with a websocket backend API Table of Contents • active • Parameters • Key • Properties • BaseRouter • Parameters • Properties • component • value • path • path • Parameters • replace • Parameters • push • Parameters • finalizePush • Parameters • continue • Parameters • abort • Parameters • subscribe • Parameters • updateActive • Parameters • addRoute • Parameters • routeFor • Parameters • pathFor • Parameters • BaseTransition • searchParams • searchParams • Parameters • nest • Parameters • continue • abort • Parameters • DetailRoute • Properties • master • first • last • previous • next • Entitlement • Parameters • Guard • enter • Parameters • leave • Parameters • redirectGuard • Parameters • sequenceGuard • Parameters • parallelGuard • Parameters • websocketStore • Parameters • login • Parameters • handleFailedResponse • Parameters • MasterRoute • Parameters • Properties • nullGuard • RootRoute • hasParams • path • propertyMapping • guard • SkeletonRoute • Parameters • Properties • enter • Parameters • leave • Parameters • isAcceptable • Parameters • propertiesFor • Parameters • commonAncestor • Parameters • valueFor • Parameters • value • propertyMapping • objectInstance • ValueStoreRoute • SessionData • Properties • msecsRequiredForRefresh • supportedTokenTypes • Session • Parameters • Properties • update • Parameters • refresh • authorizationHeader • isValid • invalidate • hasEntitlement • Parameters • subscribe • Parameters • decode • Parameters • Transition • Parameters • Properties • start • end • redirect • Parameters • abort • Parameters • findClosestAttribute • Parameters • dispatchNavigationEvent • Parameters • nameValueStore • Parameters • Properties • WaitingGuard • Parameters active • **See**: {Router.updateActive} Keeps the node active state in sync. Parameters • **Element**  • **Router**  Key Keys also act as svelte stores and can be subscribed. Type: Object Properties • **string**  • **any**  • **Set**  BaseRouter **Extends BaseTransition** key subscriptions: Parameters • **Array\ ** all managed routes • **string** url (optional, default ) Properties • **Set ** nodes having their active state updated • **Array\ **  • **Object** collected keys of all routes • **Object** value mapping from keys (from current route) • **Route** current • **Transition** ongoing nested transition • **string** url component Current component. Either from a nested transition or from the current route Returns **SvelteComponent**  value Value if the current route Returns **any**  path Returns **string** url path with fragment & query path Replace current route. Parameters • **string**  replace Replace current route without updating the state. Parameters • **string**  Returns **Object** former state push Leave current route and enter route for given path. The work is done by a Transition. Parameters • **string** where to go Returns **Transition** running transition finalizePush Called from a Transition to manifest the new destination. If path is undefined the Transition has been aborderd. Parameters • **string**  continue Continue a transition to its original destination. Shortcut for this.transition.continue(). If there is no transition ongoing and a fallbackPath is present, it will be entered. Otherwise does nothing. Parameters • **string**  abort Abort a transition. Shortcut for this.transition.abort() If there is no transition ongoing and a fallbackPath is present it will be entered. Otherwise does nothing. Parameters • **string**  subscribe Router subscription. Changes in the current route will trigger a update Parameters • **Function**  updateActive Update the active state of a node. A node is considered active if it shared the path prefix with the current route. Parameters • **Element**  addRoute Add a new Route. Parameters • **Route**  routeFor Find Route for a given value. Parameters • **any**  Returns **Route** able to support given value pathFor Find path for a given value. Parameters • **any**  • **string** to be appended Returns **string** path + suffix BaseTransition searchParams Deliver url search params form the current location. Returns **URLSearchParams** as extracted from the path searchParams Replaces the search part of the path with the given searchParams. Parameters • **(URLSearchParams | Object)**  nest Add another transition nesting level. Starts a transition from the given factory. Parameters • **string**  • **Transition**  continue Continue a nested route to its original destination. Does nothing if the transition has not been nested. abort Abort the transition. Parameters •   Returns **Promise ** truen in case there was a nesten transition DetailRoute **Extends ValueStoreRoute** Route to represent a slice of the masters list of values. Properties • **Route** route holding the master records master Route holding the list ov values Returns **Route** our master first Returns **Promise\ ** 1st. entry last Returns **any** last entry previous Returns **any** previous value next Returns **Promise\ ** next value Entitlement Parameters • **(string | Object)**  Guard Enforces conditions of routes Like the presents of values in the context enter Called while entering a route (current outlet is not yet set) Parameters • **Transition**  leave Called before leaving a route Parameters • **Transition**  redirectGuard Redirects to a given path if condition is met. Parameters • **string**  • **Function** redirects when returning true sequenceGuard Execute guards in a sequence. Parameters • **Iterable **  parallelGuard Execute guards in a parallel. Parameters • **Iterable **  websocketStore Create a writable store based on a web-socket. Data is transferred as JSON. Keeps socket open (reopens if closed) as…