@openfin/core 33.76.31 → 33.76.36

package/src/api/snapshot-source/Factory.js

@@ -3,21 +3,26 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const base_1 = require("../base");
 const Instance_1 = require("./Instance");
 const utils_1 = require("./utils");
-/**
- * @REMOVED
- * @typedef { object } SnapshotProvider
- * @property {getSnapshot} [getSnapshot]
- * @property {applySnapshot} [applySnapshot]
- */
-/**
- * @lends SnapshotSource
- */
 class SnapshotSourceModule extends base_1.Base {
     /**
      * Initializes a SnapshotSource with the getSnapshot and applySnapshot methods defined.
-     * @param { SnapshotProvider } provider
-     * @return { Promise<void> }
-     * @tutorial SnapshotSource.init
+     * @param provider
+     *
+     * @example
+     * ```js
+     * const snapshotProvider = {
+     *     async getSnapshot() {
+     *       const bounds = await fin.me.getBounds();
+     *       return bounds;
+     *      },
+     *     async applySnapshot(snapshot) {
+     *       await fin.me.setBounds(snapshot);
+     *       return undefined;
+     *     }
+     * }
+     *
+     * await fin.SnapshotSource.init(snapshotProvider);
+     * ```
      * @static
      */
     async init(provider) {
@@ -38,9 +43,14 @@ class SnapshotSourceModule extends base_1.Base {
     }
     /**
      * Synchronously returns a SnapshotSource object that represents the current SnapshotSource.
-     * @param { Identity } identity
-     * @return { SnapshotSource }
-     * @tutorial SnapshotSource.wrapSync
+     * @param identity
+     *
+     * @example
+     * ```js
+     * const snapshotSource = fin.SnapshotSource.wrapSync(fin.me);
+     * // Use wrapped instance's getSnapshot method, e.g.:
+     * const snapshot = await snapshotSource.getSnapshot();
+     * ```
      * @static
      */
     wrapSync(identity) {
@@ -51,9 +61,14 @@ class SnapshotSourceModule extends base_1.Base {
     }
     /**
      * Asynchronously returns a SnapshotSource object that represents the current SnapshotSource.
-     * @param { Identity } identity
-     * @return { Promise.<SnapshotSource> }
-     * @tutorial SnapshotSource.wrap
+     * @param identity
+     *
+     * @example
+     * ```js
+     * const snapshotSource = await fin.SnapshotSource.wrap(fin.me);
+     * // Use wrapped instance's getSnapshot method, e.g.:
+     * const snapshot = await snapshotSource.getSnapshot();
+     * ```
      * @static
      */
     async wrap(identity) {

package/src/api/snapshot-source/Instance.d.ts

@@ -3,29 +3,51 @@ import { Base } from '../base';
 import { Transport } from '../../transport/transport';
 /**
  * Enables configuring a SnapshotSource with custom getSnapshot and applySnapshot methods.
- * @namespace
+ *
  */
 export declare class SnapshotSource<T = any> extends Base {
     #private;
+    /**
+     * @internal
+     */
     constructor(wire: Transport, id: OpenFin.ApplicationIdentity);
     get identity(): OpenFin.ApplicationIdentity;
     /**
      * Method to determine if the SnapshotSource has been initialized.
      *
-     * Use when the parent application is starting up to ensure the SnapshotSource is able to accept and
+     * @remarks Use when the parent application is starting up to ensure the SnapshotSource is able to accept and
      * apply a snapshot using the {@link SnapshotSource#applySnapshot applySnapshot} method.
-     * @return { Promise<void> }
-     * @tutorial SnapshotSource.ready
+     *
+     * @example
+     * ```js
+     * let snapshotSource = fin.SnapshotSource.wrapSync(fin.me);
+     *
+     * const snapshotProvider = {
+     *     async getSnapshot() { return 'foo' },
+     *     async applySnapshot(snapshot) {
+     *       console.log(snapshot);
+     *       return undefined;
+     *     }
+     * }
+     * await fin.SnapshotSource.init(snapshotProvider);
+     *
+     * try {
+     *   await snapshotSource.ready();
+     *   await snapshotSource.applySnapshot('foo');
+     * } catch (err) {
+     *   console.log(err)
+     * }
+     * ```
      */
     ready(): Promise<void>;
     /**
-     * Call the SnapshotSource's getSnapshot method defined by {@link SnapshotSource#init init}.
-     * @return { Promise<any> }
+     * Call the SnapshotSource's getSnapshot method defined by {@link SnapshotSource.SnapshotSourceModule#init init}.
+     *
      */
     getSnapshot(): Promise<T>;
     /**
-     * Call the SnapshotSource's applySnapshot method defined by {@link SnapshotSource#init init}.
-     * @return { Promise<void> }
+     * Call the SnapshotSource's applySnapshot method defined by {@link SnapshotSource.SnapshotSourceModule#init init}.
+     *
      */
     applySnapshot(snapshot: T): Promise<void>;
 }

package/src/api/snapshot-source/Instance.js

@@ -19,9 +19,12 @@ const utils_1 = require("./utils");
 const connectionMap = new Map();
 /**
  * Enables configuring a SnapshotSource with custom getSnapshot and applySnapshot methods.
- * @namespace
+ *
  */
 class SnapshotSource extends base_1.Base {
+    /**
+     * @internal
+     */
     constructor(wire, id) {
         super(wire);
         _SnapshotSource_identity.set(this, void 0);
@@ -85,10 +88,29 @@ class SnapshotSource extends base_1.Base {
     /**
      * Method to determine if the SnapshotSource has been initialized.
      *
-     * Use when the parent application is starting up to ensure the SnapshotSource is able to accept and
+     * @remarks Use when the parent application is starting up to ensure the SnapshotSource is able to accept and
      * apply a snapshot using the {@link SnapshotSource#applySnapshot applySnapshot} method.
-     * @return { Promise<void> }
-     * @tutorial SnapshotSource.ready
+     *
+     * @example
+     * ```js
+     * let snapshotSource = fin.SnapshotSource.wrapSync(fin.me);
+     *
+     * const snapshotProvider = {
+     *     async getSnapshot() { return 'foo' },
+     *     async applySnapshot(snapshot) {
+     *       console.log(snapshot);
+     *       return undefined;
+     *     }
+     * }
+     * await fin.SnapshotSource.init(snapshotProvider);
+     *
+     * try {
+     *   await snapshotSource.ready();
+     *   await snapshotSource.applySnapshot('foo');
+     * } catch (err) {
+     *   console.log(err)
+     * }
+     * ```
      */
     async ready() {
         this.wire.sendAction('snapshot-source-ready').catch((e) => {
@@ -105,8 +127,8 @@ class SnapshotSource extends base_1.Base {
         }
     }
     /**
-     * Call the SnapshotSource's getSnapshot method defined by {@link SnapshotSource#init init}.
-     * @return { Promise<any> }
+     * Call the SnapshotSource's getSnapshot method defined by {@link SnapshotSource.SnapshotSourceModule#init init}.
+     *
      */
     async getSnapshot() {
         this.wire.sendAction('snapshot-source-get-snapshot').catch((e) => {
@@ -117,8 +139,8 @@ class SnapshotSource extends base_1.Base {
         return (await response).snapshot;
     }
     /**
-     * Call the SnapshotSource's applySnapshot method defined by {@link SnapshotSource#init init}.
-     * @return { Promise<void> }
+     * Call the SnapshotSource's applySnapshot method defined by {@link SnapshotSource.SnapshotSourceModule#init init}.
+     *
      */
     async applySnapshot(snapshot) {
         this.wire.sendAction('snapshot-source-apply-snapshot').catch((e) => {

package/src/api/snapshot-source/index.d.ts

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

package/src/api/snapshot-source/index.js

@@ -1,4 +1,13 @@
 "use strict";
+/**
+ * Entry point for the OpenFin SnapshotSource namespace.
+ *
+ * Because TypeDoc does not currently support multiple modules with the same name, the module alias "SnapshotSourceModule" is used for
+ * the module containing static members of the `SnapshotSource` namespace (available under `fin.SnapshotSource`), while `SnapshotSource` documents
+ * instances of the OpenFin `SnapshotSource` 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);