$ rezi

API Reference

The complete API reference is generated from TypeScript sources using TypeDoc.

The complete API reference is generated from TypeScript sources using TypeDoc.

Viewing the API Reference

Online

The hosted API reference is available at the documentation site under /api/reference/.

Local Build

Generate the API documentation locally:

npm run docs:api

The output is written to out/typedoc/index.html.

Alternatively, build the complete documentation site:

npm run docs:build

The API reference is included at out/site/api/reference/index.html.

Quick Reference

For the most common APIs, see:

create-rezi

create-rezi is the CLI package that scaffolds new Rezi apps.

Contributing

Rezi welcomes issues and pull requests. This page summarizes the local workflow; see the linked guides for details.

On this page

Viewing the API ReferenceOnlineLocal BuildQuick Reference