Browse Source

readme and d.ts correction

Raanan Weber 7 years ago
parent
commit
d926ab16a8

+ 8 - 8
dist/preview release/viewer/babylon.viewer.module.d.ts

@@ -1,4 +1,4 @@
-/// <reference path="./babylonjsd.ts"/>
+/// <reference path="./babylon.d.ts"/>
 
 
 declare module "babylonjs-viewer" {
 declare module "babylonjs-viewer" {
     export = BabylonViewer;
     export = BabylonViewer;
@@ -60,7 +60,7 @@ declare module BabylonViewer {
         selector: string;
         selector: string;
         payload?: any;
         payload?: any;
     }
     }
-    class TemplateManager {
+    interface TemplateManager {
         containerElement: HTMLElement;
         containerElement: HTMLElement;
         onInit: BABYLON.Observable<Template>;
         onInit: BABYLON.Observable<Template>;
         onLoaded: BABYLON.Observable<Template>;
         onLoaded: BABYLON.Observable<Template>;
@@ -79,7 +79,7 @@ declare module BabylonViewer {
         private checkLoadedState();
         private checkLoadedState();
     }
     }
 
 
-    class Template {
+    interface Template {
         name: string;
         name: string;
         private _configuration;
         private _configuration;
         onInit: BABYLON.Observable<Template>;
         onInit: BABYLON.Observable<Template>;
@@ -102,7 +102,7 @@ declare module BabylonViewer {
         private registerEvents();
         private registerEvents();
     }
     }
 
 
-    class ViewerManager {
+    interface ViewerManager {
         private viewers;
         private viewers;
         onViewerAdded: (viewer: AbstractViewer) => void;
         onViewerAdded: (viewer: AbstractViewer) => void;
         onViewerAddedObservable: BABYLON.Observable<AbstractViewer>;
         onViewerAddedObservable: BABYLON.Observable<AbstractViewer>;
@@ -123,7 +123,7 @@ declare module BabylonViewer {
 
 
     export function InitTags(selector?: string): void;
     export function InitTags(selector?: string): void;
 
 
-    class EventManager {
+    interface EventManager {
         private templateManager;
         private templateManager;
         private callbacksContainer;
         private callbacksContainer;
         constructor(templateManager: TemplateManager);
         constructor(templateManager: TemplateManager);
@@ -132,14 +132,14 @@ declare module BabylonViewer {
         private eventTriggered(data);
         private eventTriggered(data);
     }
     }
 
 
-    class PromiseObservable<T> extends BABYLON.Observable<T> {
+    interface PromiseObservable<T> extends BABYLON.Observable<T> {
         notifyWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<any>;
         notifyWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<any>;
     }
     }
 
 
     export interface IMapper {
     export interface IMapper {
         map(rawSource: any): ViewerConfiguration;
         map(rawSource: any): ViewerConfiguration;
     }
     }
-    class MapperManager {
+    interface MapperManager {
         private mappers;
         private mappers;
         static DefaultMapper: string;
         static DefaultMapper: string;
         constructor();
         constructor();
@@ -148,7 +148,7 @@ declare module BabylonViewer {
     }
     }
     export let mapperManager: MapperManager;
     export let mapperManager: MapperManager;
 
 
-    class ConfigurationLoader {
+    interface ConfigurationLoader {
         private configurationCache;
         private configurationCache;
         constructor();
         constructor();
         loadConfiguration(initConfig?: ViewerConfiguration): Promise<ViewerConfiguration>;
         loadConfiguration(initConfig?: ViewerConfiguration): Promise<ViewerConfiguration>;

+ 13 - 0
dist/preview release/viewer/readme.md

@@ -54,3 +54,16 @@ import from 'babylonjs-viewer';
 This will enable the BabylonViewer namespace.
 This will enable the BabylonViewer namespace.
 
 
 Using webpack to package your project will use the minified js file.
 Using webpack to package your project will use the minified js file.
+
+## TypeScript
+
+If you use the npm package, starting 3.2.0-alpha8 the babylon viewer has a module declaration file that also includes the BABYLON namespace.
+
+Using TypeScript and NPM you could do the following:
+
+```javascript
+import from 'babylonjs-viewer';
+
+// both namespaces are now available
+console.log(BabylonViewer, BABYLON)
+```