Documentation
    Preparing search index...

    Class HashProperty

    A specialized string property that automatically hashes incoming values before storing them. Useful for storing passwords, secret tokens, or generating unique fingerprints. Values set on this property are one-way hashed and cannot be reversed.

    const password = new HashProperty({
       name: 'password',
       algorithm: HashProperty.ALGORITHM_SHA256,
       salt: 'mySecretSalt'
    });

    password.set('mySuperPassword');
    console.log(password.val()); // Returns the SHA256 hashed string
    const isValid = password.compare('mySuperPassword'); // true

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _algorithm _allows _defaultValue _events _fullSearch _hasChanged _htmlType _id _mandatory _maxLength _minLength _name _parent _prefixed _protected _rawValue _salt _value ALGORITHM_BCRYPT ALGORITHM_MD5 ALGORITHM_SHA1 ALGORITHM_SHA256 ALLOW_DIGITS ALLOW_LETTERS ALLOW_NUMBERS ALLOW_SPACES ALLOW_STRINGS EVENT_ONCHANGE EVENT_ONDELETE TRANSFORM_LCASE TRANSFORM_UCASE TYPE

    Accessors

    allows fullSearch hasChanged htmlType mandatory maxLength minLength name protected

    Methods

    _enable _hash clone compare get set toJSON val

    Constructors

    Properties

    Protected_algorithm

    _algorithm: string

    Protected_allows

    _allows: string[] = []

    Protected_defaultValue

    _defaultValue: any

    Protected_events

    _events: { [key: string]: Function } = {}

    Protected_fullSearch

    _fullSearch: boolean = false

    Protected_hasChanged

    _hasChanged: boolean

    Protected_htmlType

    _htmlType: PropertyHTMLType = 'off'

    Protected_id

    _id: string

    Protected_mandatory

    _mandatory: boolean = false

    Protected_maxLength

    _maxLength: number = 0

    Protected_minLength

    _minLength: number = 0

    Protected_name

    _name: string

    Protected_parent

    _parent: DataObjectClass<any> | undefined

    Protected_prefixed

    _prefixed: boolean = false

    Protected_protected

    _protected: boolean = false

    Protected_rawValue

    _rawValue: boolean = true

    Set to false to bypass some rules

    Protected_salt

    _salt: string = ''

    Protected_value

    _value: string | undefined
    ALGORITHM_BCRYPT: string = 'bcrypt'

    Identifier for the BCRYPT hashing algorithm.

    ALGORITHM_MD5: string = 'md5'

    Identifier for the MD5 hashing algorithm.

    ALGORITHM_SHA1: string = 'sha1'

    Identifier for the SHA1 hashing algorithm.

    ALGORITHM_SHA256: string = 'sha256'

    Identifier for the SHA256 hashing algorithm.

    ALLOW_DIGITS: string = 'digits'

    Permission flag to allow numeric digits.

    ALLOW_LETTERS: string = 'letters'

    Permission flag to allow alphabetic letters.

    ALLOW_NUMBERS: string = 'numbers'

    Permission flag to allow number values.

    ALLOW_SPACES: string = 'spaces'

    Permission flag to allow whitespace characters.

    ALLOW_STRINGS: string = 'strings'

    Permission flag to allow string values.

    EVENT_ONCHANGE: string = 'onChange'

    Event name triggered when the property value changes.

    EVENT_ONDELETE: string = 'onDelete'

    Event name triggered when the property is deleted.

    TRANSFORM_LCASE: string = 'lower'

    Transformation identifier to convert string to lowercase.

    TRANSFORM_UCASE: string = 'upper'

    Transformation identifier to convert string to uppercase.

    TYPE: string = 'hash'

    The string literal type identifier for this property.

    Accessors

    • get allows(): string[]

      Returns string[]

    • get fullSearch(): boolean

      Returns boolean

    • set fullSearch(mode: boolean): void

      Parameters

      • mode: boolean

      Returns void

    • get hasChanged(): boolean

      Returns boolean

    • set hasChanged(val: boolean): void

      Parameters

      • val: boolean

      Returns void

    • get htmlType(): PropertyHTMLType

      Returns PropertyHTMLType

    • set htmlType(type: PropertyHTMLType): void

      Parameters

      Returns void

    • get mandatory(): boolean

      Returns boolean

    • get maxLength(): number

      Returns number

    • set maxLength(max: number): void

      Parameters

      • max: number

      Returns void

    • get minLength(): number

      Returns number

    • set minLength(min: number): void

      Parameters

      • min: number

      Returns void

    • get name(): string

      Returns string

    • get protected(): boolean

      Returns boolean

    Methods

    Protected_enable

    • _enable(value: boolean | undefined): value is true | undefined

      Parameters

      • value: boolean | undefined

      Returns value is true | undefined

    _hash

    • _hash(value: string): string

      Internal method to perform the cryptographic hash on a raw string. Uses Node.js native crypto module.

      Parameters

      • value: string

        The raw string to hash.

      Returns string

      The hexadecimal representation of the hashed string.

      If the chosen algorithm is unsupported.

    • Creates a deep clone of the current property instance, preserving its prototype chain.

      Returns any

      A new independent instance of the property.

    • Compares a raw cleartext string against the stored hashed value. Automatically applies the configured salt and algorithm to the input before comparison.

      Parameters

      • value: string

        The raw cleartext string to test.

      Returns boolean

      True if the hashed input matches the stored hash, false otherwise.

    • Retrieves the string value, optionally applying a casing transformation.

      Parameters

      • transform: string | undefined = undefined

        Use TRANSFORM_LCASE or TRANSFORM_UCASE to mutate output case.

      Returns string | undefined

      The raw or transformed string, or undefined.

    • Hashes the provided value and stores the hashed result. String length constraints (from StringProperty) are bypassed after hashing.

      Parameters

      • value: string

        The raw cleartext string to hash and store.

      • setChanged: boolean = true

        Whether to mark the property as modified.

      Returns HashProperty

      The property instance for chaining.

    • Serializes the property for JSON stringification.

      Returns any

      The raw internal value of the property.

    • Retrieves the current value of the property, or its default value if currently undefined.

      Parameters

      • transform: any = undefined

        An optional transformation function applied to the value before returning it.

      Returns any

      The raw or transformed property value.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods