CipherStashDocs
StackLatestPackagesStackSrcEncryptionClasses

DecryptModelOperation

DecryptModelOperation is a class in @cipherstash/stack. TypeScript API reference with its signature, parameters, and usage.

@cipherstash/stack


Class: DecryptModelOperation<T>

Defined in: packages/stack/src/encryption/operations/decrypt-model.ts:14

Extends

Type Parameters

T

T extends Record<string, unknown>

Constructors

Constructor

new DecryptModelOperation&lt;T&gt;(client, model): DecryptModelOperation&lt;T&gt;;

Defined in: packages/stack/src/encryption/operations/decrypt-model.ts:20

Parameters

client

Client

model

T

Returns

DecryptModelOperation<T>

Overrides

EncryptionOperation&lt;Decrypted&lt;T&gt;>.constructor

Methods

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.audit

getAuditData()

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.getAuditData

then()

then&lt;TResult1, TResult2&gt;(onfulfilled?, onrejected?): Promise&lt;TResult1 | TResult2&gt;;

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.then

withLockContext()

withLockContext(lockContext): DecryptModelOperationWithLockContext&lt;T&gt;;

Defined in: packages/stack/src/encryption/operations/decrypt-model.ts:26

Parameters

lockContext

LockContext

Returns

DecryptModelOperationWithLockContext<T>


execute()

execute(): Promise&lt;Result&lt;Decrypted&lt;T&gt;, 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.execute

getOperation()

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;

On this page