CipherStashDocs
StackLatestPackagesStackSrcEncryptionClasses

BatchEncryptQueryOperation

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

@cipherstash/stack


Class: BatchEncryptQueryOperation

Defined in: packages/stack/src/encryption/operations/batch-encrypt-query.ts:94

Extends

Constructors

Constructor

new BatchEncryptQueryOperation(client, terms): BatchEncryptQueryOperation;

Defined in: packages/stack/src/encryption/operations/batch-encrypt-query.ts:97

Parameters

client

Client

terms

readonly ScalarQueryTerm[]

Returns

BatchEncryptQueryOperation

Overrides

EncryptionOperation<
  EncryptedQueryResult[]
>.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<EncryptedQueryResult[], 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): BatchEncryptQueryOperationWithLockContext;

Defined in: packages/stack/src/encryption/operations/batch-encrypt-query.ts:104

Parameters

lockContext

LockContext

Returns

BatchEncryptQueryOperationWithLockContext


execute()

execute(): Promise&lt;Result&lt;EncryptedQueryResult[], EncryptionError&gt;>;

Defined in: packages/stack/src/encryption/operations/batch-encrypt-query.ts:115

Execute the operation and return a Result

Returns

Promise<Result<EncryptedQueryResult[], EncryptionError>>

Overrides

EncryptionOperation.execute

On this page