Velo Types (Corvid)

TypeScript type definitions for Velo APIs

👩🏻‍💻 Type Declarations: provides Typescript type declarations depending on the Wix editor context.

🏃🏽 Intellisense: Intellisense autocompletions for the Wix code editor.

Table of Contents

• Introduction
• Getting Started

Introduction

This package contains type definitions for Velo by Wix.

It exposes the following:

• declarations: type declarations for different contexts: page, backend or public.
• getWixModulesList: returns a list of wix modules for autocompletion purposes. See full list of modules here.
• eventHandlersService: the service provides meta-data about components' event handlers
• getPageElementsTypeDeclarations: returns the types of elements that are currently on the Wix editor page. Used to provide TS autocompletion.
• getPackageTypeDecelerations: returns types for packages installed via NPM. Used to provide autocompletion.

Getting Started

Install by running:

npm install corvid-types