DecryptModelOperation
DecryptModelOperation is a class in @cipherstash/stack. TypeScript API reference with its signature, parameters, and usage.
Class: DecryptModelOperation<T>
Defined in: packages/stack/src/encryption/operations/decrypt-model.ts:14
Extends
EncryptionOperation<Decrypted<T>>
Type Parameters
T
T extends Record<string, unknown>
Constructors
Constructor
new DecryptModelOperation<T>(client, model): DecryptModelOperation<T>;Defined in: packages/stack/src/encryption/operations/decrypt-model.ts:20
Parameters
client
model
T
Returns
DecryptModelOperation<T>
Overrides
EncryptionOperation<Decrypted<T>>.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<Decrypted<T>, 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): DecryptModelOperationWithLockContext<T>;Defined in: packages/stack/src/encryption/operations/decrypt-model.ts:26
Parameters
lockContext
Returns
DecryptModelOperationWithLockContext<T>
execute()
execute(): Promise<Result<Decrypted<T>, EncryptionError>>;Defined in: packages/stack/src/encryption/operations/decrypt-model.ts:32
Execute the operation and return a Result
Returns
Promise<Result<Decrypted<T>, EncryptionError>>
Overrides
EncryptionOperation.executegetOperation()
getOperation(): {
client: Client;
model: T;
};Defined in: packages/stack/src/encryption/operations/decrypt-model.ts:62
Returns
{
client: Client;
model: T;
}client
client: Client;model
model: T;