@openfin/core 33.76.27 → 33.76.36

package/src/api/external-application/Instance.js

@@ -4,28 +4,29 @@ exports.ExternalApplication = void 0;
 /* eslint-disable import/prefer-default-export */
 const base_1 = require("../base");
 /**
- * @classdesc An ExternalApplication object representing native language adapter connections to the runtime. Allows
- * the developer to listen to <a href="tutorial-ExternalApplication.EventEmitter.html">application events.</a>
+ * An ExternalApplication object representing native language adapter connections to the runtime. Allows
+ * the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
  * Discovery of connections is provided by <a href="tutorial-System.getAllExternalApplications.html">getAllExternalApplications.</a>
  *
  * Processes that can be wrapped as `ExternalApplication`s include the following:
  * - Processes which have connected to an OpenFin runtime via an adapter
  * - Processes started via `System.launchExternalApplication`
  * - Processes monitored via `System.monitorExternalProcess`
- * @class
- * @hideconstructor
  */
 class ExternalApplication extends base_1.EmitterBase {
+    /**
+     * @internal
+     */
     constructor(wire, identity) {
         super(wire, 'external-application', identity.uuid);
         this.identity = identity;
     }
     /**
      * Adds a listener to the end of the listeners array for the specified event.
-     * @param { string | symbol } eventType  - The type of the event.
-     * @param { Function } listener - Called whenever an event of the specified type occurs.
-     * @param { SubOptions } [options] - Option to support event timestamps.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     * @param listener - Called whenever an event of the specified type occurs.
+     * @param options - Option to support event timestamps.
+     *
      * @function addListener
      * @memberof ExternalApplication
      * @instance
@@ -33,10 +34,10 @@ class ExternalApplication extends base_1.EmitterBase {
      */
     /**
      * Adds a listener to the end of the listeners array for the specified event.
-     * @param { string | symbol } eventType  - The type of the event.
-     * @param { Function } listener - Called whenever an event of the specified type occurs.
-     * @param { SubOptions } [options] - Option to support event timestamps.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     * @param listener - Called whenever an event of the specified type occurs.
+     * @param options - Option to support event timestamps.
+     *
      * @function on
      * @memberof ExternalApplication
      * @instance
@@ -44,10 +45,10 @@ class ExternalApplication extends base_1.EmitterBase {
      */
     /**
      * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
-     * @param { string | symbol } eventType  - The type of the event.
-     * @param { Function } listener - The callback function.
-     * @param { SubOptions } [options] - Option to support event timestamps.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     * @param listener - The callback function.
+     * @param options - Option to support event timestamps.
+     *
      * @function once
      * @memberof ExternalApplication
      * @instance
@@ -55,10 +56,10 @@ class ExternalApplication extends base_1.EmitterBase {
      */
     /**
      * Adds a listener to the beginning of the listeners array for the specified event.
-     * @param { string | symbol } eventType  - The type of the event.
-     * @param { Function } listener - The callback function.
-     * @param { SubOptions } [options] - Option to support event timestamps.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     * @param listener - The callback function.
+     * @param options - Option to support event timestamps.
+     *
      * @function prependListener
      * @memberof ExternalApplication
      * @instance
@@ -67,10 +68,10 @@ class ExternalApplication extends base_1.EmitterBase {
     /**
      * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
      * The listener is added to the beginning of the listeners array.
-     * @param { string | symbol } eventType  - The type of the event.
-     * @param { Function } listener - The callback function.
-     * @param { SubOptions } [options] - Option to support event timestamps.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     * @param listener - The callback function.
+     * @param options - Option to support event timestamps.
+     *
      * @function prependOnceListener
      * @memberof ExternalApplication
      * @instance
@@ -79,10 +80,10 @@ class ExternalApplication extends base_1.EmitterBase {
     /**
      * Remove a listener from the listener array for the specified event.
      * Caution: Calling this method changes the array indices in the listener array behind the listener.
-     * @param { string | symbol } eventType  - The type of the event.
-     * @param { Function } listener - The callback function.
-     * @param { SubOptions } [options] - Option to support event timestamps.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     * @param listener - The callback function.
+     * @param options - Option to support event timestamps.
+     *
      * @function removeListener
      * @memberof ExternalApplication
      * @instance
@@ -90,8 +91,8 @@ class ExternalApplication extends base_1.EmitterBase {
      */
     /**
      * Removes all listeners, or those of the specified event.
-     * @param { string | symbol } [eventType]  - The type of the event.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     *
      * @function removeAllListeners
      * @memberof ExternalApplication
      * @instance
@@ -99,8 +100,15 @@ class ExternalApplication extends base_1.EmitterBase {
      */
     /**
      * Retrieves information about the external application.
-     * @return {Promise.<ExternalApplicationInfo>}
-     * @tutorial ExternalApplication.getInfo
+     *
+     * @example
+     * ```js
+     * async function getInfo() {
+     *     const extApp = await fin.ExternalApplication.wrap('javaApp-uuid');
+     *     return await extApp.getInfo();
+     * }
+     * getInfo().then(info => console.log(info)).catch(err => console.log(err));
+     * ```
      */
     getInfo() {
         return this.wire.sendAction('get-external-application-info', this.identity).then(({ payload }) => payload.data);

package/src/api/external-application/index.d.ts

@@ -1,3 +1,12 @@
+/**
+ * Entry point for the OpenFin ExternalApplication namespace.
+ *
+ * Because TypeDoc does not currently support multiple modules with the same name, the module alias "ExternalApplicationModule" is used for
+ * the module containing static members of the `ExternalApplication` namespace (available under `fin.ExternalApplication`), while `ExternalApplication`
+ * documents instances of the OpenFin `ExternalApplication` class.
+ *
+ * @packageDocumentation
+ */
 import ExternalApplicationModule from './Factory';
 export default ExternalApplicationModule;
 export * from './Instance';

package/src/api/external-application/index.js

@@ -1,4 +1,13 @@
 "use strict";
+/**
+ * Entry point for the OpenFin ExternalApplication namespace.
+ *
+ * Because TypeDoc does not currently support multiple modules with the same name, the module alias "ExternalApplicationModule" is used for
+ * the module containing static members of the `ExternalApplication` namespace (available under `fin.ExternalApplication`), while `ExternalApplication`
+ * documents instances of the OpenFin `ExternalApplication` class.
+ *
+ * @packageDocumentation
+ */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/src/api/fin.d.ts

@@ -46,6 +46,9 @@ export default class Fin<MeType extends EntityType = EntityType> extends EventEm
     Interop: InteropModule;
     SnapshotSource: SnapshotSourceModule;
     readonly me: Me<MeType>;
+    /**
+     * @internal
+     */
     constructor(wire: Transport<MeType>);
 }
 export {};

package/src/api/fin.js

@@ -16,6 +16,9 @@ const me_1 = require("./me");
 const interop_1 = require("./interop");
 const snapshot_source_1 = require("./snapshot-source");
 class Fin extends events_1.EventEmitter {
+    /**
+     * @internal
+     */
     constructor(wire) {
         super();
         this.wire = wire;

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

@@ -1,36 +1,53 @@
 import type * as OpenFin from '../../OpenFin';
 import { Base } from '../base';
-/**
- * @lends Frame
- */
 export default class _FrameModule extends Base {
     /**
      * Asynchronously returns a reference to the specified frame. The frame does not have to exist
-     * @param {Identity} identity - the identity of the frame you want to wrap
-     * @return {Promise.<_Frame>}
-     * @tutorial Frame.wrap
+     * @param identity - the identity of the frame you want to wrap
+     *
+     * @example
+     * ```js
+     * fin.Frame.wrap({ uuid: 'testFrame', name: 'testFrame' })
+     * .then(frm => console.log('wrapped frame'))
+     * .catch(err => console.log(err));
+     * ```
      * @static
      */
     wrap(identity: OpenFin.Identity): Promise<OpenFin.Frame>;
     /**
      * Synchronously returns a reference to the specified frame. The frame does not have to exist
-     * @param {Identity} identity - the identity of the frame you want to wrap
-     * @return {_Frame}
-     * @tutorial Frame.wrapSync
+     * @param identity - the identity of the frame you want to wrap
+     *
+     * @example
+     * ```js
+     * const frm = fin.Frame.wrapSync({ uuid: 'testFrame', name: 'testFrame' });
+     * const info = await frm.getInfo();
+     * console.log(info);
+     * ```
      * @static
      */
     wrapSync(identity: OpenFin.Identity): OpenFin.Frame;
     /**
      * Asynchronously returns a reference to the current frame
-     * @return {Promise.<_Frame>}
-     * @tutorial Frame.getCurrent
+     *
+     * @example
+     * ```js
+     * fin.Frame.getCurrent()
+     * .then(frm => console.log('current frame'))
+     * .catch(err => console.log(err));
+     * ```
      * @static
      */
     getCurrent(): Promise<OpenFin.Frame>;
     /**
      * Synchronously returns a reference to the current frame
-     * @return {_Frame}
-     * @tutorial Frame.getCurrentSync
+     *
+     * @example
+     * ```js
+     * const frm = fin.Frame.getCurrentSync();
+     * const info = await frm.getInfo();
+     * console.log(info);
+     * ```
      * @static
      */
     getCurrentSync(): OpenFin.Frame;

package/src/api/frame/Factory.js

@@ -3,15 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const base_1 = require("../base");
 const validate_1 = require("../../util/validate");
 const Instance_1 = require("./Instance");
-/**
- * @lends Frame
- */
 class _FrameModule extends base_1.Base {
     /**
      * Asynchronously returns a reference to the specified frame. The frame does not have to exist
-     * @param {Identity} identity - the identity of the frame you want to wrap
-     * @return {Promise.<_Frame>}
-     * @tutorial Frame.wrap
+     * @param identity - the identity of the frame you want to wrap
+     *
+     * @example
+     * ```js
+     * fin.Frame.wrap({ uuid: 'testFrame', name: 'testFrame' })
+     * .then(frm => console.log('wrapped frame'))
+     * .catch(err => console.log(err));
+     * ```
      * @static
      */
     async wrap(identity) {
@@ -26,9 +28,14 @@ class _FrameModule extends base_1.Base {
     }
     /**
      * Synchronously returns a reference to the specified frame. The frame does not have to exist
-     * @param {Identity} identity - the identity of the frame you want to wrap
-     * @return {_Frame}
-     * @tutorial Frame.wrapSync
+     * @param identity - the identity of the frame you want to wrap
+     *
+     * @example
+     * ```js
+     * const frm = fin.Frame.wrapSync({ uuid: 'testFrame', name: 'testFrame' });
+     * const info = await frm.getInfo();
+     * console.log(info);
+     * ```
      * @static
      */
     wrapSync(identity) {
@@ -43,8 +50,13 @@ class _FrameModule extends base_1.Base {
     }
     /**
      * Asynchronously returns a reference to the current frame
-     * @return {Promise.<_Frame>}
-     * @tutorial Frame.getCurrent
+     *
+     * @example
+     * ```js
+     * fin.Frame.getCurrent()
+     * .then(frm => console.log('current frame'))
+     * .catch(err => console.log(err));
+     * ```
      * @static
      */
     getCurrent() {
@@ -55,8 +67,13 @@ class _FrameModule extends base_1.Base {
     }
     /**
      * Synchronously returns a reference to the current frame
-     * @return {_Frame}
-     * @tutorial Frame.getCurrentSync
+     *
+     * @example
+     * ```js
+     * const frm = fin.Frame.getCurrentSync();
+     * const info = await frm.getInfo();
+     * console.log(info);
+     * ```
      * @static
      */
     getCurrentSync() {

package/src/api/frame/Instance.d.ts

@@ -3,7 +3,6 @@ import { EmitterBase } from '../base';
 import { Transport } from '../../transport/transport';
 type FrameEvents = OpenFin.FrameEvent;
 /**
- * @classdesc
  * An iframe represents an embedded HTML page within a parent HTML page. Because this embedded page
  * has its own DOM and global JS context (which may or may not be linked to that of the parent depending
  * on if it is considered out of the root domain or not), it represents a unique endpoint as an OpenFin
@@ -11,7 +10,7 @@ type FrameEvents = OpenFin.FrameEvent;
  * iframe has the OpenFin API injected by default. It is possible to opt into cross-origin iframes having
  * the API by setting api.iframe.crossOriginInjection to true in a window's options. To block all iframes
  * from getting the API injected you can set api.frame.sameOriginInjection
- * to false <a href="Window.html#~options" target="_blank">(see Window~options)</a>.
+ * to false <a href="Window.html#~options" target="_blank">({@link OpenFin.WindowCreationOptions see Window Options})</a>.
  *
  * To be able to directly address this context for eventing and messaging purposes, it needs a
  * unique uuid name pairing. For OpenFin applications and windows this is provided via a configuration
@@ -21,20 +20,20 @@ type FrameEvents = OpenFin.FrameEvent;
  * the same as the parent window's.
  *
  * The fin.Frame namespace represents a way to interact with `iframes` and facilitates the discovery of current context
- * (iframe or main window) as well as the ability to listen for <a href="tutorial-Frame.EventEmitter.html">frame-specific events</a>.
- * @class
- * @alias Frame
- * @hideconstructor
+ * (iframe or main window) as well as the ability to listen for {@link OpenFin.FrameEvents frame-specific events}.
  */
 export declare class _Frame extends EmitterBase<FrameEvents> {
     identity: OpenFin.Identity;
+    /**
+     * @internal
+     */
     constructor(wire: Transport, identity: OpenFin.Identity);
     /**
      * Adds the listener function to the end of the listeners array for the specified event type.
-     * @param { string | symbol } eventType  - The type of the event.
-     * @param { Function } listener - Called whenever an event of the specified type occurs.
-     * @param { SubOptions } [options] - Option to support event timestamps.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     * @param listener - Called whenever an event of the specified type occurs.
+     * @param options - Option to support event timestamps.
+     *
      * @function addListener
      * @memberof Frame
      * @instance
@@ -42,10 +41,10 @@ export declare class _Frame extends EmitterBase<FrameEvents> {
      */
     /**
      * Adds a listener to the end of the listeners array for the specified event.
-     * @param { string | symbol } eventType  - The type of the event.
-     * @param { Function } listener - Called whenever an event of the specified type occurs.
-     * @param { SubOptions } [options] - Option to support event timestamps.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     * @param listener - Called whenever an event of the specified type occurs.
+     * @param options - Option to support event timestamps.
+     *
      * @function on
      * @memberof Frame
      * @instance
@@ -53,10 +52,10 @@ export declare class _Frame extends EmitterBase<FrameEvents> {
      */
     /**
      * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
-     * @param { string | symbol } eventType  - The type of the event.
-     * @param { Function } listener - The callback function.
-     * @param { SubOptions } [options] - Option to support event timestamps.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     * @param listener - The callback function.
+     * @param options - Option to support event timestamps.
+     *
      * @function once
      * @memberof Frame
      * @instance
@@ -64,10 +63,10 @@ export declare class _Frame extends EmitterBase<FrameEvents> {
      */
     /**
      * Adds a listener to the beginning of the listeners array for the specified event.
-     * @param { string | symbol } eventType  - The type of the event.
-     * @param { Function } listener - The callback function.
-     * @param { SubOptions } [options] - Option to support event timestamps.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     * @param listener - The callback function.
+     * @param options - Option to support event timestamps.
+     *
      * @function prependListener
      * @memberof Frame
      * @instance
@@ -76,10 +75,10 @@ export declare class _Frame extends EmitterBase<FrameEvents> {
     /**
      * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
      * The listener is added to the beginning of the listeners array.
-     * @param { string | symbol } eventType  - The type of the event.
-     * @param { Function } listener - The callback function.
-     * @param { SubOptions } [options] - Option to support event timestamps.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     * @param listener - The callback function.
+     * @param options - Option to support event timestamps.
+     *
      * @function prependOnceListener
      * @memberof Frame
      * @instance
@@ -88,10 +87,10 @@ export declare class _Frame extends EmitterBase<FrameEvents> {
     /**
      * Remove a listener from the listener array for the specified event.
      * Caution: Calling this method changes the array indices in the listener array behind the listener.
-     * @param { string | symbol } eventType  - The type of the event.
-     * @param { Function } listener - The callback function.
-     * @param { SubOptions } [options] - Option to support event timestamps.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     * @param listener - The callback function.
+     * @param options - Option to support event timestamps.
+     *
      * @function removeListener
      * @memberof Frame
      * @instance
@@ -99,24 +98,38 @@ export declare class _Frame extends EmitterBase<FrameEvents> {
      */
     /**
      * Removes all listeners, or those of the specified event.
-     * @param { string | symbol } [eventType]  - The type of the event.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     *
      * @function removeAllListeners
      * @memberof Frame
      * @instance
      * @tutorial Frame.EventEmitter
      */
     /**
-     * Returns a frame info object for the represented frame
-     * @return {Promise.<FrameInfo>}
-     * @tutorial Frame.getInfo
+     * Returns a frame info object for the represented frame.
+     *
+     * @example
+     * ```js
+     * async function getInfo() {
+     *     const frm = await fin.Frame.getCurrent();
+     *     return await frm.getInfo();
+     * }
+     * getInfo().then(info => console.log(info)).catch(err => console.log(err));
+     * ```
      */
     getInfo(): Promise<OpenFin.FrameInfo>;
     /**
      * Returns a frame info object representing the window that the referenced iframe is
-     * currently embedded in
-     * @return {Promise.<FrameInfo>}
-     * @tutorial Frame.getParentWindow
+     * currently embedded in.
+     *
+     * @example
+     * ```js
+     * async function getParentWindow() {
+     *     const frm = await fin.Frame.getCurrent();
+     *     return await frm.getParentWindow();
+     * }
+     * getParentWindow().then(winInfo => console.log(winInfo)).catch(err => console.log(err));
+     * ```
      */
     getParentWindow(): Promise<OpenFin.FrameInfo>;
 }

package/src/api/frame/Instance.js

@@ -4,7 +4,6 @@ exports._Frame = void 0;
 /* eslint-disable import/prefer-default-export */
 const base_1 = require("../base");
 /**
- * @classdesc
  * An iframe represents an embedded HTML page within a parent HTML page. Because this embedded page
  * has its own DOM and global JS context (which may or may not be linked to that of the parent depending
  * on if it is considered out of the root domain or not), it represents a unique endpoint as an OpenFin
@@ -12,7 +11,7 @@ const base_1 = require("../base");
  * iframe has the OpenFin API injected by default. It is possible to opt into cross-origin iframes having
  * the API by setting api.iframe.crossOriginInjection to true in a window's options. To block all iframes
  * from getting the API injected you can set api.frame.sameOriginInjection
- * to false <a href="Window.html#~options" target="_blank">(see Window~options)</a>.
+ * to false <a href="Window.html#~options" target="_blank">({@link OpenFin.WindowCreationOptions see Window Options})</a>.
  *
  * To be able to directly address this context for eventing and messaging purposes, it needs a
  * unique uuid name pairing. For OpenFin applications and windows this is provided via a configuration
@@ -22,22 +21,22 @@ const base_1 = require("../base");
  * the same as the parent window's.
  *
  * The fin.Frame namespace represents a way to interact with `iframes` and facilitates the discovery of current context
- * (iframe or main window) as well as the ability to listen for <a href="tutorial-Frame.EventEmitter.html">frame-specific events</a>.
- * @class
- * @alias Frame
- * @hideconstructor
+ * (iframe or main window) as well as the ability to listen for {@link OpenFin.FrameEvents frame-specific events}.
  */
 class _Frame extends base_1.EmitterBase {
+    /**
+     * @internal
+     */
     constructor(wire, identity) {
         super(wire, 'frame', identity.uuid, identity.name);
         this.identity = identity;
     }
     /**
      * Adds the listener function to the end of the listeners array for the specified event type.
-     * @param { string | symbol } eventType  - The type of the event.
-     * @param { Function } listener - Called whenever an event of the specified type occurs.
-     * @param { SubOptions } [options] - Option to support event timestamps.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     * @param listener - Called whenever an event of the specified type occurs.
+     * @param options - Option to support event timestamps.
+     *
      * @function addListener
      * @memberof Frame
      * @instance
@@ -45,10 +44,10 @@ class _Frame extends base_1.EmitterBase {
      */
     /**
      * Adds a listener to the end of the listeners array for the specified event.
-     * @param { string | symbol } eventType  - The type of the event.
-     * @param { Function } listener - Called whenever an event of the specified type occurs.
-     * @param { SubOptions } [options] - Option to support event timestamps.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     * @param listener - Called whenever an event of the specified type occurs.
+     * @param options - Option to support event timestamps.
+     *
      * @function on
      * @memberof Frame
      * @instance
@@ -56,10 +55,10 @@ class _Frame extends base_1.EmitterBase {
      */
     /**
      * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
-     * @param { string | symbol } eventType  - The type of the event.
-     * @param { Function } listener - The callback function.
-     * @param { SubOptions } [options] - Option to support event timestamps.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     * @param listener - The callback function.
+     * @param options - Option to support event timestamps.
+     *
      * @function once
      * @memberof Frame
      * @instance
@@ -67,10 +66,10 @@ class _Frame extends base_1.EmitterBase {
      */
     /**
      * Adds a listener to the beginning of the listeners array for the specified event.
-     * @param { string | symbol } eventType  - The type of the event.
-     * @param { Function } listener - The callback function.
-     * @param { SubOptions } [options] - Option to support event timestamps.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     * @param listener - The callback function.
+     * @param options - Option to support event timestamps.
+     *
      * @function prependListener
      * @memberof Frame
      * @instance
@@ -79,10 +78,10 @@ class _Frame extends base_1.EmitterBase {
     /**
      * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
      * The listener is added to the beginning of the listeners array.
-     * @param { string | symbol } eventType  - The type of the event.
-     * @param { Function } listener - The callback function.
-     * @param { SubOptions } [options] - Option to support event timestamps.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     * @param listener - The callback function.
+     * @param options - Option to support event timestamps.
+     *
      * @function prependOnceListener
      * @memberof Frame
      * @instance
@@ -91,10 +90,10 @@ class _Frame extends base_1.EmitterBase {
     /**
      * Remove a listener from the listener array for the specified event.
      * Caution: Calling this method changes the array indices in the listener array behind the listener.
-     * @param { string | symbol } eventType  - The type of the event.
-     * @param { Function } listener - The callback function.
-     * @param { SubOptions } [options] - Option to support event timestamps.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     * @param listener - The callback function.
+     * @param options - Option to support event timestamps.
+     *
      * @function removeListener
      * @memberof Frame
      * @instance
@@ -102,26 +101,40 @@ class _Frame extends base_1.EmitterBase {
      */
     /**
      * Removes all listeners, or those of the specified event.
-     * @param { string | symbol } [eventType]  - The type of the event.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     *
      * @function removeAllListeners
      * @memberof Frame
      * @instance
      * @tutorial Frame.EventEmitter
      */
     /**
-     * Returns a frame info object for the represented frame
-     * @return {Promise.<FrameInfo>}
-     * @tutorial Frame.getInfo
+     * Returns a frame info object for the represented frame.
+     *
+     * @example
+     * ```js
+     * async function getInfo() {
+     *     const frm = await fin.Frame.getCurrent();
+     *     return await frm.getInfo();
+     * }
+     * getInfo().then(info => console.log(info)).catch(err => console.log(err));
+     * ```
      */
     getInfo() {
         return this.wire.sendAction('get-frame-info', this.identity).then(({ payload }) => payload.data);
     }
     /**
      * Returns a frame info object representing the window that the referenced iframe is
-     * currently embedded in
-     * @return {Promise.<FrameInfo>}
-     * @tutorial Frame.getParentWindow
+     * currently embedded in.
+     *
+     * @example
+     * ```js
+     * async function getParentWindow() {
+     *     const frm = await fin.Frame.getCurrent();
+     *     return await frm.getParentWindow();
+     * }
+     * getParentWindow().then(winInfo => console.log(winInfo)).catch(err => console.log(err));
+     * ```
      */
     getParentWindow() {
         return this.wire.sendAction('get-parent-window', this.identity).then(({ payload }) => payload.data);