scopes

The scoping system will be familiar to those coming from the Ruby on Rails camp, but for those who are new to this, our design was inspired by the Ruby on Rails scope pattern, and can be used to elegantly capture recurring query behavior into partialized functions which can then be applied to your quieries, enabling your complex statements to be replaced with beautiful business logic.

All scope functions receive a Query<ClassName> (where ClassName is the name of the Dream class defining the Scope) instance and return a clone of that instance (usually by calling where on that instance).

export default class Post extends Dream {
  public readonly get table() {
    return 'posts' as const
  }

  public name: string
  ...

  @Scope()
  public static withFunnyName(query: Query<Post>) {
    return query.where({ name: 'Chalupas jr' })
  }
}

const posts = await Post.scope('withFunnyName').all()

default scopes

While regular scopes are meant to be applied manually, default scopes will automatically be applied to all queries. This behavior should be used sparingly, but there are occasionally pretty good cases for it, as seen below, emulating the Ruby on Rails paranoid gem pattern.

export default class Post extends Dream {
  public readonly get table() {
    return 'posts' as const
  }

  public name: string
  ...

  @Scope({ default: true })
  public static hideDeleted(query: Query<Post>) {
    return query.where({ deletedAt: null })
  }
}