@fluidframework/common-definitions Package
Packages > @fluidframework/common-definitions
This library contains common interfaces and definitions used by the Fluid Framework.
Interfaces
| Interface | Alerts | Description |
|---|---|---|
| IErrorEvent | Deprecated, Alpha |
Base interface for error event emitters. |
| IEvent | Deprecated, Alpha |
Base interface for event emitters. |
| IEventProvider | Deprecated, Alpha |
Base interface for event providers. |
| ITaggedTelemetryPropertyType | Deprecated, Alpha |
A property to be logged to telemetry containing both the value and a tag. Tags are generic strings that can be used to mark pieces of information that should be organized or handled differently by loggers in various first or third party scenarios. For example, tags are used to mark data that should not be stored in logs for privacy reasons. |
| ITelemetryProperties | Deprecated, Alpha |
JSON-serializable properties, which will be logged with telemetry. |
Types
| TypeAlias | Alerts | Description |
|---|---|---|
| ExtendEventProvider | Deprecated, Alpha |
Allows an interface to extend interfaces that already extend an IEventProvider. |
| IEventThisPlaceHolder | Deprecated, Alpha |
The placeholder type that should be used instead of this in events. |
| IEventTransformer | Deprecated, Alpha |
This type is a conditional type for transforming all the overloads provided in TEvent. |
| ReplaceIEventThisPlaceHolder | Deprecated, Alpha |
Does the type replacement by changing types of IEventThisPlaceHolder to TThis |
| TelemetryEventPropertyType | Deprecated, Alpha |
Property types that can be logged. |
| TransformedEvent | Deprecated, Alpha |
Transforms the event overload by replacing IEventThisPlaceHolder with TThis in the event listener arguments and having the overload return TTHis as well |