@openfin/core 33.76.27 → 33.76.36

package/src/api/window/Factory.d.ts

@@ -1,44 +1,95 @@
 import type * as OpenFin from '../../OpenFin';
 import { Base } from '../base';
-/**
- * @lends Window
- */
 export default class _WindowModule extends Base {
     /**
      * Asynchronously returns a Window object that represents an existing window.
-     * @param { Identity } identity
-     * @return {Promise.<_Window>}
-     * @tutorial Window.wrap
+     * @param identity
+     *
+     * @example
+     * ```js
+     * async function createWin() {
+     *     const app = await fin.Application.start({
+     *         name: 'myApp',
+     *         uuid: 'app-1',
+     *         url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
+     *         autoShow: true
+     *     });
+     *     return await app.getWindow();
+     * }
+     * createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
+     * .then(win => console.log('wrapped window'))
+     * .catch(err => console.log(err));
+     * ```
      * @static
      */
     wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
     /**
      * Synchronously returns a Window object that represents an existing window.
-     * @param { Identity } identity
-     * @return {_Window}
-     * @tutorial Window.wrapSync
+     * @param identity
+     *
+     * @example
+     * ```js
+     * async function createWin() {
+     *     const app = await fin.Application.start({
+     *         name: 'myApp',
+     *         uuid: 'app-1',
+     *         url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
+     *         autoShow: true
+     *     });
+     *     return await app.getWindow();
+     * }
+     * await createWin();
+     * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
+     * ```
      * @static
      */
     wrapSync(identity: OpenFin.Identity): OpenFin.Window;
     /**
      * Creates a new Window.
-     * @param { Window~options } options - Window creation options
-     * @return {Promise.<_Window>}
-     * @tutorial Window.create
+     * @param options - Window creation options
+     *
+     * @example
+     * ```js
+     * async function createWindow() {
+     *     const winOption = {
+     *         name:'child',
+     *         defaultWidth: 300,
+     *         defaultHeight: 300,
+     *         url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
+     *         frame: true,
+     *         autoShow: true
+     *     };
+     *     return await fin.Window.create(winOption);
+     * }
+     *
+     * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
+     * ```
      * @static
      */
     create(options: OpenFin.WindowCreationOptions): Promise<OpenFin.Window>;
     /**
      * Asynchronously returns a Window object that represents the current window
-     * @return {Promise.<_Window>}
-     * @tutorial Window.getCurrent
+     *
+     * @example
+     * ```js
+     * fin.Window.getCurrent()
+     * .then(wnd => console.log('current window'))
+     * .catch(err => console.log(err));
+     *
+     * ```
      * @static
      */
     getCurrent(): Promise<OpenFin.Window>;
     /**
      * Synchronously returns a Window object that represents the current window
-     * @return {_Window}
-     * @tutorial Window.getCurrentSync
+     *
+     * @example
+     * ```js
+     * const wnd = fin.Window.getCurrentSync();
+     * const info = await wnd.getInfo();
+     * console.log(info);
+     *
+     * ```
      * @static
      */
     getCurrentSync(): OpenFin.Window;

package/src/api/window/Factory.js

@@ -3,15 +3,26 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const base_1 = require("../base");
 const validate_1 = require("../../util/validate");
 const Instance_1 = require("./Instance");
-/**
- * @lends Window
- */
 class _WindowModule extends base_1.Base {
     /**
      * Asynchronously returns a Window object that represents an existing window.
-     * @param { Identity } identity
-     * @return {Promise.<_Window>}
-     * @tutorial Window.wrap
+     * @param identity
+     *
+     * @example
+     * ```js
+     * async function createWin() {
+     *     const app = await fin.Application.start({
+     *         name: 'myApp',
+     *         uuid: 'app-1',
+     *         url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
+     *         autoShow: true
+     *     });
+     *     return await app.getWindow();
+     * }
+     * createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
+     * .then(win => console.log('wrapped window'))
+     * .catch(err => console.log(err));
+     * ```
      * @static
      */
     async wrap(identity) {
@@ -26,9 +37,22 @@ class _WindowModule extends base_1.Base {
     }
     /**
      * Synchronously returns a Window object that represents an existing window.
-     * @param { Identity } identity
-     * @return {_Window}
-     * @tutorial Window.wrapSync
+     * @param identity
+     *
+     * @example
+     * ```js
+     * async function createWin() {
+     *     const app = await fin.Application.start({
+     *         name: 'myApp',
+     *         uuid: 'app-1',
+     *         url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
+     *         autoShow: true
+     *     });
+     *     return await app.getWindow();
+     * }
+     * await createWin();
+     * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
+     * ```
      * @static
      */
     wrapSync(identity) {
@@ -43,9 +67,24 @@ class _WindowModule extends base_1.Base {
     }
     /**
      * Creates a new Window.
-     * @param { Window~options } options - Window creation options
-     * @return {Promise.<_Window>}
-     * @tutorial Window.create
+     * @param options - Window creation options
+     *
+     * @example
+     * ```js
+     * async function createWindow() {
+     *     const winOption = {
+     *         name:'child',
+     *         defaultWidth: 300,
+     *         defaultHeight: 300,
+     *         url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
+     *         frame: true,
+     *         autoShow: true
+     *     };
+     *     return await fin.Window.create(winOption);
+     * }
+     *
+     * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
+     * ```
      * @static
      */
     create(options) {
@@ -57,8 +96,14 @@ class _WindowModule extends base_1.Base {
     }
     /**
      * Asynchronously returns a Window object that represents the current window
-     * @return {Promise.<_Window>}
-     * @tutorial Window.getCurrent
+     *
+     * @example
+     * ```js
+     * fin.Window.getCurrent()
+     * .then(wnd => console.log('current window'))
+     * .catch(err => console.log(err));
+     *
+     * ```
      * @static
      */
     getCurrent() {
@@ -73,8 +118,14 @@ class _WindowModule extends base_1.Base {
     }
     /**
      * Synchronously returns a Window object that represents the current window
-     * @return {_Window}
-     * @tutorial Window.getCurrentSync
+     *
+     * @example
+     * ```js
+     * const wnd = fin.Window.getCurrentSync();
+     * const info = await wnd.getInfo();
+     * console.log(info);
+     *
+     * ```
      * @static
      */
     getCurrentSync() {