CipherStashDocs
StackLatestPackagesStackSrcEncryptionClasses

BulkEncryptOperation

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

@cipherstash/stack


Class: BulkEncryptOperation

Defined in: packages/stack/src/encryption/operations/bulk-encrypt.ts:64

Extends

Constructors

Constructor

new BulkEncryptOperation(
   client, 
   plaintexts, 
   opts): BulkEncryptOperation;

Defined in: packages/stack/src/encryption/operations/bulk-encrypt.ts:70

Parameters

client

Client

plaintexts

BulkEncryptPayload

opts

EncryptOptions

Returns

BulkEncryptOperation

Overrides

EncryptionOperation<BulkEncryptedData>.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<BulkEncryptedData, 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): BulkEncryptOperationWithLockContext;

Defined in: packages/stack/src/encryption/operations/bulk-encrypt.ts:82

Parameters

lockContext

LockContext

Returns

BulkEncryptOperationWithLockContext


execute()

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

Defined in: packages/stack/src/encryption/operations/bulk-encrypt.ts:88

Execute the operation and return a Result

Returns

Promise<Result<BulkEncryptedData, EncryptionError>>

Overrides

EncryptionOperation.execute

getOperation()

getOperation(): {
  client: Client;
  plaintexts: BulkEncryptPayload;
  column:   | EncryptedColumn
     | EncryptedField;
  table: EncryptedTable&lt;EncryptedTableColumn&gt;;
};

Defined in: packages/stack/src/encryption/operations/bulk-encrypt.ts:139

Returns

{
  client: Client;
  plaintexts: BulkEncryptPayload;
  column:   | EncryptedColumn
     | EncryptedField;
  table: EncryptedTable&lt;EncryptedTableColumn&gt;;
}
client
client: Client;
plaintexts
plaintexts: BulkEncryptPayload;
column
column: 
  | EncryptedColumn
  | EncryptedField;
table
table: EncryptedTable&lt;EncryptedTableColumn&gt;;

On this page