Skip to content

Commit e9f3d32

Browse files
committed
fix: add docs to EventTypes
Signed-off-by: Todd Baert <[email protected]>
1 parent 82e5fb3 commit e9f3d32

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

packages/shared/src/types.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,24 @@
11
export type PrimitiveValue = null | boolean | string | number;
22

33
export enum ProviderEvents {
4+
/**
5+
* The provider is ready to evaluate flags.
6+
*/
47
Ready = 'PROVIDER_READY',
8+
9+
/**
10+
* The provider is in an error state.
11+
*/
512
Error = 'PROVIDER_ERROR',
13+
14+
/**
15+
* The flag configuration in the source-of-truth has changed.
16+
*/
617
ConfigurationChanged = 'PROVIDER_CONFIGURATION_CHANGED',
18+
19+
/**
20+
* The provider is transitioning to a state of unavailability.
21+
*/
722
Shutdown = 'PROVIDER_SHUTDOWN',
823
};
924

0 commit comments

Comments
 (0)