Утилиты

В прошлых шагах мы рассмотрели первую утилиту: функцию installRattusORM, предоставляющую плагин для Vuex.

Однако, в пакет входит ещё ряд композиций.

Композиции работают только если вы пользовались установкой через плагин. Они опираются на наличие ключа $rattusContext в вашем хранилище. Если вы хотите их использовать при ручной настройке, позаботьсесь о размещении вашей базы данных в экземпляре Vuex-хранилища.

useRattusContext

Возвращает специальный объект RattusContext, дающий доступ к управлению базами данных и получению репозиториев.

declare class RattusContext {
  $database: Database;
  $databases: Record<string, Database>;
  createDatabase(connection?: string, isPrimary?: boolean): Database;
  $repo<M extends typeof Model>(model: M, connection?: string): Repository<InstanceType<M>>;
}

useRepository

Композиция useRepository возвращает все методы класса Repository. Их можно использовать с деструктуризацией:

<script lang="ts" setup>
    const { find, save } = useRepository(User)
    const user = computed(() => find('1'))

    const onUpdate = (age: number) => {
        save({ id: user.value.id, age })
    }
</script>

Не забудьте, что полученный метод работает только с данными модели User. Для работы с другими моделями вы можете вызвать композицию ещё раз.

useRepository автоматически возвращает ComputedRef из методов find и all. Для работы с Query композиция предоставляет два метода:

query() – возвращает обычный экземпляр Query, все методы получения не оборачиваются в ComputedRef;
withQuery((query: Query) => {...}) – оборачивает результат коллбэка в ComputedRef.

Если ранее вы регистрировали кастомный репозиторий, вы можете передать его параметром в дженерик: useRepository<UserCustomRepository>(User). Все кастомные методы и свойства также будут доступны с дестркутуризацией, однако, в ComputedRef они обёрнуты не будут.