Skip to main content

InternalTypes Namespace

Collection of value types that are not intended to be used/imported directly outside of this package.

This API is reserved for internal system use and should not be imported directly. It may change at any time without notice.

For more information about our API support guarantees, see here.

Signature

export declare namespace InternalTypes

Interfaces

Interface Alerts Description
MapValueState System Collection of optional values in a "map" structure.
NotificationType System Structure of a generic notification "value".
ValueDirectory System A directory of values, where each value may be an optional state or another directory.
ValueOptionalState System Represents a state that may have a value. And it includes standard metadata.
ValueRequiredState System Represents a state that must have a value. And it includes standard metadata.
ValueStateMetadata System Metadata for a value state.

Classes

Class Alerts Description
StateDatastoreHandle System Opaque type representing internal state datastore.
StateValueBrand System Brand to ensure state values internal type safety without revealing internals that are subject to change.

Types

TypeAlias Alerts Description
ManagerFactory System Package internal function declaration for state and notification instantiation.
StateValue System This type provides no additional functionality over the type it wraps. It is used to ensure type safety within package. Users may find it convenient to just use the type it wraps directly.
ValueDirectoryOrState System Convenience type for a required state or a directory of values.