Forge Developer

Beta

Forge Developer

Beta

Rate this page:

JavaScript API

The JavaScript API is a set of APIs that provide additional functionality to the Forge platform. You can use these APIs to interact with REST endpoints and to store data.

Before you begin

To access APIs from your Forge app, first install the latest API package by running:

1
npm install @forge/api

This package will enable the use of the following APIs:

Standard globals

Process

The global process object is a partial implementation of the Node JS process.

Object signature

1
process

Fields

KeyValue
platformforge
envSee Environments.
versionThe underlying Node JS version.

Example:
process.version // 12.14.1
versionsVersions of runtime dependencies.

Example:
{ forge: 'forge:47', node: '12.14.1' }
nextTickA polyfill of Node JS nextTick.

Rate this page: