Aquiver Module

Installation

Install the required server, client and shared packages, then select your framework and database resource.

info

This module is intended for developers and provides framework-compatible functions for Aquiver resources.

Supported integrations

✓

ESX Legacy

Supported framework integration.

✓

QBCore

Supported framework integration.

✓

oxmysql

Supported MySQL resource.

✓

mysql-async

Supported MySQL resource.

Custom SQL resources

The module does not currently support custom SQL resources.

Installation steps

1. 01

   Install the packages

   Install the packages required by the server, client and shared parts of your resource.

2. 02

   Import the module

   Import the appropriate Aquiver package in your TypeScript source.

3. 03

   Select the integrations

   Set the framework and SQL resource through Aquiver.Config.

Configuration

Install packages

Choose the package required by each part of your resource.

Server

Server package

npm i @aquiversdk/server

Client

Client package

npm i @aquiversdk/client -D

Shared

Shared package

npm i @aquiversdk/shared -D

Basic configuration

IDE type checking

When using an IDE, type Aquiver.Config to access the available typed configuration options.

Configuration

Server configuration

Import the server package and select the framework and SQL resource.

TypeScript server example

import * as Aquiver from "@aquiversdk/server";

Aquiver.Config.Framework = "ESX_LEGACY";
Aquiver.Config.sqlResource = "oxmysql";