---
title: "EventObject | Customer's Canvas On-Premises"
canonical: "https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/EventObject/"
---

# EventObject

> - [`EventObject`](#eventobject)
> - [`EventWithAutoSenderArg`](#eventwithautosenderarg)
> - [`EventWithSenderArg`](#eventwithsenderarg)

## Classes

### BaseEventObject

#### Extended by

#### Constructors

##### Constructor

```ts
new BaseEventObject(): BaseEventObject;
```

###### Returns

[`BaseEventObject`](#baseeventobject)

#### Methods

##### add()

```ts
add(listener): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `listener` | `Function` |

###### Returns

`void`

##### listenersCount()

```ts
listenersCount(): number;
```

###### Returns

`number`

##### notify()

```ts
notify(...args): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`[] |

###### Returns

`void`

##### remove()

```ts
remove(listener): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `listener` | `Function` |

###### Returns

`void`

***

### EventObject

#### Extends

- [`BaseEventObject`](#baseeventobject)

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |

#### Constructors

##### Constructor

```ts
new EventObject<T>(): EventObject<T>;
```

###### Returns

[`EventObject`](#eventobject)\<`T`\>

###### Inherited from

[`BaseEventObject`](#baseeventobject).[`constructor`](#constructor)

#### Methods

##### add()

```ts
add(listener): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `listener` | (`eventArg?`) => `any` |

###### Returns

`void`

###### Overrides

[`BaseEventObject`](#baseeventobject).[`add`](#add)

##### fire()

```ts
fire(data?): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `data?` | `T` |

###### Returns

`void`

##### listenersCount()

```ts
listenersCount(): number;
```

###### Returns

`number`

###### Inherited from

[`BaseEventObject`](#baseeventobject).[`listenersCount`](#listenerscount)

##### notify()

```ts
notify(data?): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `data?` | `T` |

###### Returns

`void`

###### Overrides

[`BaseEventObject`](#baseeventobject).[`notify`](#notify)

##### remove()

```ts
remove(listener): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `listener` | (`eventArg?`) => `any` |

###### Returns

`void`

###### Overrides

[`BaseEventObject`](#baseeventobject).[`remove`](#remove)

***

### EventWithAutoSenderArg

#### Extends

- [`BaseEventObject`](#baseeventobject)

#### Type Parameters

| Type Parameter |
| ------ |
| `TSender` |
| `TEventArg` |

#### Constructors

##### Constructor

```ts
new EventWithAutoSenderArg<TSender, TEventArg>(sender): EventWithAutoSenderArg<TSender, TEventArg>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `sender` | `TSender` |

###### Returns

[`EventWithAutoSenderArg`](#eventwithautosenderarg)\<`TSender`, `TEventArg`\>

###### Overrides

[`BaseEventObject`](#baseeventobject).[`constructor`](#constructor)

#### Methods

##### add()

```ts
add(listener): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `listener` | (`sender?`, `eventArg?`) => `any` |

###### Returns

`void`

###### Overrides

[`BaseEventObject`](#baseeventobject).[`add`](#add)

##### fire()

```ts
fire(data?): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `data?` | `TEventArg` |

###### Returns

`void`

##### listenersCount()

```ts
listenersCount(): number;
```

###### Returns

`number`

###### Inherited from

[`BaseEventObject`](#baseeventobject).[`listenersCount`](#listenerscount)

##### notify()

```ts
notify(data?): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `data?` | `TEventArg` |

###### Returns

`void`

###### Overrides

[`BaseEventObject`](#baseeventobject).[`notify`](#notify)

##### remove()

```ts
remove(listener): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `listener` | (`sender?`, `eventArg?`) => `any` |

###### Returns

`void`

###### Overrides

[`BaseEventObject`](#baseeventobject).[`remove`](#remove)

***

### EventWithSenderArg

#### Extends

- [`BaseEventObject`](#baseeventobject)

#### Type Parameters

| Type Parameter |
| ------ |
| `TSender` |
| `TEventArg` |

#### Constructors

##### Constructor

```ts
new EventWithSenderArg<TSender, TEventArg>(sender?): EventWithSenderArg<TSender, TEventArg>;
```

###### Parameters

| Parameter | Type | Default value |
| ------ | ------ | ------ |
| `sender` | `TSender` | `null` |

###### Returns

[`EventWithSenderArg`](#eventwithsenderarg)\<`TSender`, `TEventArg`\>

###### Overrides

[`BaseEventObject`](#baseeventobject).[`constructor`](#constructor)

#### Methods

##### add()

```ts
add(listener): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `listener` | (`sender?`, `eventArg?`) => `any` |

###### Returns

`void`

###### Overrides

[`BaseEventObject`](#baseeventobject).[`add`](#add)

##### listenersCount()

```ts
listenersCount(): number;
```

###### Returns

`number`

###### Inherited from

[`BaseEventObject`](#baseeventobject).[`listenersCount`](#listenerscount)

##### notify()

```ts
notify(sender, data?): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `sender` | `TSender` |
| `data?` | `TEventArg` |

###### Returns

`void`

###### Overrides

[`BaseEventObject`](#baseeventobject).[`notify`](#notify)

##### remove()

```ts
remove(listener): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `listener` | (`sender?`, `eventArg?`) => `any` |

###### Returns

`void`

###### Overrides

[`BaseEventObject`](#baseeventobject).[`remove`](#remove)