Interface IEventHandler<TArgs, T, TResult>

Représente un gestionnaire d'événement typé auquel on peut attacher, retirer et déclencher des callbacks.

Inspiré du pattern event de C#, mais enrichi d'une valeur de retour sur les callbacks pour permettre des usages plus avancés.

Example

const onClick: IEventHandler<[MouseEvent]> = new EventHandler();

onClick.add('handler', (e) => console.log(e.clientX));
onClick.invoke(new MouseEvent('click'));

See

interface IEventHandler<
    TArgs extends any[] = any[],
    T extends Func<TArgs> = Func<TArgs>,
    TResult = EventCallResult<T>,
> {
    get keys(): string[];
    get onHandlerAdded(): IEventHandler<
        [key: string, callbackAdded: T],
        HandlerAddedCallback<TArgs, T>,
    >;
    get onHandlerCleared(): IEventHandler<
        [callbacksCleared: T[]],
        HandlerClearedCallback<TArgs, T>,
    >;
    get onHandlerRemoved(): IEventHandler<
        [key: string, callbackRemoved: MayBe<T>],
        HandlerRemovedCallback<TArgs, T>,
    >;
    add(key: string, event: T, ...args: Partial<TArgs>): this;
    clear(): this;
    count(): uint;
    getInvocationList(): T[];
    has(key: string): boolean;
    haveEvents(): boolean;
    invoke(...args: TArgs): TResult;
    push(event: T, ...args: Partial<TArgs>): string;
    remove(key: string): MayBe<T>;
}

Type Parameters

TArgs extends any[] = any[]
Tuple représentant les types des arguments transmis aux callbacks lors de l'appel. Par défaut any[].
T extends Func<TArgs> = Func<TArgs>
Type des callbacks attachés à l'événement, doit étendre Func<TArgs>. Par défaut Func<TArgs>.
TResult = EventCallResult<T>

Implemented by

AEventHandler

Index

Accessors

keys onHandlerAdded onHandlerCleared onHandlerRemoved

Methods

add clear count getInvocationList has haveEvents invoke push remove

Accessors

keys

get keys(): string[]
Retourne la liste des clés des callbacks actuellement enregistrés.

Returns string[]
Example
```
const keys = event.keys; // ['handler1', 'handler2']
```
- Defined in src/lib/interfaces/IEventHandler.ts:119

onHandlerAdded

get onHandlerAdded(): IEventHandler<
[key: string, callbackAdded: T],
HandlerAddedCallback<TArgs, T>,
>
Événement déclenché chaque fois qu'un handler est ajouté via add ou push.

Permet d'observer les ajouts sans sous-classer. Chaque callback reçoit la clé et le handler nouvellement enregistré.

Returns IEventHandler<[key: string, callbackAdded: T], HandlerAddedCallback<TArgs, T>>
Example
```
event.onHandlerAdded.push((key, cb) => {
  console.log(`Handler "${key}" ajouté`);
});
```
See
- HandlerAddedCallback
- INotifyCollectionChanged — C#
- Defined in src/lib/interfaces/IEventHandler.ts:56

onHandlerCleared

get onHandlerCleared(): IEventHandler<
[callbacksCleared: T[]],
HandlerClearedCallback<TArgs, T>,
>
Événement déclenché une seule fois lorsque tous les handlers sont supprimés via clear.

Préférable à onHandlerRemoved pour réagir à un effacement global — se déclenche en O(1) quelle que soit la taille de la liste, là où itérer sur onHandlerRemoved coûterait O(n).

Chaque callback reçoit la liste complète des handlers supprimés, permettant par exemple de les sauvegarder ou de les réenregistrer ailleurs.

Returns IEventHandler<[callbacksCleared: T[]], HandlerClearedCallback<TArgs, T>>
Example
```
event.onHandlerCleared.push((_, callbacks) => {
  console.log(`${callbacks.length} handler(s) supprimé(s)`);
});

event.clear(); // → "3 handler(s) supprimé(s)"
```
See
- HandlerClearedCallback
- onHandlerRemoved pour la suppression unitaire
- Defined in src/lib/interfaces/IEventHandler.ts:106

onHandlerRemoved

get onHandlerRemoved(): IEventHandler<
[key: string, callbackRemoved: MayBe<T>],
HandlerRemovedCallback<TArgs, T>,
>
Événement déclenché chaque fois qu'un handler est retiré via remove.

Permet d'observer les suppressions sans sous-classer. Chaque callback reçoit la clé et le handler qui vient d'être retiré.

Returns IEventHandler<
[key: string, callbackRemoved: MayBe<T>],
HandlerRemovedCallback<TArgs, T>,
>
Example
```
event.onHandlerRemoved.push((key, cb) => {
  console.log(`Handler "${key}" retiré`);
});
```
See
- HandlerRemovedCallback
- INotifyCollectionChanged — C#
- Defined in src/lib/interfaces/IEventHandler.ts:78

Methods

add

add(key: string, event: T, ...args: Partial<TArgs>): this
Ajoute un callback avec une clé spécifique.

Équivalent de l'opérateur += en C#, avec contrôle explicite de l'identifiant.
Parameters
- key: string
  Clé identifiant le callback.
- event: T
  Le callback à ajouter.
- ...args: Partial<TArgs>
  Arguments par défaut transmis au callback à chaque appel.
Returns this
L'instance courante pour permettre le chaînage.
- Defined in src/lib/interfaces/IEventHandler.ts:146

clear

clear(): this
Supprime tous les callbacks enregistrés.

Returns this
L'instance courante pour permettre le chaînage.
Example
```
event.clear().add('handler', monCallback);
```
- Defined in src/lib/interfaces/IEventHandler.ts:232

count

count(): uint
Retourne le nombre de callbacks actuellement enregistrés.

Returns uint
Le nombre de callbacks sous forme de uint.
- Defined in src/lib/interfaces/IEventHandler.ts:194

getInvocationList

getInvocationList(): T[]
Retourne la liste des callbacks actuellement enregistrés.

Équivalent de Delegate.GetInvocationList() en C# — permet d'inspecter les callbacks sans les déclencher, dans le même ordre qu'ils seront appelés lors d'un invoke.

Returns T[]
Un tableau contenant tous les callbacks enregistrés, dans leur ordre d'enregistrement.
Example
```
const handlers = event.getInvocationList();
console.log(`${handlers.length} handler(s) enregistré(s)`);
```
See
Delegate.GetInvocationList() — C#
- Defined in src/lib/interfaces/IEventHandler.ts:253

has

has(key: string): boolean
Vérifie si un callback est enregistré sous la clé donnée.
Parameters
- key: string
  La clé à vérifier.
Returns boolean
true si un callback existe pour cette clé, false sinon.
Example
```
if (event.has('monHandler')) {
  event.remove('monHandler');
}
```
- Defined in src/lib/interfaces/IEventHandler.ts:161

haveEvents

haveEvents(): boolean
Indique si au moins un callback est enregistré.

Returns boolean
true si l'événement a au moins un callback, false sinon.
- Defined in src/lib/interfaces/IEventHandler.ts:187

invoke

invoke(...args: TArgs): TResult
Déclenche tous les callbacks enregistrés avec les arguments fournis.

Équivalent de Invoke en C#. Le résultat dépend du nombre de callbacks enregistrés :
- { type: 'empty' } si aucun callback n'est enregistré.
- { type: 'single', value } si un seul callback est enregistré.
- { type: 'multiple', values } si plusieurs callbacks sont enregistrés.
Parameters
- ...args: TArgs
  Arguments transmis à chaque callback lors de l'appel.
Returns TResult
Un EventCallResult décrivant le résultat de l'appel.
Example
```
const result = event.invoke('bonjour', 42);

if (result.type === 'single') {
  console.log(result.value);
}
```
See
Delegate.Invoke — C#
- Defined in src/lib/interfaces/IEventHandler.ts:220

push

push(event: T, ...args: Partial<TArgs>): string
Ajoute un callback en générant automatiquement une clé unique.

Équivalent de l'opérateur += en C#.
Parameters
- event: T
  Le callback à ajouter.
- ...args: Partial<TArgs>
  Arguments par défaut transmis au callback à chaque appel.
Returns string
La clé générée permettant de retrouver ce callback plus tard.
- Defined in src/lib/interfaces/IEventHandler.ts:132

remove

remove(key: string): MayBe<T>
Supprime le callback associé à la clé donnée et le retourne.

Équivalent de l'opérateur -= en C#. Utile pour récupérer un handler existant afin de le réenregistrer sous une autre clé ou dans un autre événement.
Parameters
- key: string
  La clé du callback à supprimer.
Returns MayBe<T>
Le callback supprimé, si il éxiste.
Example
```
const ancien = event.remove('monHandler');
event.add('nouveauHandler', ancien);
```
- Defined in src/lib/interfaces/IEventHandler.ts:180

Interface IEventHandler<TArgs, T, TResult>

Example

See

Type Parameters

Implemented by

Index

Accessors

Methods

Accessors

keys

Returns string[]

Example

onHandlerAdded

Returns IEventHandler<[key: string, callbackAdded: T], HandlerAddedCallback<TArgs, T>>

Example

See

onHandlerCleared

Returns IEventHandler<[callbacksCleared: T[]], HandlerClearedCallback<TArgs, T>>

Example

See

onHandlerRemoved

Returns IEventHandler< [key: string, callbackRemoved: MayBe<T>], HandlerRemovedCallback<TArgs, T>,>

Example

See

Methods

add

Parameters

Returns this

clear

Returns this

Example

count

Returns uint

getInvocationList

Returns T[]

Example

See

has

Parameters

Returns boolean

Example

haveEvents

Returns boolean

invoke

Parameters

Returns TResult

Example

See

push

Parameters

Returns string

remove

Parameters

Returns MayBe<T>

Example

Settings

On This Page

Returns IEventHandler<
[key: string, callbackRemoved: MayBe<T>],
HandlerRemovedCallback<TArgs, T>,
>