Interface PasswordField

PasswordField defines "password" type field for storing bcrypt hashed strings (usually used only internally for the "password" auth collection system field).

If you want to set a direct bcrypt hash as record field value you can use the SetRaw method, for example:

  // generates a bcrypt hash of "123456" and set it as field value
  // (record.GetString("password") returns the plain password until persisted, otherwise empty string)
  record.Set("password", "123456")

  // set directly a bcrypt hash of "123456" as field value
  // (record.GetString("password") returns empty string)
  record.SetRaw("password", "$2a$10$.5Elh8fgxypNUWhpUUr/xOa2sZm0VIaE0qWuGGl9otUfobb46T1Pq")

The following additional getter keys are available:

  - "fieldName:hash" - returns the bcrypt hash string of the record field value (if any). For example:
    record.GetString("password:hash")

Hierarchy

Implemented by

Methods

columnType driverValue findGetter findSetter getHidden getId getName getSystem intercept prepareValue setHidden setId setName setSystem type validateSettings validateValue

Properties

cost hidden id max min name pattern presentable required system

Methods

columnType

  • ColumnType implements [Field.ColumnType] interface method.

    Parameters

    Returns string

driverValue

  • DriverValue implements the [DriverValuer] interface.

    Parameters

    Returns any

findGetter

findSetter

getHidden

  • GetHidden implements [Field.GetHidden] interface method.

    Returns boolean

getId

  • GetId implements [Field.GetId] interface method.

    Returns string

getName

  • GetName implements [Field.GetName] interface method.

    Returns string

getSystem

  • GetSystem implements [Field.GetSystem] interface method.

    Returns boolean

intercept

  • Intercept implements the [RecordInterceptor] interface.

    Parameters

    Returns void

prepareValue

  • PrepareValue implements [Field.PrepareValue] interface method.

    Parameters

    Returns any

setHidden

  • SetHidden implements [Field.SetHidden] interface method.

    Parameters

    • hidden: boolean

    Returns void

setId

  • SetId implements [Field.SetId] interface method.

    Parameters

    • id: string

    Returns void

setName

  • SetName implements [Field.SetName] interface method.

    Parameters

    • name: string

    Returns void

setSystem

  • SetSystem implements [Field.SetSystem] interface method.

    Parameters

    • system: boolean

    Returns void

type

  • Type implements [Field.Type] interface method.

    Returns string

validateSettings

validateValue

Properties

cost

cost: number

Cost specifies the cost/weight/iteration/etc. bcrypt factor.

If zero, fallback to [bcrypt.DefaultCost].

If explicitly set, must be between [bcrypt.MinCost] and [bcrypt.MaxCost].

hidden

hidden: boolean

Hidden hides the field from the API response.

id

id: string

Id is the unique stable field identifier.

It is automatically generated from the name when adding to a collection FieldsList.

max

max: number

Max specifies an optional required field string length.

If zero, fallback to max 71 bytes.

min

min: number

Min specifies an optional required field string length.

name

name: string

Name (required) is the unique name of the field.

pattern

pattern: string

Pattern specifies an optional regex pattern to match against the field value.

Leave it empty to skip the pattern check.

presentable

presentable: boolean

Presentable hints the Dashboard UI to use the underlying field record value in the relation preview label.

required

required: boolean

Required will require the field value to be non-empty string.

system

system: boolean

System prevents the renaming and removal of the field.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc