PURISTA API / Modules / @purista/dapr-sdk / DaprSecretStore
Class: DaprSecretStore
@purista/dapr-sdk.DaprSecretStore
DaprSecretStore is an adapter which connects to the secret store provided by the underlaying Dapr infrastructure.
Dapr currently provides only the possibility to fetch a secret. Creating a new secret, changing an existing secret or removal of secrets is not supported.
Hierarchy
SecretStoreBaseClass<DaprSecretStoreConfig>↳
DaprSecretStore
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new DaprSecretStore(config?): DaprSecretStore
Parameters
| Name | Type | Description |
|---|---|---|
config? | Object | - |
config.cacheTtl? | number | Cache time to live in ms |
config.clientConfig? | DaprClientConfig | The Dapr client config to interact with Dapr sidecar |
config.enableCache? | boolean | Enable cache |
config.enableGet? | boolean | Enable generally get method |
config.enableRemove? | boolean | Enable generally remove method |
config.enableSet? | boolean | Enable generally set method |
config.logLevel? | LogLevelName | A log level for new logger if logger is not set |
config.logger? | Logger | A logger instance |
config.metadata? | Object | Dapr secret store metadata |
config.metadata.namespace? | string | In case of deploying into namespace other than default, the namespace (e.g. production) must be set |
config.secretStoreName? | string | The name of the secret store |
Returns
Overrides
SecretStoreBaseClass.constructor
Defined in
dapr-sdk/src/DaprSecretStore/DaprSecretStore.impl.ts:20
Properties
cache
• cache: SecretStoreCacheMap
Inherited from
Defined in
core/dist/commonjs/core/SecretStore/SecretStoreBaseClass.impl.d.ts:20
client
• Private client: HttpClient<DaprClientConfig>
Defined in
dapr-sdk/src/DaprSecretStore/DaprSecretStore.impl.ts:18
config
• config: Object
Type declaration
| Name | Type | Description |
|---|---|---|
cacheTtl? | number | Cache time to live in ms |
clientConfig? | DaprClientConfig | The Dapr client config to interact with Dapr sidecar |
enableCache? | boolean | Enable cache |
enableGet? | boolean | Enable generally get method |
enableRemove? | boolean | Enable generally remove method |
enableSet? | boolean | Enable generally set method |
logLevel? | LogLevelName | A log level for new logger if logger is not set |
logger? | Logger | A logger instance |
metadata? | { namespace?: string } | Dapr secret store metadata |
metadata.namespace? | string | In case of deploying into namespace other than default, the namespace (e.g. production) must be set |
secretStoreName? | string | The name of the secret store |
Inherited from
Defined in
core/dist/commonjs/core/SecretStore/SecretStoreBaseClass.impl.d.ts:18
logger
• logger: Logger
Inherited from
Defined in
core/dist/commonjs/core/SecretStore/SecretStoreBaseClass.impl.d.ts:17
name
• name: string
Inherited from
Defined in
core/dist/commonjs/core/SecretStore/SecretStoreBaseClass.impl.d.ts:19
Methods
destroy
▸ destroy(): Promise<void>
Returns
Promise<void>
Inherited from
Defined in
core/dist/commonjs/core/SecretStore/SecretStoreBaseClass.impl.d.ts:28
getSecret
▸ getSecret<SecretNames>(...secretNames): Promise<ObjectWithKeysFromStringArray<SecretNames, undefined | string>>
Type parameters
| Name | Type |
|---|---|
SecretNames | extends string[] |
Parameters
| Name | Type |
|---|---|
...secretNames | SecretNames |
Returns
Promise<ObjectWithKeysFromStringArray<SecretNames, undefined | string>>
Inherited from
SecretStoreBaseClass.getSecret
Defined in
core/dist/commonjs/core/SecretStore/SecretStoreBaseClass.impl.d.ts:23
getSecretImpl
▸ getSecretImpl<SecretNames>(...secretNames): Promise<ObjectWithKeysFromStringArray<SecretNames, undefined | string>>
Type parameters
| Name | Type |
|---|---|
SecretNames | extends string[] |
Parameters
| Name | Type |
|---|---|
...secretNames | SecretNames |
Returns
Promise<ObjectWithKeysFromStringArray<SecretNames, undefined | string>>
Overrides
SecretStoreBaseClass.getSecretImpl
Defined in
dapr-sdk/src/DaprSecretStore/DaprSecretStore.impl.ts:55
removeSecret
▸ removeSecret(secretName): Promise<void>
Parameters
| Name | Type |
|---|---|
secretName | string |
Returns
Promise<void>
Inherited from
SecretStoreBaseClass.removeSecret
Defined in
core/dist/commonjs/core/SecretStore/SecretStoreBaseClass.impl.d.ts:25
removeSecretImpl
▸ removeSecretImpl(_secretName): Promise<void>
Parameters
| Name | Type |
|---|---|
_secretName | string |
Returns
Promise<void>
Overrides
SecretStoreBaseClass.removeSecretImpl
Defined in
dapr-sdk/src/DaprSecretStore/DaprSecretStore.impl.ts:93
setSecret
▸ setSecret(secretName, secretValue): Promise<void>
Parameters
| Name | Type |
|---|---|
secretName | string |
secretValue | string |
Returns
Promise<void>
Inherited from
SecretStoreBaseClass.setSecret
Defined in
core/dist/commonjs/core/SecretStore/SecretStoreBaseClass.impl.d.ts:27
setSecretImpl
▸ setSecretImpl(_secretName): Promise<void>
Parameters
| Name | Type |
|---|---|
_secretName | string |
Returns
Promise<void>
Overrides
SecretStoreBaseClass.setSecretImpl