WarpJS SDK Documentation | The JavaScript Full Stack Suite

WarpJS SDK Documentation | The JavaScript Full Stack Suite

›API Reference

Getting Started

  • Quick Start

JavaScript Virtual Cloud

  • JavaScript Virtual Cloud Introduction
  • Unified developer workflow
  • WarpJS SDK Installation
  • Build, run and develop warped modules
  • Deploy warped modules
  • Deploy static public assets
  • Glossary

Use a warped module

  • From browser using HTML
  • From browser using a builder
  • From Node.js
  • Frameworks integration

API Reference

  • Requirements
  • CLI
  • Configuration file
  • Engine
  • Infrastructure support

WarpJS engine

Npm module

@warpjs/engine

https://www.npmjs.com/package/@warpjs/engine

Import

To use a WarpJS client in the JavaScript client, you have to import WarpJS engine first. The engine has to be initialize just once.

CommonJS (CJS)

require("@warpjs/engine");

ES Modules (ESM)

import "@warpjs/engine";

HTML script tag

Include the WarpJS engine directly in an HTML file:

<script src="https://cdn.scaledynamics.com/warp-engine/4.0.4/engine-web-prod.js" type="text/javascript"></script>

Pay attention to using the same engine version that you use to develop the Node.js server part. Please change the version in the CDN url. Find current version of WarpJS thanks to the npx warp version command.

← Configuration fileInfrastructure support →
  • Npm module
  • Import
    • CommonJS (CJS)
    • ES Modules (ESM)
    • HTML script tag
WarpJS SDK Documentation | The JavaScript Full Stack Suite
Docs
Getting StartedAPI Reference
WarpJS
WebsiteTwitterLinkedIn
More
npmGitHubAbout Us
© ScaleDynamics - 2021