TypeScript SDK Reference
api/client.gen.Secret
A reference to a secret value, which can be handled more safely than the value itself.
Hierarchy
-
BaseClient
↳
Secret
Constructors
constructor
new Secret(parent?
, _id?
, _name?
, _plaintext?
): Secret
Constructor is used for internal usage only, do not create object from it.
Parameters
Name | Type |
---|---|
parent? | Object |
parent.ctx | Context |
parent.queryTree? | QueryTree [] |
_id? | SecretID |
_name? | string |
_plaintext? | string |
Returns
Overrides
BaseClient.constructor
Properties
_id
Private
Optional
Readonly
_id: SecretID
= undefined
_name
Private
Optional
Readonly
_name: string
= undefined
_plaintext
Private
Optional
Readonly
_plaintext: string
= undefined
Methods
id
id(): Promise
<SecretID
>
A unique identifier for this Secret.
Returns
Promise
<SecretID
>
name
name(): Promise
<string
>
The name of this secret.
Returns
Promise
<string
>
plaintext
plaintext(): Promise
<string
>
The value of this secret.
Returns
Promise
<string
>