Updated typedoc-plugin-markdown, extended Index section in README

Author: chemerisuk

README.md

@@ -12,12 +12,26 @@
 
 ## Index
 
-<!-- MarkdownTOC levels="2" autolink="true" -->
+<!-- MarkdownTOC levels="2,3" autolink="true" -->
 
 - [Supported Platforms](#supported-platforms)
 - [Installation](#installation)
+    - [Adding required configuration files](#adding-required-configuration-files)
 - [Type Aliases](#type-aliases)
+    - [DynamicLinkAndroidInfo](#dynamiclinkandroidinfo)
+    - [DynamicLinkGoogleAnalyticsInfo](#dynamiclinkgoogleanalyticsinfo)
+    - [DynamicLinkIosInfo](#dynamiclinkiosinfo)
+    - [DynamicLinkItunesAnalyticsInfo](#dynamiclinkitunesanalyticsinfo)
+    - [DynamicLinkNavigationInfo](#dynamiclinknavigationinfo)
+    - [DynamicLinkOptions](#dynamiclinkoptions)
+    - [DynamicLinkPayload](#dynamiclinkpayload)
+    - [DynamicLinkSocialInfo](#dynamiclinksocialinfo)
 - [Functions](#functions)
+    - [createDynamicLink](#createdynamiclink)
+    - [createShortDynamicLink](#createshortdynamiclink)
+    - [createUnguessableDynamicLink](#createunguessabledynamiclink)
+    - [getDynamicLink](#getdynamiclink)
+    - [onDynamicLink](#ondynamiclink)
 
 <!-- /MarkdownTOC -->
 
@@ -80,6 +94,8 @@ Cordova supports `resource-file` tag for easy copying resources files. Firebase
 | `androidMinPackageVersionCode` | `number` | VersionCode of the minimum version of your app that can open the link. |
 | `androidPackageName` | `string` | Package name of the Android app to use to open the link. |
 
+___
+
 ### DynamicLinkGoogleAnalyticsInfo
 
  **DynamicLinkGoogleAnalyticsInfo**: `Object`
@@ -94,6 +110,8 @@ Cordova supports `resource-file` tag for easy copying resources files. Firebase
 | `utmSource` | `string` | Campaign source; used to identify a search engine, newsletter, or other source. |
 | `utmTerm` | `string` | Campaign term; used with paid search to supply the keywords for ads. |
 
+___
+
 ### DynamicLinkIosInfo
 
  **DynamicLinkIosInfo**: `Object`
@@ -108,6 +126,8 @@ Cordova supports `resource-file` tag for easy copying resources files. Firebase
 | `iosIpadBundleId` | `string` | Bundle ID of the iOS app to use on iPads to open the link. |
 | `iosIpadFallbackLink` | `string` | Link to open on iPads when the app isn't installed. |
 
+___
+
 ### DynamicLinkItunesAnalyticsInfo
 
  **DynamicLinkItunesAnalyticsInfo**: `Object`
@@ -120,6 +140,8 @@ Cordova supports `resource-file` tag for easy copying resources files. Firebase
 | `ct` | `string` | Campaign token that developers can add to any link in order to track sales from a specific marketing campaign. |
 | `pt` | `string` | Provider token that enables analytics for Dynamic Links from within iTunes Connect. |
 
+___
+
 ### DynamicLinkNavigationInfo
 
  **DynamicLinkNavigationInfo**: `Object`
@@ -130,6 +152,8 @@ Cordova supports `resource-file` tag for easy copying resources files. Firebase
 | :------ | :------ | :------ |
 | `enableForcedRedirect` | `boolean` | If true, app preview page will be disabled and there will be a redirect to the FDL. |
 
+___
+
 ### DynamicLinkOptions
 
  **DynamicLinkOptions**: `Object`
@@ -141,14 +165,16 @@ in the [Firebase Dynamic Links Short Links API Reference](https://firebase.googl
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `androidInfo?` | [`DynamicLinkAndroidInfo`](FirebaseDynamicLinks.md#dynamiclinkandroidinfo) | Android parameters. |
+| `androidInfo?` | [`DynamicLinkAndroidInfo`](README.md#dynamiclinkandroidinfo) | Android parameters. |
 | `domainUriPrefix?` | `string` | Domain uri prefix to use for this Dynamic Link. |
-| `googlePlayAnalytics?` | [`DynamicLinkGoogleAnalyticsInfo`](FirebaseDynamicLinks.md#dynamiclinkgoogleanalyticsinfo) | Google Analytics parameters. |
-| `iosInfo?` | [`DynamicLinkIosInfo`](FirebaseDynamicLinks.md#dynamiclinkiosinfo) | iOS parameters. |
-| `itunesConnectAnalytics?` | [`DynamicLinkItunesAnalyticsInfo`](FirebaseDynamicLinks.md#dynamiclinkitunesanalyticsinfo) | iTunes Connect App Analytics parameters. |
+| `googlePlayAnalytics?` | [`DynamicLinkGoogleAnalyticsInfo`](README.md#dynamiclinkgoogleanalyticsinfo) | Google Analytics parameters. |
+| `iosInfo?` | [`DynamicLinkIosInfo`](README.md#dynamiclinkiosinfo) | iOS parameters. |
+| `itunesConnectAnalytics?` | [`DynamicLinkItunesAnalyticsInfo`](README.md#dynamiclinkitunesanalyticsinfo) | iTunes Connect App Analytics parameters. |
 | `link` | `string` | The link your app will open. |
-| `navigationInfo?` | [`DynamicLinkNavigationInfo`](FirebaseDynamicLinks.md#dynamiclinknavigationinfo) | Navigation info parameters. |
-| `socialMetaTagInfo?` | [`DynamicLinkSocialInfo`](FirebaseDynamicLinks.md#dynamiclinksocialinfo) | Social meta-tag parameters. |
+| `navigationInfo?` | [`DynamicLinkNavigationInfo`](README.md#dynamiclinknavigationinfo) | Navigation info parameters. |
+| `socialMetaTagInfo?` | [`DynamicLinkSocialInfo`](README.md#dynamiclinksocialinfo) | Social meta-tag parameters. |
+
+___
 
 ### DynamicLinkPayload
 
@@ -162,6 +188,8 @@ in the [Firebase Dynamic Links Short Links API Reference](https://firebase.googl
 | `deepLink` | `string` \| ``null`` | Link parameter of the dynamic link. |
 | `minimumAppVersion?` | `number` | The minimum app version requested to process the dynamic link that can be compared directly with versionCode (Android only) |
 
+___
+
 ### DynamicLinkSocialInfo
 
  **DynamicLinkSocialInfo**: `Object`
@@ -176,7 +204,9 @@ in the [Firebase Dynamic Links Short Links API Reference](https://firebase.googl
 
 ## Functions
 
-### **createDynamicLink**(`params`): `Promise`<`string`\>
+### createDynamicLink
+
+**createDynamicLink**(`params`): `Promise`<`string`\>
 
 Creates a Dynamic Link from the parameters.
 
@@ -192,15 +222,19 @@ cordova.plugins.firebase.dynamiclinks.createDynamicLink({
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `params` | [`DynamicLinkOptions`](FirebaseDynamicLinks.md#dynamiclinkoptions) | Parameters to use for building a link |
+| `params` | [`DynamicLinkOptions`](README.md#dynamiclinkoptions) | Parameters to use for building a link |
 
 #### Returns
 
 `Promise`<`string`\>
 
-Fulfils promise with created link value
+Fulfils promise with created link string
 
-### **createShortDynamicLink**(`params`): `Promise`<`string`\>
+___
+
+### createShortDynamicLink
+
+**createShortDynamicLink**(`params`): `Promise`<`string`\>
 
 Creates a shortened Dynamic Link from the parameters. Shorten the path
 to a string that is only as long as needed to be unique, with a minimum
@@ -219,15 +253,19 @@ cordova.plugins.firebase.dynamiclinks.createShortDynamicLink({
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `params` | [`DynamicLinkOptions`](FirebaseDynamicLinks.md#dynamiclinkoptions) | Parameters to use for building a link |
+| `params` | [`DynamicLinkOptions`](README.md#dynamiclinkoptions) | Parameters to use for building a link |
 
 #### Returns
 
 `Promise`<`string`\>
 
-Fulfils promise with created link value
+Fulfils promise with created link string
+
+___
+
+### createUnguessableDynamicLink
 
-### **createUnguessableDynamicLink**(`params`): `Promise`<`string`\>
+**createUnguessableDynamicLink**(`params`): `Promise`<`string`\>
 
 Creates a Dynamic Link from the parameters. Shorten the path to
 an unguessable string. Such strings are created by base62-encoding
@@ -247,15 +285,19 @@ cordova.plugins.firebase.dynamiclinks.createShortDynamicLink({
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `params` | [`DynamicLinkOptions`](FirebaseDynamicLinks.md#dynamiclinkoptions) | Parameters to use for building a link |
+| `params` | [`DynamicLinkOptions`](README.md#dynamiclinkoptions) | Parameters to use for building a link |
 
 #### Returns
 
 `Promise`<`string`\>
 
-Fulfils promise with created link value
+Fulfils promise with created link string
 
-### **getDynamicLink**(): `Promise`<[`DynamicLinkPayload`](FirebaseDynamicLinks.md#dynamiclinkpayload) \| ``null``\>
+___
+
+### getDynamicLink
+
+**getDynamicLink**(): `Promise`<[`DynamicLinkPayload`](README.md#dynamiclinkpayload) \| ``null``\>
 
 Determines if the app has a pending dynamic link and provide access to the dynamic link parameters.
 
@@ -273,27 +315,31 @@ cordova.plugins.firebase.dynamiclinks.getDynamicLink().then(function(payload) {
 
 #### Returns
 
-`Promise`<[`DynamicLinkPayload`](FirebaseDynamicLinks.md#dynamiclinkpayload) \| ``null``\>
+`Promise`<[`DynamicLinkPayload`](README.md#dynamiclinkpayload) \| ``null``\>
+
+Fulfils promise with dynamic link payload when it exists.
+
+___
 
-Dynamic link payload.
+### onDynamicLink
 
-### **onDynamicLink**(`callback`, `errorCallback`): `void`
+**onDynamicLink**(`callback`, `errorCallback`): `void`
 
 Registers callback that is triggered on each dynamic link click.
 
 **`Example`**
 
 ```ts
-cordova.plugins.firebase.dynamiclinks.onDynamicLink(function(data) {
-    console.log("Dynamic link click with data:", data);
+cordova.plugins.firebase.dynamiclinks.onDynamicLink(function(payload) {
+    console.log("Dynamic link click with data:", payload);
 });
 ```
 
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `callback` | (`payload`: [`DynamicLinkPayload`](FirebaseDynamicLinks.md#dynamiclinkpayload)) => `void` | Callback function |
+| `callback` | (`payload`: [`DynamicLinkPayload`](README.md#dynamiclinkpayload)) => `void` | Callback function |
 | `errorCallback` | (`error`: `string`) => `void` | Error callback function |
 
 #### Returns

package.json

@@ -36,11 +36,11 @@
     "version": "perl -i -pe 's/(version=)\"\\d+\\.\\d+\\.\\d+\"/$1\"'$npm_package_version'\"$2/' plugin.xml && git add plugin.xml README.md",
     "postversion": "git push && git push --tags",
     "predocs": "tsc www/* --declaration --allowJs --checkJs --lib es2015,dom --emitDeclarationOnly --outDir types",
-    "docs": "typedoc ./types",
-    "postdocs": "perl -i -0pe 's/(<!-- TypedocGenerated -->).*/$1\n\n/gms' README.md && cat ./docs/modules/FirebaseDynamicLinks.md >> README.md"
+    "docs": "typedoc",
+    "postdocs": "perl -i -0pe 's/(<!-- TypedocGenerated -->).*/$1\n\n/gms' README.md && cat ./docs/README.md >> README.md"
   },
   "devDependencies": {
-    "@colony/typedoc-plugin-markdown": "3.16.0",
-    "typedoc": "^0.23.9"
+    "typedoc": "^0.23.9",
+    "typedoc-plugin-markdown": "^3.13.4"
   }
 }

tsconfig.json

@@ -2,10 +2,14 @@
   "typedocOptions": {
     "out": "docs",
     "readme": "none",
+    "entryPoints": "./types",
+    "exclude": "./types/index.d.ts",
     "entryPointStrategy": "expand",
     "hideBreadcrumbs": true,
     "hideInPageTOC": true,
     "hidePageTitle": true,
-    "hideMembersSymbol": true
+    "hideMembersSymbol": true,
+    "disableSources": true,
+    "githubPages": false
   }
 }

types/FirebaseDynamicLinks.d.ts

@@ -1,7 +1,7 @@
 /**
  *
  * Determines if the app has a pending dynamic link and provide access to the dynamic link parameters.
- * @returns {Promise<DynamicLinkPayload|null>} Dynamic link payload.
+ * @returns {Promise<DynamicLinkPayload|null>} Fulfils promise with dynamic link payload when it exists.
  *
  * @example
  * cordova.plugins.firebase.dynamiclinks.getDynamicLink().then(function(payload) {
@@ -20,16 +20,16 @@ export function getDynamicLink(): Promise<DynamicLinkPayload | null>;
  * @param {(error: string) => void} errorCallback Error callback function
  *
  * @example
- * cordova.plugins.firebase.dynamiclinks.onDynamicLink(function(data) {
- *     console.log("Dynamic link click with data:", data);
+ * cordova.plugins.firebase.dynamiclinks.onDynamicLink(function(payload) {
+ *     console.log("Dynamic link click with data:", payload);
  * });
  */
 export function onDynamicLink(callback: (payload: DynamicLinkPayload) => void, errorCallback: (error: string) => void): void;
 /**
  *
  * Creates a Dynamic Link from the parameters.
  * @param {DynamicLinkOptions} params Parameters to use for building a link
- * @returns {Promise<string>} Fulfils promise with created link value
+ * @returns {Promise<string>} Fulfils promise with created link string
  *
  * @example
  * cordova.plugins.firebase.dynamiclinks.createDynamicLink({
@@ -44,7 +44,7 @@ export function createDynamicLink(params: DynamicLinkOptions): Promise<string>;
  * length of 4 characters. Use this method if sensitive information would
  * not be exposed if a short Dynamic Link URL were guessed.
  * @param {DynamicLinkOptions} params Parameters to use for building a link
- * @returns {Promise<string>} Fulfils promise with created link value
+ * @returns {Promise<string>} Fulfils promise with created link string
  *
  * @example
  * cordova.plugins.firebase.dynamiclinks.createShortDynamicLink({
@@ -60,7 +60,7 @@ export function createShortDynamicLink(params: DynamicLinkOptions): Promise<stri
  * characters. Use unguessable strings to prevent your Dynamic Links
  * from being crawled, which can potentially expose sensitive information.
  * @param {DynamicLinkOptions} params Parameters to use for building a link
- * @returns {Promise<string>} Fulfils promise with created link value
+ * @returns {Promise<string>} Fulfils promise with created link string
  *
  * @example
  * cordova.plugins.firebase.dynamiclinks.createShortDynamicLink({

www/FirebaseDynamicLinks.js

@@ -6,7 +6,7 @@ exports.getDynamicLink =
 /**
  *
  * Determines if the app has a pending dynamic link and provide access to the dynamic link parameters.
- * @returns {Promise<DynamicLinkPayload|null>} Dynamic link payload.
+ * @returns {Promise<DynamicLinkPayload|null>} Fulfils promise with dynamic link payload when it exists.
  *
  * @example
  * cordova.plugins.firebase.dynamiclinks.getDynamicLink().then(function(payload) {
@@ -31,8 +31,8 @@ exports.onDynamicLink =
  * @param {(error: string) => void} errorCallback Error callback function
  *
  * @example
- * cordova.plugins.firebase.dynamiclinks.onDynamicLink(function(data) {
- *     console.log("Dynamic link click with data:", data);
+ * cordova.plugins.firebase.dynamiclinks.onDynamicLink(function(payload) {
+ *     console.log("Dynamic link click with data:", payload);
  * });
  */
 function(callback, errorCallback) {
@@ -44,7 +44,7 @@ exports.createDynamicLink =
  *
  * Creates a Dynamic Link from the parameters.
  * @param {DynamicLinkOptions} params Parameters to use for building a link
- * @returns {Promise<string>} Fulfils promise with created link value
+ * @returns {Promise<string>} Fulfils promise with created link string
  *
  * @example
  * cordova.plugins.firebase.dynamiclinks.createDynamicLink({
@@ -65,7 +65,7 @@ exports.createShortDynamicLink =
  * length of 4 characters. Use this method if sensitive information would
  * not be exposed if a short Dynamic Link URL were guessed.
  * @param {DynamicLinkOptions} params Parameters to use for building a link
- * @returns {Promise<string>} Fulfils promise with created link value
+ * @returns {Promise<string>} Fulfils promise with created link string
  *
  * @example
  * cordova.plugins.firebase.dynamiclinks.createShortDynamicLink({
@@ -91,7 +91,7 @@ exports.createUnguessableDynamicLink =
  * characters. Use unguessable strings to prevent your Dynamic Links
  * from being crawled, which can potentially expose sensitive information.
  * @param {DynamicLinkOptions} params Parameters to use for building a link
- * @returns {Promise<string>} Fulfils promise with created link value
+ * @returns {Promise<string>} Fulfils promise with created link string
  *
  * @example
  * cordova.plugins.firebase.dynamiclinks.createShortDynamicLink({