@webex/event-dictionary-ts 0.0.2 → 0.0.1236
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +44 -2
- package/generated/typescript/index.d.ts +8861 -3
- package/package.json +7 -3
package/README.md
CHANGED
|
@@ -1,4 +1,46 @@
|
|
|
1
1
|
# @webex/event-dictionary-ts
|
|
2
2
|
|
|
3
|
-
This package is
|
|
4
|
-
|
|
3
|
+
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.
|
|
4
|
+
|
|
5
|
+
## Table of Contents
|
|
6
|
+
|
|
7
|
+
* [Consumption](#consumption)
|
|
8
|
+
* [Installation](#installation)
|
|
9
|
+
* [Usage](#usage)
|
|
10
|
+
* [Contribute](#contribute)
|
|
11
|
+
* [Maintainers](#maintainers)
|
|
12
|
+
|
|
13
|
+
## Consumption
|
|
14
|
+
|
|
15
|
+
This package is intended to be consumed within a [TypeScript](https://www.typescriptlang.org/) project as a *type module*.
|
|
16
|
+
|
|
17
|
+
### Installation
|
|
18
|
+
|
|
19
|
+
This project is meant to be consumed as a **dev-dependency**.
|
|
20
|
+
|
|
21
|
+
Installation can be performed by using the following commands:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
# Project root
|
|
25
|
+
yarn add --dev @webex/event-dictionary-ts
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### Usage
|
|
29
|
+
|
|
30
|
+
This package is expected to be consumed as a TypeScript *type module*.
|
|
31
|
+
|
|
32
|
+
```ts
|
|
33
|
+
import type { Event } from '@webex/event-dictionary-ts';
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
To see a full list of event interfaces, please inspect the `./dist/index.d.ts` file from the root of this module.
|
|
37
|
+
|
|
38
|
+
## Contribute
|
|
39
|
+
|
|
40
|
+
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.
|
|
41
|
+
|
|
42
|
+
## Maintainers
|
|
43
|
+
|
|
44
|
+
This package is maintained by [Webex by Cisco](https://www.webex.com/)
|
|
45
|
+
|
|
46
|
+
|