@openfeature/flagd-provider 0.12.0 → 0.13.1
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 +18 -12
- package/index.cjs.js +1476 -1330
- package/index.esm.js +1476 -1330
- package/package.json +8 -8
- package/src/lib/configuration.d.ts +6 -6
- package/src/proto/ts/flagd/evaluation/v1/evaluation.d.ts +32 -575
- package/src/proto/ts/flagd/sync/v1/sync.d.ts +12 -73
- package/src/proto/ts/google/protobuf/struct.d.ts +8 -88
- package/src/proto/ts/schema/v1/schema.d.ts +32 -575
- package/src/proto/ts/sync/v1/sync_service.d.ts +8 -53
package/README.md
CHANGED
|
@@ -27,17 +27,23 @@ Options can be defined in the constructor or as environment variables. Construct
|
|
|
27
27
|
|
|
28
28
|
### Available Configuration Options
|
|
29
29
|
|
|
30
|
-
| Option name | Environment variable name | Type | Default
|
|
31
|
-
| -------------------------------------- | ------------------------------ | -------
|
|
32
|
-
| host | FLAGD_HOST | string | localhost
|
|
33
|
-
| port | FLAGD_PORT | number |
|
|
34
|
-
| tls | FLAGD_TLS | boolean | false
|
|
35
|
-
| socketPath | FLAGD_SOCKET_PATH | string | -
|
|
36
|
-
| resolverType | FLAGD_RESOLVER | string | rpc
|
|
37
|
-
| offlineFlagSourcePath | FLAGD_OFFLINE_FLAG_SOURCE_PATH | string | -
|
|
38
|
-
| selector | FLAGD_SOURCE_SELECTOR | string | -
|
|
39
|
-
| cache | FLAGD_CACHE | string | lru
|
|
40
|
-
| maxCacheSize | FLAGD_MAX_CACHE_SIZE | int | 1000
|
|
30
|
+
| Option name | Environment variable name | Type | Default | Supported values |
|
|
31
|
+
| -------------------------------------- | ------------------------------ | ------- |----------------------------------------------------------------| ---------------- |
|
|
32
|
+
| host | FLAGD_HOST | string | localhost | |
|
|
33
|
+
| port | FLAGD_PORT | number | [resolver specific defaults](#resolver-type-specific-defaults) | |
|
|
34
|
+
| tls | FLAGD_TLS | boolean | false | |
|
|
35
|
+
| socketPath | FLAGD_SOCKET_PATH | string | - | |
|
|
36
|
+
| resolverType | FLAGD_RESOLVER | string | rpc | rpc, in-process |
|
|
37
|
+
| offlineFlagSourcePath | FLAGD_OFFLINE_FLAG_SOURCE_PATH | string | - | |
|
|
38
|
+
| selector | FLAGD_SOURCE_SELECTOR | string | - | |
|
|
39
|
+
| cache | FLAGD_CACHE | string | lru | lru, disabled |
|
|
40
|
+
| maxCacheSize | FLAGD_MAX_CACHE_SIZE | int | 1000 | |
|
|
41
|
+
|
|
42
|
+
#### Resolver type-specific Defaults
|
|
43
|
+
|
|
44
|
+
| Option name | Environment variable name | in-process | rpc | default |
|
|
45
|
+
| -------------------------------------- | ------------------------------ |-------------|------|---------|
|
|
46
|
+
| port | FLAGD_PORT | 8015 | 8013 | 8013 |
|
|
41
47
|
|
|
42
48
|
Below are examples of usage patterns.
|
|
43
49
|
|
|
@@ -72,7 +78,7 @@ Flag configurations for evaluation are obtained via gRPC protocol using [sync pr
|
|
|
72
78
|
}))
|
|
73
79
|
```
|
|
74
80
|
|
|
75
|
-
In the above example, the provider expects a flag sync service implementation to be available at `localhost:
|
|
81
|
+
In the above example, the provider expects a flag sync service implementation to be available at `localhost:8015` (default host and port).
|
|
76
82
|
|
|
77
83
|
In-process resolver can also work in an offline mode.
|
|
78
84
|
To enable this mode, you should provide a valid flag configuration file with the option `offlineFlagSourcePath`.
|