Reading the Docs

This page acts as an introduction to the Prisma Util API Documentation. Due to the amount of features, we have decided to release a guide to understanding the docs.

Welcome!

Welcome to the official Prisma Util API Documentation. The scope of this page is to provide an introduction to how the API Documentation is structed and how you can understand it better.

Required Knowledge

This API Documentation will use the definitions on this page for reference, with their explanations provided for a better developer experience when configuring Prisma Util. Before proceeding with reading this documentation, we highly recommend that you get familiar with all of the concepts, as they are the base to understanding and mastering this tool.

Definitions

Project Root - We define project root as the current working directory of your terminal.

Structure

The API Documentation is structured in 3 parts:

Types & Objects

The Types & Objects page provides definitions for all types used across documentation pages, including those of optional modules and configuration.

Command Reference

The Command Reference page shows the usage of all commands that can be used with Prisma Util CLI, as well as the modifications to the normal Prisma CLI.

Configuration Reference

The Configuration Reference page provides an in-depth explanation for each configuration option inside Prisma Util. This page is by far the most important one, because the configuration file acts as the hub for your Prisma Util experience.

Investigating Types

Prisma Util defines its own types for configuration field. Those fields are marked with blue and are clickable. When you click a type colored in blue, you are sent to the page showing the definition of that type. This way, you can make sure that you are configuring your project properly.