jaxs 0.9.3 → 0.9.5

package/dist/jaxs.d.ts

@@ -6,7 +6,7 @@ import { Subscribe as Subscribe_2 } from '.'
 export declare class App {
   window: Window
   document: Document
-  publish: Publish<any>
+  publish: PublishExtended<any>
   subscribe: Subscribe
   bus: JaxsBus
   state: State
@@ -175,7 +175,7 @@ declare type CreateAppBuilderArguments = {
 
 declare const createBus: () => {
   bus: JaxsBus
-  publish: (event: string, payload: any) => void
+  publish: PublishExtended<any>
   subscribe: (
     matcher: BusEventMatcher,
     listener: BusListener<any>,
@@ -184,7 +184,7 @@ declare const createBus: () => {
 
 declare const createRouteState: (state: State) => void
 
-declare const createState: (publisher: Publish<any>) => State
+declare const createState: (publisher: PublishExtended<any>) => State
 
 declare type CustomPeriodicOptions = {
   timer: PeriodicTimerFunction
@@ -263,14 +263,6 @@ declare class FuzzySubscriptions {
   matches(event: string): FuzzySubscriptionData<any>[]
 }
 
-declare type GeneralPeriodicOptions = {
-  period: number
-  offset?: number
-}
-
-declare type GeneralPeriodicPublisherOptions<T> =
-  RequiredPeriodicPublisherOptions<T> & GeneralPeriodicOptions
-
 declare type InsertNodeData = {
   parent: JaxsElement
   index: number
@@ -396,13 +388,14 @@ export declare namespace JaxsTypes {
     StoreListSorterFunction,
     PeriodicPublisher,
     RequiredPeriodicPublisherOptions,
-    GeneralPeriodicOptions,
     CustomPeriodicOptions,
-    GeneralPeriodicPublisherOptions,
     CustomPeriodicPublisherOptions,
-    PublishPeriodicallyOptions,
     PeriodicTimerFunctionOptions,
     PeriodicTimerFunction,
+    WithTimeoutOptions,
+    PeriodicallyOptions,
+    PeriodicallyWithCustomTimerOptions,
+    PublishExtended,
     RouteState,
     RouteMatcher,
     RenderedRoute,
@@ -440,7 +433,7 @@ declare type ListenerKit<T> = {
   state: State_2
   document: Document
   window: Window
-  publish: Publish<any>
+  publish: PublishExtended<any>
   eventName: string
   payload: T
 }
@@ -467,13 +460,7 @@ export declare const ListStore: {
 declare const locationChangeEvent = 'navigation:location-change'
 
 export declare namespace messageBus {
-  export {
-    createBus,
-    JaxsBus,
-    ExactSubscriptions,
-    FuzzySubscriptions,
-    publishPeriodically,
-  }
+  export { createBus, JaxsBus, ExactSubscriptions, FuzzySubscriptions }
 }
 
 declare const navigate: ({
@@ -507,6 +494,17 @@ declare const onLinkClick: (listenerKit: ListenerKit<MouseEvent>) => void
 
 declare const onLocationChange: (listenerKit: ListenerKit<null>) => void
 
+declare type PeriodicallyOptions<T> = {
+  period: number
+  payload?: T
+  offset?: number
+}
+
+declare type PeriodicallyWithCustomTimerOptions<T> = {
+  timer: PeriodicTimerFunction
+  payload?: T
+}
+
 declare interface PeriodicPublisher<T> {
   event: string
   publish: Publish<T>
@@ -538,19 +536,25 @@ declare type PropValue =
   | ReactSourceObject
   | RenderableCollection
 
-export declare type Publish<T> = (event: string, payload: T) => void
-
-declare type PublishFromDom_2 = Publish<Event>
+export declare interface Publish<T> {
+  (event: string, payload: T): void
+}
 
-declare const publishLocation: (app: App) => void
+declare interface PublishExtended<T> extends Publish<T> {
+  withTimeout: <T>(event: string, options: WithTimeoutOptions<T>) => Unsubscribe
+  periodically: <T>(
+    event: string,
+    options: PeriodicallyOptions<T>,
+  ) => Unsubscribe
+  periodicallyWithCustomTimer: <T>(
+    event: string,
+    options: PeriodicallyWithCustomTimerOptions<T>,
+  ) => Unsubscribe
+}
 
-declare const publishPeriodically: <T>(
-  options: PublishPeriodicallyOptions<T>,
-) => () => void
+declare type PublishFromDom_2 = PublishExtended<Event>
 
-declare type PublishPeriodicallyOptions<T> =
-  | GeneralPeriodicPublisherOptions<T>
-  | CustomPeriodicPublisherOptions<T>
+declare const publishLocation: (app: App) => void
 
 declare type ReactSourceObject = {
   fileName: string
@@ -652,12 +656,12 @@ declare namespace start {
 declare const startNavigation: (app: App) => void
 
 export declare class State {
-  publisher: Publish<any>
+  publisher: PublishExtended<any>
   stores: StoresCollection
   eventNamePrefix: string
   notifications: Set<string>
   inTransaction: boolean
-  constructor(publisher: Publish<any>)
+  constructor(publisher: PublishExtended<any>)
   create<T>(name: string, initialState: T): Store<T>
   store<T>(name: string): Store<T>
   get<T>(name: string): T
@@ -805,4 +809,9 @@ declare type ViewModel<ATTRIBUTES, STORE_MAP> = (
   storeMap: STORE_MAP,
 ) => Partial<ATTRIBUTES>
 
+declare type WithTimeoutOptions<T> = {
+  timeout: number
+  payload?: T
+}
+
 export {}