Installation

• For Forge Node.js client SDK: npm install --save-dev @types/forge-apis
• For Forge Viewer.js: npm install --save-dev @types/forge-viewer

Usage

After installing the definitions, there's no need to explicitly reference them if you use TypeScript >= 2.0 and ES6 modules - the transpiler will look for the definitions (so long as the typeRoots contains node_modules/@types) when you import the dependencies as ES6 modules.

You can install the type definitions separately without the Forge Node.js SDK, just in case you do not require the SDK client or you just need the typings for Viewer.js. See below for steps to manually reference the definitions.

• Prerequisites

  Install the type definitions for THREE.js. If you'd like to reference this dependency by path instead of global types, change the reference comments in your Viewer.js definitions: path/to/Forge-viewer/index.d.ts.

• TypeScript 2.*

  If you have installed the types using NPM, to tell your transpiler to look for the type definitions of this package, specify the below in your tsconfig.json:

  {
    "typeRoots": ["node_modules/@types"],
    "types": ["forge-viewer", "yourOtherTypes"]
  }

  Otherwise specify the path to our definitions in your tsconfig.json:

  "files": [    
    "path/to/forge-viewer/index.d.ts"
  ]

• TypeScript >= 1.5

  To tell your transpiler to look for the type definitions of this package, specify the below in your tsconfig.json:

  {
    "compilerOptions": {
      ...
    },
    "include": [
       "path/to/forge-viewer/index.d.ts"
   ]
  }

• All TypeScript Versions (Ignore this if you have done any of the above)

  Add reference comments at the top of your script:

  /// <reference path="path/to/forge-apis/index.d.ts" />

Publishing

1. Follow the project structure below:

File	Purpose
index.d.ts	This indexes the type definitions of this package.
forge-apis-tests.ts	This contains sample code which tests the typings. This code does not run, but it is type-checked.
tsconfig.json	This allows you to run tsc within the package.
tslint.json	Enables linting.
src/*.d.ts	Type definitions.
README.md	This file *but be sure to follow the template below

2. Make sure README.md follow the template here
3. Fork DefinitelyTyped
4. Commit the project to DefinitelyTyped/types/forge-apis and make a PR to DefinitelyTyped
5. After the PR is merged, the typings will be available as @types/forge-apis

See details at https://github.com/DefinitelyTyped/DefinitelyTyped#make-a-pull-request

Contents

This package contains type definitions for the following:

• Forge-apis: TypeScript 2.x definitions for the Forge Node.js client SDK
• Forge-viewer: TypeScript 2.x definitions for the Forge Viewer.js

Credits

Forge Partner Development