CipherStashDocs
StackLatestPackagesStackSrcDynamodbClasses

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/dynamodb/operations/decrypt-model.ts:13

Extends

Type Parameters

T

T extends Record<string, unknown>

Constructors

Constructor

new DecryptModelOperation&lt;T&gt;(
   encryptionClient, 
   item, 
   table, 
   options?): DecryptModelOperation&lt;T&gt;;

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

Parameters

encryptionClient

EncryptionClient

item

Record<string, | EncryptedValue | unknown>

table

EncryptedTable<EncryptedTableColumn>

options?

DynamoDBOperationOptions

Returns

DecryptModelOperation<T>

Overrides

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

Methods

audit()

audit(config): this;

Defined in: packages/stack/src/dynamodb/operations/base-operation.ts:32

Attach audit metadata to this operation. Can be chained.

Parameters

config

AuditConfig

Returns

this

Inherited from

DynamoDBOperation.audit

then()

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

Defined in: packages/stack/src/dynamodb/operations/base-operation.ts:54

Make the operation thenable

Type Parameters

TResult1

TResult1 = Result<Decrypted<T>, EncryptedDynamoDBError>

TResult2

TResult2 = never

Parameters

onfulfilled?

(value) => TResult1 | PromiseLike<TResult1> | null

onrejected?

(reason) => TResult2 | PromiseLike<TResult2> | null

Returns

Promise<TResult1 | TResult2>

Inherited from

DynamoDBOperation.then

execute()

execute(): Promise&lt;Result&lt;Decrypted&lt;T&gt;, EncryptedDynamoDBError>>;

Defined in: packages/stack/src/dynamodb/operations/decrypt-model.ts:32

Execute the operation and return a Result

Returns

Promise<Result<Decrypted<T>, EncryptedDynamoDBError>>

Overrides

DynamoDBOperation.execute

On this page