Class CircularEventDelegate<TRecord>

Raccourci ergonomique vers CircularEventHandler conservant la même signature qu'à l'origine.

Permet d'instancier un gestionnaire d'événement circulaire en ne spécifiant que le type du record propagé entre les callbacks :

// Avec CircularEventDelegate
const pipeline = new CircularEventDelegate<{ count: number }>();

// Équivalent avec CircularEventHandler
const pipeline = new CircularEventHandler<{ count: number }, (param: { count: number }) => Partial<{ count: number }>>();

Example

const pipeline = new CircularEventDelegate<{ count: number; label: string }>();

pipeline.add('increment', (record) => ({ count: record.count + 1 }));
pipeline.add('label',     (record) => ({ label: `count=${record.count}` }));

const result = pipeline.invoke({ count: 0, label: '' });
// result → { type: 'record', value: { count: 1, label: 'count=1' } }

See

CircularEventHandler pour l'API complète
EventDelegate pour la variante standard

Type Parameters

TRecord extends Record<string, unknown> = Record<string, unknown>
Type du record propagé entre les callbacks. Doit étendre Record<string, unknown>. Par défaut Record<string, unknown>.

Hierarchy (View Summary)

CircularEventHandler<TRecord>
- CircularEventDelegate

Index

Constructors

constructor

new CircularEventDelegate<
TRecord extends Record<string, unknown> = Record<string, unknown>,
>(
warnLogger?: (...args: any[]) => void,
): CircularEventDelegate<TRecord>
Type Parameters
- TRecord extends Record<string, unknown> = Record<string, unknown>
  Type du record propagé entre les callbacks. Doit étendre Record<string, unknown>. Par défaut Record<string, unknown>.
Parameters
- warnLogger: (...args: any[]) => void = ...
  Logger si un problème survient dans le invoke.
Returns CircularEventDelegate<TRecord>
Inherited from CircularEventHandler.constructor
- Defined in src/lib/classes/CircularEventHandler.ts:66

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']
```
Inherited from CircularEventHandler.keys
- Defined in src/lib/abstract/AEventHandler.ts:89

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.

Initialisé de façon lazy via _p_initOnHandlerAdded lors du premier accès — aucun coût si personne ne s'y abonne.

Returns IEventHandler<[key: string, callbackAdded: T], HandlerAddedCallback<TArgs, T>>
Example
```
event.onHandlerAdded.push((key, cb) => {
  console.log(`Handler "${key}" ajouté`);
});
```
See
HandlerAddedCallback
Inherited from CircularEventHandler.onHandlerAdded
- Defined in src/lib/abstract/AEventHandler.ts:109

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.

Initialisé de façon lazy via _p_initOnHandlerCleared lors du premier accès — aucun coût si personne ne s'y abonne.

Returns IEventHandler<[callbacksCleared: T[]], HandlerClearedCallback<TArgs, T>>
Example
```
event.onHandlerCleared.push((callbacks) => {
  console.log(`${callbacks.length} handler(s) supprimé(s)`);
});
```
See
HandlerClearedCallback
Inherited from CircularEventHandler.onHandlerCleared
- Defined in src/lib/abstract/AEventHandler.ts:154

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.

Initialisé de façon lazy via _p_initOnHandlerRemoved lors du premier accès — aucun coût si personne ne s'y abonne.

Returns IEventHandler<
[key: string, callbackRemoved: MayBe<T>],
HandlerRemovedCallback<TArgs, T>,
>
Example
```
event.onHandlerRemoved.push((key, cb) => {
  console.log(`Handler "${key}" retiré`);
});
```
See
HandlerRemovedCallback
Inherited from CircularEventHandler.onHandlerRemoved
- Defined in src/lib/abstract/AEventHandler.ts:131

Methods

`Protected`_p_get

_p_get(
key: string,
): MayBe<IEventData<[TRecord], Func<[TRecord], Partial<TRecord>>>>
Protected
Retourne les données associées à la clé donnée, ou null si la clé n'existe pas.

Point d'accès protégé au dictionnaire interne — permet aux classes concrètes d'accéder aux données d'un callback sans exposer #_callbacks directement.
Parameters
- key: string
  La clé du callback à récupérer.
Returns MayBe<IEventData<[TRecord], Func<[TRecord], Partial<TRecord>>>>
Les données du callback, ou null si la clé est absente.
Inherited from CircularEventHandler._p_get
- Defined in src/lib/abstract/AEventHandler.ts:314

`Protected`_p_initOnHandlerAdded

_p_initOnHandlerAdded(): IEventHandler<
[key: string, callbackAdded: Func<[TRecord], Partial<TRecord>>],
HandlerAddedCallback<[TRecord], Func<[TRecord], Partial<TRecord>>>,
>
Protected
Initialise l'instance de onHandlerAdded.

Returns IEventHandler<
[key: string, callbackAdded: Func<[TRecord], Partial<TRecord>>],
HandlerAddedCallback<[TRecord], Func<[TRecord], Partial<TRecord>>>,
>
Une nouvelle instance de EventHandler.
Inherited from CircularEventHandler._p_initOnHandlerAdded
- Defined in src/lib/classes/CircularEventHandler.ts:179

`Protected`_p_initOnHandlerCleared

_p_initOnHandlerCleared(): IEventHandler<
[callbacksCleared: Func<[TRecord], Partial<TRecord>>[]],
HandlerClearedCallback<[TRecord], Func<[TRecord], Partial<TRecord>>>,
>
Protected
Initialise l'instance de onHandlerCleared.

Returns IEventHandler<
[callbacksCleared: Func<[TRecord], Partial<TRecord>>[]],
HandlerClearedCallback<[TRecord], Func<[TRecord], Partial<TRecord>>>,
>
Une nouvelle instance de EventHandler.
Inherited from CircularEventHandler._p_initOnHandlerCleared
- Defined in src/lib/classes/CircularEventHandler.ts:203

`Protected`_p_initOnHandlerRemoved

_p_initOnHandlerRemoved(): IEventHandler<
[key: string, callbackRemoved: MayBe<Func<[TRecord], Partial<TRecord>>>],
HandlerRemovedCallback<[TRecord], Func<[TRecord], Partial<TRecord>>>,
>
Protected
Initialise l'instance de onHandlerRemoved.

Returns IEventHandler<
[key: string, callbackRemoved: MayBe<Func<[TRecord], Partial<TRecord>>>],
HandlerRemovedCallback<[TRecord], Func<[TRecord], Partial<TRecord>>>,
>
Une nouvelle instance de EventHandler.
Inherited from CircularEventHandler._p_initOnHandlerRemoved
- Defined in src/lib/classes/CircularEventHandler.ts:191

add

add(key: string, event: Func, ...args: [TRecord?]): this
Ajoute un callback avec une clé spécifique.
Parameters
- key: string
  Clé identifiant le callback.
- event: Func
  Le callback à ajouter.
- ...args: [TRecord?]
  Arguments par défaut transmis au callback à chaque appel.
Returns this
L'instance courante pour permettre le chaînage.
Inherited from CircularEventHandler.add
- Defined in src/lib/abstract/AEventHandler.ts:184

call

call(param: TRecord): TRecord | null
Déclenche la chaîne de callbacks et retourne le record final.

Conserve la compatibilité avec l'ancienne API JsCircularEvent.call(). Préférer invoke qui retourne un CircularEventCallResult discriminé, plus sûr à utiliser en TypeScript.
Parameters
- param: TRecord
  Le record initial transmis au premier callback.
Returns TRecord | null
Le record final après passage dans tous les callbacks, ou null si aucun callback n'est enregistré.

Deprecated
Utilisez invoke à la place.
Inherited from CircularEventHandler.call
- Defined in src/lib/classes/CircularEventHandler.ts:161

clear

clear(): this
Supprime tous les callbacks enregistrés en une seule opération O(1).

Capture la liste des callbacks avant l'effacement, puis déclenche onHandlerCleared après — garantissant que la Map est vide avant la notification, sans risque de double déclenchement si un observateur appelle add dans son callback.

Returns this
L'instance courante pour permettre le chaînage.
Inherited from CircularEventHandler.clear
- Defined in src/lib/abstract/AEventHandler.ts:330

count

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

Returns uint
Le nombre de callbacks sous forme de uint.
Inherited from CircularEventHandler.count
- Defined in src/lib/abstract/AEventHandler.ts:245

getInvocationList

getInvocationList(): Func<[TRecord], Partial<TRecord>>[]
Retourne la liste des callbacks actuellement enregistrés, dans leur ordre d'enregistrement.

Équivalent de Delegate.GetInvocationList() en C#.

Returns Func<[TRecord], Partial<TRecord>>[]
Un tableau contenant tous les callbacks enregistrés.

See
Delegate.GetInvocationList() — C#
Inherited from CircularEventHandler.getInvocationList
- Defined in src/lib/abstract/AEventHandler.ts:355

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.
Inherited from CircularEventHandler.has
- Defined in src/lib/abstract/AEventHandler.ts:202

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.
Inherited from CircularEventHandler.haveEvents
- Defined in src/lib/abstract/AEventHandler.ts:236

invoke

invoke(args_0: TRecord): CircularEventCallResult<TRecord>
Déclenche la chaîne de callbacks en propageant un record muté de l'un à l'autre.

Pour chaque callback enregistré, dans l'ordre d'enregistrement :
1. Les arguments par défaut du callback (s'ils sont un plain object) sont mergés dans le record courant.
2. Le callback est appelé avec le record courant.
3. Si le résultat est un plain object, il est mergé dans le record courant avant le prochain callback.
Si args_0 n'est pas un plain object, un avertissement est émis via logger, la valeur est wrappée dans { default: args_0 } et la chaîne est exécutée normalement. Le résultat est alors de type 'other'.
Parameters
- args_0: TRecord
  Le record initial transmis au premier callback.
Returns CircularEventCallResult<TRecord>
Un CircularEventCallResult décrivant le résultat :
- { type: 'empty' } si aucun callback n'est enregistré.
- { type: 'record', value } si la chaîne s'est exécutée normalement.
- { type: 'other', value, originalValue } si args_0 n'était pas un plain object.
Example
```
const result = pipeline.invoke({ count: 0 });

if (result.type === 'record') {
  console.log(result.value.count);
}
```
Inherited from CircularEventHandler.invoke
- Defined in src/lib/classes/CircularEventHandler.ts:106

push

push(event: Func, ...args: [TRecord?]): string
Ajoute un callback en générant automatiquement une clé unique.
Parameters
- event: Func
  Le callback à ajouter.
- ...args: [TRecord?]
  Arguments par défaut transmis au callback à chaque appel.
Returns string
La clé générée.
Inherited from CircularEventHandler.push
- Defined in src/lib/abstract/AEventHandler.ts:170

remove

remove(key: string): MayBe<Func<[TRecord], Partial<TRecord>>>
Supprime le callback associé à la clé donnée et le retourne.

Déclenche onHandlerRemoved si des observateurs sont abonnés.
Parameters
- key: string
  La clé du callback à supprimer.
Returns MayBe<Func<[TRecord], Partial<TRecord>>>
Le callback supprimé, ou null si la clé n'existe pas.
Inherited from CircularEventHandler.remove
- Defined in src/lib/abstract/AEventHandler.ts:214

Class CircularEventDelegate<TRecord>

Example

See

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns CircularEventDelegate<TRecord>

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

Protected_p_get

Parameters

Returns MayBe<IEventData<[TRecord], Func<[TRecord], Partial<TRecord>>>>

Protected_p_initOnHandlerAdded

Returns IEventHandler< [key: string, callbackAdded: Func<[TRecord], Partial<TRecord>>], HandlerAddedCallback<[TRecord], Func<[TRecord], Partial<TRecord>>>,>

Protected_p_initOnHandlerCleared

Returns IEventHandler< [callbacksCleared: Func<[TRecord], Partial<TRecord>>[]], HandlerClearedCallback<[TRecord], Func<[TRecord], Partial<TRecord>>>,>

Protected_p_initOnHandlerRemoved

Returns IEventHandler< [key: string, callbackRemoved: MayBe<Func<[TRecord], Partial<TRecord>>>], HandlerRemovedCallback<[TRecord], Func<[TRecord], Partial<TRecord>>>,>

add

Parameters

Returns this

call

Parameters

Returns TRecord | null

Deprecated

clear

Returns this

count

Returns uint

getInvocationList

Returns Func<[TRecord], Partial<TRecord>>[]

See

has

Parameters

Returns boolean

haveEvents

Returns boolean

invoke

Parameters

Returns CircularEventCallResult<TRecord>

Example

push

Parameters

Returns string

remove

Parameters

Returns MayBe<Func<[TRecord], Partial<TRecord>>>

Settings

On This Page

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

`Protected`_p_get

`Protected`_p_initOnHandlerAdded

Returns IEventHandler<
[key: string, callbackAdded: Func<[TRecord], Partial<TRecord>>],
HandlerAddedCallback<[TRecord], Func<[TRecord], Partial<TRecord>>>,
>

`Protected`_p_initOnHandlerCleared

Returns IEventHandler<
[callbacksCleared: Func<[TRecord], Partial<TRecord>>[]],
HandlerClearedCallback<[TRecord], Func<[TRecord], Partial<TRecord>>>,
>

`Protected`_p_initOnHandlerRemoved

Returns IEventHandler<
[key: string, callbackRemoved: MayBe<Func<[TRecord], Partial<TRecord>>>],
HandlerRemovedCallback<[TRecord], Func<[TRecord], Partial<TRecord>>>,
>