DecryptOperation
Decrypts an encrypted payload using the provided client. This is the type returned by the decrypt method of the EncryptionClient.
Class: DecryptOperation
Defined in: packages/stack/src/encryption/operations/decrypt.ts:18
Decrypts an encrypted payload using the provided client. This is the type returned by the decrypt method of the EncryptionClient.
Extends
EncryptionOperation<JsPlaintext>
Constructors
Constructor
new DecryptOperation(client, encryptedData): DecryptOperation;Defined in: packages/stack/src/encryption/operations/decrypt.ts:26
Parameters
client
encryptedData
Encrypted | null
Returns
DecryptOperation
Overrides
EncryptionOperation<JsPlaintext>.constructorMethods
audit()
audit(config): this;Defined in: packages/stack/src/encryption/operations/base-operation.ts:20
Attach audit metadata to this operation. Can be chained.
Parameters
config
AuditConfig
Configuration for ZeroKMS audit logging
Returns
this
Inherited from
EncryptionOperation.auditgetAuditData()
getAuditData(): AuditData;Defined in: packages/stack/src/encryption/operations/base-operation.ts:28
Get the audit data for this operation.
Returns
AuditData
Inherited from
EncryptionOperation.getAuditDatathen()
then<TResult1, TResult2>(onfulfilled?, onrejected?): Promise<TResult1 | TResult2>;Defined in: packages/stack/src/encryption/operations/base-operation.ts:42
Make the operation thenable
Type Parameters
TResult1
TResult1 = Result<JsPlaintext, EncryptionError>
TResult2
TResult2 = never
Parameters
onfulfilled?
(value) => TResult1 | PromiseLike<TResult1> | null
onrejected?
(reason) => TResult2 | PromiseLike<TResult2> | null
Returns
Promise<TResult1 | TResult2>
Inherited from
EncryptionOperation.thenwithLockContext()
withLockContext(lockContext): DecryptOperationWithLockContext;Defined in: packages/stack/src/encryption/operations/decrypt.ts:32
Parameters
lockContext
Returns
DecryptOperationWithLockContext
execute()
execute(): Promise<Result<JsPlaintext, EncryptionError>>;Defined in: packages/stack/src/encryption/operations/decrypt.ts:38
Execute the operation and return a Result
Returns
Promise<Result<JsPlaintext, EncryptionError>>
Overrides
EncryptionOperation.executegetOperation()
getOperation(): {
client: Client;
encryptedData: Encrypted | null;
auditData?: Record<string, unknown>;
};Defined in: packages/stack/src/encryption/operations/decrypt.ts:76
Returns
{
client: Client;
encryptedData: Encrypted | null;
auditData?: Record<string, unknown>;
}client
client: Client;encryptedData
encryptedData: Encrypted | null;auditData?
optional auditData: Record<string, unknown>;