Client module formats

Output format

Warp supports several formats to generate the JavaScript client:

umd

Universal Module Definition (UMD) is capable of working everywhere, be it in the client, on the server or elsewhere.

It can be useful to import the client with an HTML <script> tag.

Import example

After generating a umd module, it can be imported in:

  • JavaScript
import MicroService from './umd_module.js'
  • Node.js
const MicroService = require('./umd_module.js')
  • HTML
<script src="umd_module.js"></script>

CLI example

npx warp build --output umd:./client/src/module-client.js ./server

Config example

output: {
  format: "umd",
  filePath: "../client/src/functions.js",
  name: "outputname",
},

node-module

Use it to generate a npm module with its package.json.

The path has to be the target directory containing the node_modules directory.

CLI example

npx warp build --output node-module:./client/ ./server

Config example

output: {
  format: "node-module",
  projectPath: "../client",
  name: "outputname",
},
← Engine