Class Decorators<TD, T>

AfterCreate decorator

class User {
  @deco.AfterCreate()
  public doSomething() {
    console.log('hi!')
  }
}
Copy

AfterCreateCommit decorator

class User {
  @deco.AfterCreateCommit()
  public doSomething() {
    console.log('hi!')
  }
}
Copy

AfterDestroy decorator

class User {
  @deco.AfterDestroy()
  public doSomething() {
    console.log('hi!')
  }
}
Copy

AfterDestroyCommit decorator

class User {
  @deco.AfterDestroyCommit()
  public doSomething() {
    console.log('hi!')
  }
}
Copy

AfterSave decorator

class User {
  @deco.AfterSave()
  public doSomething() {
    console.log('hi!')
  }
}
Copy

AfterSaveCommit decorator

class User {
  @deco.AfterSaveCommit()
  public doSomething() {
    console.log('hi!')
  }
}
Copy

AfterUpdate decorator

class User {
  @deco.AfterUpdate()
  public doSomething() {
    console.log('hi!')
  }
}
Copy

AfterUpdateCommit decorator

class User {
  @deco.AfterUpdateCommit()
  public doSomething() {
    console.log('hi!')
  }
}
Copy

BeforeCreate decorator

class User {
  @deco.BeforeCreate()
  public doSomething() {
    console.log('hi!')
  }
}
Copy

BeforeDestroy decorator

class User {
  @deco.BeforeDestroy()
  public doSomething() {
    console.log('hi!')
  }
}
Copy

BeforeSave decorator

class User {
  @deco.BeforeSave()
  public doSomething() {
    console.log('hi!')
  }
}
Copy

BeforeUpdate decorator

class User {
  @deco.BeforeUpdate()
  public doSomething() {
    console.log('hi!')
  }
}
Copy

The Encrypted decorator automatically encrypts (upon setting) and decrypts (upon getting) so that the encrypted value is stored in the database.

class User {
  @deco.Encrypted()
  // automatically sets `encryptedSsn` to the encrypted value that
  // `ssn` is set to in new/create/update, e.g., `await user.update({ ssn })`
  public ssn: string

  // automatically sets `myEncryptedPhone` to the encrypted value that
  // `phone` is set to new/create/update, e.g., `await user.update({ phone })`
  @deco.Encrypted('myEncryptedPhone)
  public phone: string
}
Copy

The Scope decorator decorates a static method that accepts and returns a Dream Query.

class Collar {
  @deco.Scope({ default: true })
  public static hideHiddenCollars(query: Query<Collar>) {
    return query.where({ hidden: false })
  }
}
Copy

The Sortable decorator automatically adjusts the value of the columns corresponding to the decorated field.

NOTE: the Sortable decorator may not be used in STI child models (it may be used in the STI base class)

class Balloon {
  @deco.Sortable({ scope: 'user' })
  public position: DreamColumn<Balloon, 'position'>
}
Copy

The Validate decorator decorates a method to run before saving a model to the database.

class Sandbag {
  @deco.Validate()
  public validateWeight(this: Sandbag) {
    if (!this.weight) return

    const undefinedOrNull: any[] = [undefined, null]
    if (!undefinedOrNull.includes(this.weightKgs))
      this.addError('weight', 'cannot include weightKgs AND weight')
    if (!undefinedOrNull.includes(this.weightTons))
      this.addError('weight', 'cannot include weightTons AND weight')
  }
}
Copy

The Validates decorator decorates a field to validate according to the specified validator and options.

class Balloon {
  @deco.Validates('numericality', { min: 0, max: 100 })
  public volume: DreamColumn<Balloon, 'volume'>
}
Copy

The Virtual decorator enables setting of fields as if they corresponded to columns in the model's table so they can be passed to new, create, and update.

For example, in the first example, below, one could call await bodyMeasurement.update({ lbs 180.1 }), and 180.1 will be passed into the lbs setter, which then translates lbs to grams to be stored in the grams column in the metrics table.

And in the second example, below, one could call await user.update({ password }), and, in the BeforeSave lifecycle hook, the password would be hashed into hashedPassword. (This is just an example to illustrate using the Virtual decorator on a simple field; it might be better design to use the getter/setter pattern for password, with the getter simply returning undefined.)

class BodyMeasurement {
  @deco.Virtual('number')
  public get lbs() {
    const self: User = this
    return gramsToLbs(self.getAttribute('grams') ?? 0)
  }

  public set lbs(lbs: number) {
    const self: User = this
    self.setAttribute('grams', lbsToGrams(lbs))
  }

  @deco.Virtual('number')
  public get kilograms() {
    const self: User = this
    return gramsToKilograms(self.getAttribute('grams') ?? 0)
  }

  public set kilograms(kg: number) {
    const self: User = this
    self.setAttribute('grams', kilogramsToGrams(kg))
  }
}
Copy

class User {
  @deco.Virtual('string')
  public password: string

  @deco.BeforeSave()
  public hasPassword() {
    this.setAttribute('hashedPassword', preferredHashingAlgorithm(this.password))
  }
}
Copy