prorm API Reference
    Preparing search index...

    Interface SecureOptions

    Options for the

    / SecureField decorator.

    interface SecureOptions {
        adapter?: EncryptionAdapter;
        skipIfHashed?: boolean;
        algorithm?: string;
    }
    Index
    adapter? skipIfHashed? algorithm?
    adapter?: EncryptionAdapter

    The adapter to use for this specific field. Overrides the global adapter set via setEncryptionAdapter().

    skipIfHashed?: boolean

    If true, the field will only be hashed when the value has changed (i.e. it does not look like a hash already). Default: true.

    algorithm?: string

    Optional algorithm label for documentation / metadata purposes. Has no functional effect — it just marks the intended algorithm. Example: 'bcrypt', 'argon2id', 'scrypt'

    Settings
    Member Visibility

    On This Page
    Properties