# @webex/event-dictionary-ts

This package is designed as a *type module* to be consumed within various `@webex` scoped packages. This module reflects the contents of our event dictionary tooling internally, exposed for external consumption.

## Table of Contents

* [Consumption](#consumption)
  * [Installation](#installation)
  * [Usage](#usage)
* [Contribute](#contribute)
* [Maintainers](#maintainers)

## Consumption

This package is intended to be consumed within a [TypeScript](https://www.typescriptlang.org/) project as a *type module*.

### Installation

This project is meant to be consumed as a **dev-dependency**.

Installation can be performed by using the following commands:

```bash
# Project root
yarn add --dev @webex/event-dictionary-ts
```

### Usage

This package is expected to be consumed as a TypeScript *type module*.

```ts
import type { Event } from '@webex/event-dictionary-ts';
```

To see a full list of event interfaces, please inspect the `./dist/index.d.ts` file from the root of this module.

## Contribute

This product is a reflection of our internal event designations and is not intended to be contributed to externally, and exists only as a permeable resource for other products interacting with our metrics service.

## Maintainers

This package is maintained by [Webex by Cisco](https://www.webex.com/)