Class Router

Event emitter class this class allow you to emit and handle events

@example:


interface EvDoIt extends BasicEvent {
  param: unknown;
}

function EvDoIt( e: EvDoIt ) : EvDoIt {
  return BasicEvent<EvDoIt>( e );
}

interface TestEventMap extends EventMap {
    doit: EvDoIt;
}

let ee = new EventSource<TestEventMap>(null);
ee.listen({
    doit: (e) => {
        console.log(e);
        e.preventDefault(); 
    },
});

ee.defaults({
    doit: (e) => {
        console.log('default handler for ', e.type, e.selection);
    },
})

ee.on('doit', (e) => {
    debugger;
})

const ev = EvDoIt({ param: 10 });
ee.emit('change', ev);
if (ev.defaultPrevented) {
    console.log('prevented');
}

Hierarchy

EventSource<RouterEventMap>
- Router

Index

Constructors

constructor

new Router(): Router
Returns Router
Overrides EventSource.constructor
- Defined in src/router.ts:101

Properties

`Private` routes

routes: Route[]

Methods

_emit

_emit(eventName: string, e: BasicEvent): void
Parameters
- eventName: string
- e: BasicEvent
Returns void
Inherited from EventSource._emit
- Defined in src/x4events.ts:291

`Private` _find

_find(url: string): {
handlers: RouteHandler[];
params: any;
}
Parameters
- url: string
Returns {
handlers: RouteHandler[];
params: any;
}
- handlers: RouteHandler[]
- params: any
- Defined in src/router.ts:145

_off

_off(eventName: string, callback: EventCallback<BasicEvent>): void
Parameters
- eventName: string
- callback: EventCallback<BasicEvent>
Returns void
Inherited from EventSource._off
- Defined in src/x4events.ts:550

_on

_on(eventName: string, callback: EventCallback<BasicEvent>, capturing?: boolean): EventDisposer
Parameters
- eventName: string
- callback: EventCallback<BasicEvent>
- capturing: boolean = false
Returns EventDisposer
Inherited from EventSource._on
- Defined in src/x4events.ts:513

_once

_once(eventName: string, callback: EventCallback<BasicEvent>): Promise<unknown>
Parameters
- eventName: string
- callback: EventCallback<BasicEvent>
Returns Promise<unknown>
Inherited from EventSource._once
- Defined in src/x4events.ts:412

_signal

_signal(eventName: string, e: BasicEvent, delay?: number): void
Parameters
- eventName: string
- e: BasicEvent
- delay: number = -1
Returns void
Inherited from EventSource._signal
- Defined in src/x4events.ts:348

defaults

defaults(events: MapEvents<RouterEventMap>): void
define a set of default handlers in one call
Parameters
- events: MapEvents<RouterEventMap>
Returns void
Inherited from EventSource.defaults
- Defined in src/x4events.ts:495

emit

emit<K>(type: K, event?: RouterEventMap[K]): void
emit an event you can stop propagation of event or prevent default
Type Parameters
- K extends "error"
Parameters
- type: K
- Optional event: RouterEventMap[K]
  
  event data
Returns void
Inherited from EventSource.emit
- Defined in src/x4events.ts:287

get

get(uri: string | RegExp, handler: RouteHandler): void
Parameters
- uri: string | RegExp
- handler: RouteHandler
Returns void
- Defined in src/router.ts:116

init

init(): void
Returns void
- Defined in src/router.ts:121

listen

listen(events: MapEvents<RouterEventMap>): void
define a set of listeners in one call
Parameters
- events: MapEvents<RouterEventMap>
Returns void
Inherited from EventSource.listen
- Defined in src/x4events.ts:484

navigate

navigate(uri: string, notify?: boolean): void
Parameters
- uri: string
- notify: boolean = true
Returns void
- Defined in src/router.ts:125

off

off<K>(type: K, callback: ((ev: RouterEventMap[K]) => any)): void
stop listening to an event
Type Parameters
- K extends "error"
Parameters
- type: K
- callback: ((ev: RouterEventMap[K]) => any)
  
  callback to remove (must be the same as in on )
  - - (ev: RouterEventMap[K]): any
    - Parameters
      
      ev: RouterEventMap[K]
      
      Returns any
Returns void
Inherited from EventSource.off
- Defined in src/x4events.ts:545

on

on<K>(type: K, callback: ((ev: RouterEventMap[K]) => any)): EventDisposer
listen for an event
Type Parameters
- K extends "error"
Parameters
- type: K
- callback: ((ev: RouterEventMap[K]) => any)
  
  callback to call
  - - (ev: RouterEventMap[K]): any
    - Parameters
      
      ev: RouterEventMap[K]
      
      Returns any
Returns EventDisposer
Inherited from EventSource.on
- Defined in src/x4events.ts:508

once

once<K>(type: K, callback: ((ev: RouterEventMap[K]) => any)): void
handle an event one time

Returns
Promise if callback is null

take care with that because if the event is never fired and you await it, the system may overflow
Type Parameters
- K extends "error"
Parameters
- type: K
- callback: ((ev: RouterEventMap[K]) => any)
  
  callback to call when event is signaled
  - - (ev: RouterEventMap[K]): any
    - Parameters
      
      ev: RouterEventMap[K]
      
      Returns any
Returns void
Inherited from EventSource.once
- Defined in src/x4events.ts:407

removeAllListeners

removeAllListeners(eventName: string): void
remove all listeners for an event
Parameters
- eventName: string
  
  event name
Returns void
Inherited from EventSource.removeAllListeners
- Defined in src/x4events.ts:571

removeDefaultHandler

removeDefaultHandler(eventName: string, callback: EventCallback<BasicEvent>): void
remove the previous default handler installed for an event
Parameters
- eventName: string
  
  event name
- callback: EventCallback<BasicEvent>
  
  callback handler to remove (must be the same as in setDefaultHandler)
Returns void
Inherited from EventSource.removeDefaultHandler
- Defined in src/x4events.ts:464

setDefaultHandler

setDefaultHandler(eventName: string, callback: EventCallback<BasicEvent>): void
set the event default handler
Parameters
- eventName: string
  
  name of the event
- callback: EventCallback<BasicEvent>
  
  callback to call when the event is not handled (and preventDeault has not been called)
Returns void
Inherited from EventSource.setDefaultHandler
- Defined in src/x4events.ts:434

signal

signal<K>(type: K, event: RouterEventMap[K], delay?: number): void
signal en event signaled event are notification : no way to prevent default not stop propagation
Type Parameters
- K extends "error"
Parameters
- type: K
- event: RouterEventMap[K]
  
  event data
- delay: number = -1
Returns void
Inherited from EventSource.signal
- Defined in src/x4events.ts:344

Class Router

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Router

Properties

Private routes

Methods

_emit

Parameters

eventName: string

e: BasicEvent

Returns void

Private _find

Parameters

url: string

Returns { handlers: RouteHandler[]; params: any; }

handlers: RouteHandler[]

params: any

_off

Parameters

eventName: string

callback: EventCallback<BasicEvent>

Returns void

_on

Parameters

eventName: string

callback: EventCallback<BasicEvent>

capturing: boolean = false

Returns EventDisposer

_once

Parameters

eventName: string

callback: EventCallback<BasicEvent>

Returns Promise<unknown>

_signal

Parameters

eventName: string

e: BasicEvent

delay: number = -1

Returns void

defaults

Parameters

events: MapEvents<RouterEventMap>

Returns void

emit

Type Parameters

K extends "error"

Parameters

type: K

Optional event: RouterEventMap[K]

Returns void

get

Parameters

uri: string | RegExp

handler: RouteHandler

Returns void

init

Returns void

listen

Parameters

events: MapEvents<RouterEventMap>

Returns void

navigate

Parameters

uri: string

notify: boolean = true

Returns void

off

Type Parameters

K extends "error"

Parameters

type: K

callback: ((ev: RouterEventMap[K]) => any)

Parameters

ev: RouterEventMap[K]

`Private` routes

`Private` _find

Returns {
handlers: RouteHandler[];
params: any;
}

`Optional` event: RouterEventMap[K]