CipherStashDocs
StackLatestPackagesStackSrcEncryptionClasses

EncryptOperation

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

@cipherstash/stack


Class: EncryptOperation

Defined in: packages/stack/src/encryption/operations/encrypt.ts:20

Extends

Constructors

Constructor

new EncryptOperation(
   client, 
   plaintext, 
   opts): EncryptOperation;

Defined in: packages/stack/src/encryption/operations/encrypt.ts:30

Parameters

client

Client

plaintext

JsPlaintext | null

opts

EncryptOptions

Returns

EncryptOperation

Overrides

EncryptionOperation<Encrypted>.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<Encrypted, 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): EncryptOperationWithLockContext;

Defined in: packages/stack/src/encryption/operations/encrypt.ts:42

Parameters

lockContext

LockContext

Returns

EncryptOperationWithLockContext


execute()

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

Defined in: packages/stack/src/encryption/operations/encrypt.ts:48

Execute the operation and return a Result

Returns

Promise<Result<Encrypted, EncryptionError>>

Overrides

EncryptionOperation.execute

getOperation()

getOperation(): {
  client: Client;
  plaintext: JsPlaintext | null;
  column:   | EncryptedColumn
     | EncryptedField;
  table: EncryptedTable&lt;EncryptedTableColumn&gt;;
};

Defined in: packages/stack/src/encryption/operations/encrypt.ts:109

Returns

{
  client: Client;
  plaintext: JsPlaintext | null;
  column:   | EncryptedColumn
     | EncryptedField;
  table: EncryptedTable&lt;EncryptedTableColumn&gt;;
}
client
client: Client;
plaintext
plaintext: JsPlaintext | null;
column
column: 
  | EncryptedColumn
  | EncryptedField;
table
table: EncryptedTable&lt;EncryptedTableColumn&gt;;

On this page