@cipherstash/stack

Class: EncryptedField

Defined in: .tmp-stack/packages/stack/src/schema/index.ts:139

Builder for a nested encrypted field (encrypted but not searchable). Create with encryptedField. Use inside nested objects in encryptedTable; supports .dataType() for plaintext type. No index methods (equality, orderAndRange, etc.).

Constructors

Constructor

new EncryptedField(valueName): EncryptedField;

Defined in: .tmp-stack/packages/stack/src/schema/index.ts:143

Parameters

valueName

string

Returns

EncryptedField

Methods

dataType()

dataType(castAs): EncryptedField;

Defined in: .tmp-stack/packages/stack/src/schema/index.ts:165

Set or override the plaintext data type for this field.

By default all values are treated as 'string'. Use this method to specify a different type so the encryption layer knows how to encode the plaintext before encrypting.

Parameters

castAs

The plaintext data type: 'string', 'number', 'boolean', 'date', 'text', 'bigint', or 'json'.

"string" | "number" | "bigint" | "boolean" | "date" | "json" | "text"

Returns

EncryptedField

This EncryptedField instance for method chaining.

Example

import { encryptedField } from "@cipherstash/stack/schema"

const age = encryptedField("age").dataType("number")

build()

build(): {
  cast_as: "number" | "bigint" | "boolean" | "date" | "json" | "text";
  indexes: {
  };
};

Defined in: .tmp-stack/packages/stack/src/schema/index.ts:170

Returns

{
  cast_as: "number" | "bigint" | "boolean" | "date" | "json" | "text";
  indexes: {
  };
}

cast_as

cast_as: "number" | "bigint" | "boolean" | "date" | "json" | "text";

indexes

indexes: {
} = {};

getName()

getName(): string;

Defined in: .tmp-stack/packages/stack/src/schema/index.ts:177

Returns

string