CipherStashDocs
StackLatestPackagesStackSrcEncryptionClasses

BulkDecryptOperation

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

@cipherstash/stack


Class: BulkDecryptOperation

Defined in: packages/stack/src/encryption/operations/bulk-decrypt.ts:57

Extends

Constructors

Constructor

new BulkDecryptOperation(client, encryptedPayloads): BulkDecryptOperation;

Defined in: packages/stack/src/encryption/operations/bulk-decrypt.ts:61

Parameters

client

Client

encryptedPayloads

BulkDecryptPayload

Returns

BulkDecryptOperation

Overrides

EncryptionOperation<BulkDecryptedData>.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<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<BulkDecryptedData, 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): BulkDecryptOperationWithLockContext;

Defined in: packages/stack/src/encryption/operations/bulk-decrypt.ts:67

Parameters

lockContext

LockContext

Returns

BulkDecryptOperationWithLockContext


execute()

execute(): Promise&lt;Result&lt;BulkDecryptedData, EncryptionError&gt;>;

Defined in: packages/stack/src/encryption/operations/bulk-decrypt.ts:73

Execute the operation and return a Result

Returns

Promise<Result<BulkDecryptedData, EncryptionError>>

Overrides

EncryptionOperation.execute

getOperation()

getOperation(): {
  client: Client;
  encryptedPayloads: BulkDecryptPayload;
};

Defined in: packages/stack/src/encryption/operations/bulk-decrypt.ts:115

Returns

{
  client: Client;
  encryptedPayloads: BulkDecryptPayload;
}
client
client: Client;
encryptedPayloads
encryptedPayloads: BulkDecryptPayload;

On this page