@firebase/api-documenter 0.2.0 → 0.2.1-canary.4af28c1a4

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# @firebase/api-documenter
+
+## 0.2.0
+### Minor Changes
+
+- [#6449](https://github.com/firebase/firebase-js-sdk/pull/6449) Updates to work with devsite changes. Added a required `--project` flag for generating markdown docs.
+## 0.1.2
+### Patch Changes
+
+- [#4931](https://github.com/firebase/firebase-js-sdk/pull/4931) Support toc generation for Firebase devsite.
+## 0.1.1
+### Patch Changes
+
+- [#4869](https://github.com/firebase/firebase-js-sdk/pull/4869) Generate API docs for namespace members

package/dist/cli/MarkdownAction.d.ts

@@ -17,6 +17,8 @@
 import { ApiDocumenterCommandLine } from './ApiDocumenterCommandLine';
 import { BaseAction } from './BaseAction';
 export declare class MarkdownAction extends BaseAction {
+    private _sortFunctions;
     constructor(parser: ApiDocumenterCommandLine);
+    protected onDefineParameters(): void;
     protected onExecute(): Promise<void>;
 }

package/dist/cli/MarkdownAction.js

@@ -29,10 +29,21 @@ class MarkdownAction extends BaseAction_1.BaseAction {
                 ' Markdown format, suitable for example for publishing on a GitHub site.'
         });
     }
+    onDefineParameters() {
+        super.onDefineParameters();
+        this._sortFunctions = this.defineStringParameter({
+            parameterLongName: '--sort-functions',
+            argumentName: 'PRIORITY_PARAMS',
+            description: `Sorts functions tables and listings by first parameter. ` +
+                `Provide comma-separated strings for preferred params to be ` +
+                `ordered first. Alphabetical otherwise.`
+        });
+    }
     onExecute() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             // override
             const { apiModel, outputFolder, addFileNameSuffix, projectName } = this.buildApiModel();
+            const sortFunctions = this._sortFunctions.value || '';
             if (!projectName) {
                 throw new Error('No project name provided. Use --project.');
             }
@@ -41,7 +52,8 @@ class MarkdownAction extends BaseAction_1.BaseAction {
                 documenterConfig: undefined,
                 outputFolder,
                 addFileNameSuffix,
-                projectName
+                projectName,
+                sortFunctions
             });
             markdownDocumenter.generateFiles();
         });

package/dist/cli/MarkdownAction.js.map

@@ -1 +1 @@
-{"version":3,"file":"MarkdownAction.js","sourceRoot":"","sources":["../../src/cli/MarkdownAction.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;;AAMH,6CAA0C;AAC1C,0EAAuE;AAEvE,MAAa,cAAe,SAAQ,uBAAU;IAC5C,YAAmB,MAAgC;QACjD,KAAK,CAAC;YACJ,UAAU,EAAE,UAAU;YACtB,OAAO,EAAE,iDAAiD;YAC1D,aAAa,EACX,yDAAyD;gBACzD,yEAAyE;SAC5E,CAAC,CAAC;IACL,CAAC;IAEe,SAAS;;YACvB,WAAW;YACX,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,iBAAiB,EAAE,WAAW,EAAE,GAC9D,IAAI,CAAC,aAAa,EAAE,CAAC;YAEvB,IAAI,CAAC,WAAW,EAAE;gBAChB,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;aAC7D;YAED,MAAM,kBAAkB,GAAuB,IAAI,uCAAkB,CAAC;gBACpE,QAAQ;gBACR,gBAAgB,EAAE,SAAS;gBAC3B,YAAY;gBACZ,iBAAiB;gBACjB,WAAW;aACZ,CAAC,CAAC;YACH,kBAAkB,CAAC,aAAa,EAAE,CAAC;QACrC,CAAC;KAAA;CACF;AA7BD,wCA6BC"}
+{"version":3,"file":"MarkdownAction.js","sourceRoot":"","sources":["../../src/cli/MarkdownAction.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;;AAMH,6CAA0C;AAC1C,0EAAuE;AAGvE,MAAa,cAAe,SAAQ,uBAAU;IAE5C,YAAmB,MAAgC;QACjD,KAAK,CAAC;YACJ,UAAU,EAAE,UAAU;YACtB,OAAO,EAAE,iDAAiD;YAC1D,aAAa,EACX,yDAAyD;gBACzD,yEAAyE;SAC5E,CAAC,CAAC;IACL,CAAC;IAES,kBAAkB;QAC1B,KAAK,CAAC,kBAAkB,EAAE,CAAC;QAE3B,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,qBAAqB,CAAC;YAC/C,iBAAiB,EAAE,kBAAkB;YACrC,YAAY,EAAE,iBAAiB;YAC/B,WAAW,EACT,0DAA0D;gBAC1D,6DAA6D;gBAC7D,wCAAwC;SAC3C,CAAC,CAAC;IACL,CAAC;IAEe,SAAS;;YACvB,WAAW;YACX,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,iBAAiB,EAAE,WAAW,EAAE,GAC9D,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,MAAM,aAAa,GAAW,IAAI,CAAC,cAAc,CAAC,KAAK,IAAI,EAAE,CAAC;YAE9D,IAAI,CAAC,WAAW,EAAE;gBAChB,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;aAC7D;YAED,MAAM,kBAAkB,GAAuB,IAAI,uCAAkB,CAAC;gBACpE,QAAQ;gBACR,gBAAgB,EAAE,SAAS;gBAC3B,YAAY;gBACZ,iBAAiB;gBACjB,WAAW;gBACX,aAAa;aACd,CAAC,CAAC;YACH,kBAAkB,CAAC,aAAa,EAAE,CAAC;QACrC,CAAC;KAAA;CACF;AA7CD,wCA6CC"}

package/dist/cli/TocAction.js

@@ -53,7 +53,7 @@ class TocAction extends BaseAction_1.BaseAction {
             if (!g3Path) {
                 throw new Error('--g3-path is a required to generate toc, but it is not provided');
             }
-            toc_1.generateToc({
+            (0, toc_1.generateToc)({
                 apiModel,
                 outputFolder,
                 addFileNameSuffix,

package/dist/cli/TocAction.js.map

@@ -1 +1 @@
-{"version":3,"file":"TocAction.js","sourceRoot":"","sources":["../../src/cli/TocAction.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;;AAOH,6CAA0C;AAC1C,gCAAqC;AAErC,MAAa,SAAU,SAAQ,uBAAU;IAGvC,YAAmB,MAAgC;QACjD,KAAK,CAAC;YACJ,UAAU,EAAE,KAAK;YACjB,OAAO,EAAE,sDAAsD;YAC/D,aAAa,EAAE,sDAAsD;SACtE,CAAC,CAAC;IACL,CAAC;IAES,kBAAkB;QAC1B,KAAK,CAAC,kBAAkB,EAAE,CAAC;QAE3B,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,qBAAqB,CAAC;YACjD,iBAAiB,EAAE,aAAa;YAChC,kBAAkB,EAAE,IAAI;YACxB,YAAY,EAAE,UAAU;YACxB,WAAW,EAAE;kDAC+B;SAC7C,CAAC,CAAC;QAEH,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,mBAAmB,CAAC;YAC9C,iBAAiB,EAAE,UAAU;YAC7B,kBAAkB,EAAE,IAAI;YACxB,WAAW,EACT,yCAAyC;gBACzC,6DAA6D;SAChE,CAAC,CAAC;IACL,CAAC;IAEe,SAAS;;YACvB,WAAW;YACX,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;YAC3E,MAAM,MAAM,GAAuB,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC;YAC/D,MAAM,KAAK,GAAY,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC;YAElD,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,KAAK,CACb,iEAAiE,CAClE,CAAC;aACH;YAED,iBAAW,CAAC;gBACV,QAAQ;gBACR,YAAY;gBACZ,iBAAiB;gBACjB,MAAM;gBACN,KAAK;aACN,CAAC,CAAC;QACL,CAAC;KAAA;CACF;AAnDD,8BAmDC"}
+{"version":3,"file":"TocAction.js","sourceRoot":"","sources":["../../src/cli/TocAction.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;;AAOH,6CAA0C;AAC1C,gCAAqC;AAErC,MAAa,SAAU,SAAQ,uBAAU;IAGvC,YAAmB,MAAgC;QACjD,KAAK,CAAC;YACJ,UAAU,EAAE,KAAK;YACjB,OAAO,EAAE,sDAAsD;YAC/D,aAAa,EAAE,sDAAsD;SACtE,CAAC,CAAC;IACL,CAAC;IAES,kBAAkB;QAC1B,KAAK,CAAC,kBAAkB,EAAE,CAAC;QAE3B,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,qBAAqB,CAAC;YACjD,iBAAiB,EAAE,aAAa;YAChC,kBAAkB,EAAE,IAAI;YACxB,YAAY,EAAE,UAAU;YACxB,WAAW,EAAE;kDAC+B;SAC7C,CAAC,CAAC;QAEH,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,mBAAmB,CAAC;YAC9C,iBAAiB,EAAE,UAAU;YAC7B,kBAAkB,EAAE,IAAI;YACxB,WAAW,EACT,yCAAyC;gBACzC,6DAA6D;SAChE,CAAC,CAAC;IACL,CAAC;IAEe,SAAS;;YACvB,WAAW;YACX,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;YAC3E,MAAM,MAAM,GAAuB,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC;YAC/D,MAAM,KAAK,GAAY,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC;YAElD,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,KAAK,CACb,iEAAiE,CAClE,CAAC;aACH;YAED,IAAA,iBAAW,EAAC;gBACV,QAAQ;gBACR,YAAY;gBACZ,iBAAiB;gBACjB,MAAM;gBACN,KAAK;aACN,CAAC,CAAC;QACL,CAAC;KAAA;CACF;AAnDD,8BAmDC"}

package/dist/documenters/MarkdownDocumenter.d.ts

@@ -23,6 +23,7 @@ export interface IMarkdownDocumenterOptions {
     outputFolder: string;
     addFileNameSuffix: boolean;
     projectName: string;
+    sortFunctions: string;
 }
 /**
  * Renders API documentation in the Markdown file format.
@@ -37,6 +38,7 @@ export declare class MarkdownDocumenter {
     private readonly _pluginLoader;
     private readonly _addFileNameSuffix;
     private readonly _projectName;
+    private readonly _sortFunctions;
     constructor(options: IMarkdownDocumenterOptions);
     generateFiles(): void;
     _writeApiItemPage(apiItem: ApiItem): void;

package/dist/documenters/MarkdownDocumenter.js

@@ -47,6 +47,7 @@ class MarkdownDocumenter {
         this._outputFolder = options.outputFolder;
         this._addFileNameSuffix = options.addFileNameSuffix;
         this._projectName = options.projectName;
+        this._sortFunctions = options.sortFunctions;
         this._tsdocConfiguration = CustomDocNodeKind_1.CustomDocNodes.configuration;
         this._markdownEmitter = new CustomMarkdownEmitter_1.CustomMarkdownEmitter(this._apiModel);
         this._pluginLoader = new PluginLoader_1.PluginLoader();
@@ -59,7 +60,7 @@ class MarkdownDocumenter {
                     outputFolder: this._outputFolder,
                     documenter: new MarkdownDocumenterAccessor_1.MarkdownDocumenterAccessor({
                         getLinkForApiItem: (apiItem) => {
-                            return MarkdownDocumenterHelpers_1.getLinkForApiItem(apiItem, this._addFileNameSuffix);
+                            return (0, MarkdownDocumenterHelpers_1.getLinkForApiItem)(apiItem, this._addFileNameSuffix);
                         }
                     })
                 });
@@ -84,7 +85,7 @@ class MarkdownDocumenter {
         const pageWithoutHeading = nodes.slice(1);
         output.appendNodes(pageWithoutHeading);
         // write to file
-        const filename = path.join(this._outputFolder, MarkdownDocumenterHelpers_1.getFilenameForApiItem(apiItem, this._addFileNameSuffix));
+        const filename = path.join(this._outputFolder, (0, MarkdownDocumenterHelpers_1.getFilenameForApiItem)(apiItem, this._addFileNameSuffix));
         const stringBuilder = new tsdoc_1.StringBuilder();
         // devsite headers
         stringBuilder.append(`Project: /docs/reference/${this._projectName}/_project.yaml
@@ -95,7 +96,7 @@ page_type: reference
         this._markdownEmitter.emit(stringBuilder, output, {
             contextApiItem: apiItem,
             onGetFilenameForApiItem: (apiItemForFilename) => {
-                return MarkdownDocumenterHelpers_1.getLinkForApiItem(apiItemForFilename, this._addFileNameSuffix);
+                return (0, MarkdownDocumenterHelpers_1.getLinkForApiItem)(apiItemForFilename, this._addFileNameSuffix);
             }
         });
         let pageContent = stringBuilder.toString();
@@ -118,54 +119,54 @@ page_type: reference
         const output = [];
         const scopedName = apiItem.getScopedNameWithinPackage();
         switch (apiItem.kind) {
-            case "Class" /* Class */:
+            case "Class" /* ApiItemKind.Class */:
                 output.push(new DocHeading_1.DocHeading({ configuration, title: `${scopedName} class` }));
                 break;
-            case "Enum" /* Enum */:
+            case "Enum" /* ApiItemKind.Enum */:
                 output.push(new DocHeading_1.DocHeading({ configuration, title: `${scopedName}` }));
                 break;
-            case "Interface" /* Interface */:
+            case "Interface" /* ApiItemKind.Interface */:
                 output.push(new DocHeading_1.DocHeading({ configuration, title: `${scopedName} interface` }));
                 break;
-            case "Constructor" /* Constructor */:
-            case "ConstructSignature" /* ConstructSignature */:
+            case "Constructor" /* ApiItemKind.Constructor */:
+            case "ConstructSignature" /* ApiItemKind.ConstructSignature */:
                 output.push(new DocHeading_1.DocHeading({ configuration, title: scopedName }));
                 break;
-            case "Method" /* Method */:
-            case "MethodSignature" /* MethodSignature */:
+            case "Method" /* ApiItemKind.Method */:
+            case "MethodSignature" /* ApiItemKind.MethodSignature */:
                 output.push(new DocHeading_1.DocHeading({ configuration, title: `${scopedName}` }));
                 break;
-            case "Function" /* Function */:
+            case "Function" /* ApiItemKind.Function */:
                 output.push(new DocHeading_1.DocHeading({ configuration, title: `${scopedName}` }));
                 break;
-            case "Model" /* Model */:
+            case "Model" /* ApiItemKind.Model */:
                 output.push(new DocHeading_1.DocHeading({ configuration, title: `API Reference` }));
                 break;
-            case "Namespace" /* Namespace */:
+            case "Namespace" /* ApiItemKind.Namespace */:
                 output.push(new DocHeading_1.DocHeading({ configuration, title: `${scopedName} namespace` }));
                 break;
-            case "Package" /* Package */:
+            case "Package" /* ApiItemKind.Package */:
                 const unscopedPackageName = node_core_library_1.PackageName.getUnscopedName(apiItem.displayName);
                 output.push(new DocHeading_1.DocHeading({
                     configuration,
                     title: `${unscopedPackageName} package`
                 }));
                 break;
-            case "EntryPoint" /* EntryPoint */:
+            case "EntryPoint" /* ApiItemKind.EntryPoint */:
                 const packageName = apiItem.parent.displayName;
                 output.push(new DocHeading_1.DocHeading({
                     configuration,
                     title: `${packageName}${apiItem.displayName && '/' + apiItem.displayName}`
                 }));
                 break;
-            case "Property" /* Property */:
-            case "PropertySignature" /* PropertySignature */:
+            case "Property" /* ApiItemKind.Property */:
+            case "PropertySignature" /* ApiItemKind.PropertySignature */:
                 output.push(new DocHeading_1.DocHeading({ configuration, title: `${scopedName}` }));
                 break;
-            case "TypeAlias" /* TypeAlias */:
+            case "TypeAlias" /* ApiItemKind.TypeAlias */:
                 output.push(new DocHeading_1.DocHeading({ configuration, title: `${scopedName}` }));
                 break;
-            case "Variable" /* Variable */:
+            case "Variable" /* ApiItemKind.Variable */:
                 output.push(new DocHeading_1.DocHeading({ configuration, title: `${scopedName}` }));
                 break;
             default:
@@ -173,7 +174,7 @@ page_type: reference
         }
         if (api_extractor_model_me_1.ApiReleaseTagMixin.isBaseClassOf(apiItem)) {
             if (apiItem.releaseTag === api_extractor_model_me_1.ReleaseTag.Beta) {
-                output.push(MarkdownDocumenterHelpers_1.createBetaWarning(configuration));
+                output.push((0, MarkdownDocumenterHelpers_1.createBetaWarning)(configuration));
             }
         }
         if (apiItem instanceof api_extractor_model_me_1.ApiDocumentedItem) {
@@ -194,51 +195,51 @@ page_type: reference
             }
         }
         // render remark sections
-        output.push(...MarkdownDocumenterHelpers_1.createRemarksSection(apiItem, configuration));
+        output.push(...(0, MarkdownDocumenterHelpers_1.createRemarksSection)(apiItem, configuration));
         if (apiItem instanceof api_extractor_model_me_1.ApiDeclaredItem) {
             output.push(...this._createSignatureSection(apiItem));
         }
         switch (apiItem.kind) {
-            case "Class" /* Class */:
+            case "Class" /* ApiItemKind.Class */:
                 output.push(...this._createClassTables(apiItem));
                 break;
-            case "Enum" /* Enum */:
-                output.push(...MarkdownDocumenterHelpers_1.createEnumTables(apiItem, configuration));
+            case "Enum" /* ApiItemKind.Enum */:
+                output.push(...(0, MarkdownDocumenterHelpers_1.createEnumTables)(apiItem, configuration));
                 break;
-            case "Interface" /* Interface */:
+            case "Interface" /* ApiItemKind.Interface */:
                 output.push(...this._createInterfaceTables(apiItem));
                 break;
-            case "Constructor" /* Constructor */:
-            case "ConstructSignature" /* ConstructSignature */:
-            case "Method" /* Method */:
-            case "MethodSignature" /* MethodSignature */:
-            case "Function" /* Function */:
+            case "Constructor" /* ApiItemKind.Constructor */:
+            case "ConstructSignature" /* ApiItemKind.ConstructSignature */:
+            case "Method" /* ApiItemKind.Method */:
+            case "MethodSignature" /* ApiItemKind.MethodSignature */:
+            case "Function" /* ApiItemKind.Function */:
                 output.push(...this._createParameterTables(apiItem));
-                output.push(...MarkdownDocumenterHelpers_1.createThrowsSection(apiItem, configuration));
+                output.push(...(0, MarkdownDocumenterHelpers_1.createThrowsSection)(apiItem, configuration));
                 break;
-            case "Namespace" /* Namespace */:
+            case "Namespace" /* ApiItemKind.Namespace */:
                 output.push(...this._createEntryPointOrNamespace(apiItem));
                 break;
-            case "Model" /* Model */:
+            case "Model" /* ApiItemKind.Model */:
                 output.push(...this._createModelTable(apiItem));
                 break;
-            case "Package" /* Package */:
+            case "Package" /* ApiItemKind.Package */:
                 output.push(...this._createPackage(apiItem));
                 break;
-            case "EntryPoint" /* EntryPoint */:
+            case "EntryPoint" /* ApiItemKind.EntryPoint */:
                 output.push(...this._createEntryPointOrNamespace(apiItem));
                 break;
-            case "Property" /* Property */:
-            case "PropertySignature" /* PropertySignature */:
+            case "Property" /* ApiItemKind.Property */:
+            case "PropertySignature" /* ApiItemKind.PropertySignature */:
                 break;
-            case "TypeAlias" /* TypeAlias */:
+            case "TypeAlias" /* ApiItemKind.TypeAlias */:
                 break;
-            case "Variable" /* Variable */:
+            case "Variable" /* ApiItemKind.Variable */:
                 break;
             default:
                 throw new Error('Unsupported API item kind:2 ' + apiItem.kind);
         }
-        output.push(...MarkdownDocumenterHelpers_1.createExampleSection(apiItem, configuration));
+        output.push(...(0, MarkdownDocumenterHelpers_1.createExampleSection)(apiItem, configuration));
         return output;
     }
     /**
@@ -271,40 +272,40 @@ page_type: reference
         const eventsDefinitions = [];
         for (const apiMember of apiClass.members) {
             switch (apiMember.kind) {
-                case "Constructor" /* Constructor */: {
+                case "Constructor" /* ApiItemKind.Constructor */: {
                     constructorsTable.addRow(new DocTableRow_1.DocTableRow({ configuration }, [
-                        MarkdownDocumenterHelpers_1.createTitleCell(apiMember, configuration, this._addFileNameSuffix),
-                        MarkdownDocumenterHelpers_1.createModifiersCell(apiMember, configuration),
-                        MarkdownDocumenterHelpers_1.createDescriptionCell(apiMember, configuration)
+                        (0, MarkdownDocumenterHelpers_1.createTitleCell)(apiMember, configuration, this._addFileNameSuffix),
+                        (0, MarkdownDocumenterHelpers_1.createModifiersCell)(apiMember, configuration),
+                        (0, MarkdownDocumenterHelpers_1.createDescriptionCell)(apiMember, configuration)
                     ]));
                     constructorsDefinitions.push(...this._createCompleteOutputForApiItem(apiMember));
                     break;
                 }
-                case "Method" /* Method */: {
+                case "Method" /* ApiItemKind.Method */: {
                     methodsTable.addRow(new DocTableRow_1.DocTableRow({ configuration }, [
-                        MarkdownDocumenterHelpers_1.createTitleCell(apiMember, configuration, this._addFileNameSuffix),
-                        MarkdownDocumenterHelpers_1.createModifiersCell(apiMember, configuration),
-                        MarkdownDocumenterHelpers_1.createDescriptionCell(apiMember, configuration)
+                        (0, MarkdownDocumenterHelpers_1.createTitleCell)(apiMember, configuration, this._addFileNameSuffix),
+                        (0, MarkdownDocumenterHelpers_1.createModifiersCell)(apiMember, configuration),
+                        (0, MarkdownDocumenterHelpers_1.createDescriptionCell)(apiMember, configuration)
                     ]));
                     methodsDefinitions.push(...this._createCompleteOutputForApiItem(apiMember));
                     break;
                 }
-                case "Property" /* Property */: {
+                case "Property" /* ApiItemKind.Property */: {
                     if (apiMember.isEventProperty) {
                         eventsTable.addRow(new DocTableRow_1.DocTableRow({ configuration }, [
-                            MarkdownDocumenterHelpers_1.createTitleCell(apiMember, configuration, this._addFileNameSuffix),
-                            MarkdownDocumenterHelpers_1.createModifiersCell(apiMember, configuration),
+                            (0, MarkdownDocumenterHelpers_1.createTitleCell)(apiMember, configuration, this._addFileNameSuffix),
+                            (0, MarkdownDocumenterHelpers_1.createModifiersCell)(apiMember, configuration),
                             this._createPropertyTypeCell(apiMember),
-                            MarkdownDocumenterHelpers_1.createDescriptionCell(apiMember, configuration)
+                            (0, MarkdownDocumenterHelpers_1.createDescriptionCell)(apiMember, configuration)
                         ]));
                         eventsDefinitions.push(...this._createCompleteOutputForApiItem(apiMember));
                     }
                     else {
                         propertiesTable.addRow(new DocTableRow_1.DocTableRow({ configuration }, [
-                            MarkdownDocumenterHelpers_1.createTitleCell(apiMember, configuration, this._addFileNameSuffix),
-                            MarkdownDocumenterHelpers_1.createModifiersCell(apiMember, configuration),
+                            (0, MarkdownDocumenterHelpers_1.createTitleCell)(apiMember, configuration, this._addFileNameSuffix),
+                            (0, MarkdownDocumenterHelpers_1.createModifiersCell)(apiMember, configuration),
                             this._createPropertyTypeCell(apiMember),
-                            MarkdownDocumenterHelpers_1.createDescriptionCell(apiMember, configuration)
+                            (0, MarkdownDocumenterHelpers_1.createDescriptionCell)(apiMember, configuration)
                         ]));
                         propertiesDefinitions.push(...this._createCompleteOutputForApiItem(apiMember));
                     }
@@ -357,29 +358,29 @@ page_type: reference
         const eventsDefinitions = [];
         for (const apiMember of apiClass.members) {
             switch (apiMember.kind) {
-                case "ConstructSignature" /* ConstructSignature */:
-                case "MethodSignature" /* MethodSignature */: {
+                case "ConstructSignature" /* ApiItemKind.ConstructSignature */:
+                case "MethodSignature" /* ApiItemKind.MethodSignature */: {
                     methodsTable.addRow(new DocTableRow_1.DocTableRow({ configuration }, [
-                        MarkdownDocumenterHelpers_1.createTitleCell(apiMember, configuration, this._addFileNameSuffix),
-                        MarkdownDocumenterHelpers_1.createDescriptionCell(apiMember, configuration)
+                        (0, MarkdownDocumenterHelpers_1.createTitleCell)(apiMember, configuration, this._addFileNameSuffix),
+                        (0, MarkdownDocumenterHelpers_1.createDescriptionCell)(apiMember, configuration)
                     ]));
                     methodsDefinitions.push(...this._createCompleteOutputForApiItem(apiMember));
                     break;
                 }
-                case "PropertySignature" /* PropertySignature */: {
+                case "PropertySignature" /* ApiItemKind.PropertySignature */: {
                     if (apiMember.isEventProperty) {
                         eventsTable.addRow(new DocTableRow_1.DocTableRow({ configuration }, [
-                            MarkdownDocumenterHelpers_1.createTitleCell(apiMember, configuration, this._addFileNameSuffix),
+                            (0, MarkdownDocumenterHelpers_1.createTitleCell)(apiMember, configuration, this._addFileNameSuffix),
                             this._createPropertyTypeCell(apiMember),
-                            MarkdownDocumenterHelpers_1.createDescriptionCell(apiMember, configuration)
+                            (0, MarkdownDocumenterHelpers_1.createDescriptionCell)(apiMember, configuration)
                         ]));
                         eventsDefinitions.push(...this._createCompleteOutputForApiItem(apiMember));
                     }
                     else {
                         propertiesTable.addRow(new DocTableRow_1.DocTableRow({ configuration }, [
-                            MarkdownDocumenterHelpers_1.createTitleCell(apiMember, configuration, this._addFileNameSuffix),
+                            (0, MarkdownDocumenterHelpers_1.createTitleCell)(apiMember, configuration, this._addFileNameSuffix),
                             this._createPropertyTypeCell(apiMember),
-                            MarkdownDocumenterHelpers_1.createDescriptionCell(apiMember, configuration)
+                            (0, MarkdownDocumenterHelpers_1.createDescriptionCell)(apiMember, configuration)
                         ]));
                         propertiesDefinitions.push(...this._createCompleteOutputForApiItem(apiMember));
                     }
@@ -473,7 +474,7 @@ page_type: reference
             // discard any newlines and let the renderer do normal word-wrapping.
             const unwrappedTokenText = token.text.replace(/[\r\n]+/g, ' ');
             // If it's hyperlinkable, then append a DocLinkTag
-            if (token.kind === "Reference" /* Reference */ &&
+            if (token.kind === "Reference" /* ExcerptTokenKind.Reference */ &&
                 token.canonicalReference) {
                 const apiItemResult = this._apiModel.resolveDeclarationReference(token.canonicalReference, undefined);
                 if (apiItemResult.resolvedApiItem) {
@@ -481,7 +482,7 @@ page_type: reference
                         configuration,
                         tagName: '@link',
                         linkText: unwrappedTokenText,
-                        urlDestination: MarkdownDocumenterHelpers_1.getLinkForApiItem(apiItemResult.resolvedApiItem, this._addFileNameSuffix)
+                        urlDestination: (0, MarkdownDocumenterHelpers_1.getLinkForApiItem)(apiItemResult.resolvedApiItem, this._addFileNameSuffix)
                     }));
                     continue;
                 }
@@ -502,11 +503,11 @@ page_type: reference
         });
         for (const apiMember of apiModel.members) {
             const row = new DocTableRow_1.DocTableRow({ configuration }, [
-                MarkdownDocumenterHelpers_1.createTitleCell(apiMember, configuration, this._addFileNameSuffix),
-                MarkdownDocumenterHelpers_1.createDescriptionCell(apiMember, configuration)
+                (0, MarkdownDocumenterHelpers_1.createTitleCell)(apiMember, configuration, this._addFileNameSuffix),
+                (0, MarkdownDocumenterHelpers_1.createDescriptionCell)(apiMember, configuration)
             ]);
             switch (apiMember.kind) {
-                case "Package" /* Package */:
+                case "Package" /* ApiItemKind.Package */:
                     packagesTable.addRow(row);
                     this._writeApiItemPage(apiMember);
                     break;
@@ -535,8 +536,8 @@ page_type: reference
         });
         for (const entryPoint of apiContainer.entryPoints) {
             const row = new DocTableRow_1.DocTableRow({ configuration }, [
-                MarkdownDocumenterHelpers_1.createEntryPointTitleCell(entryPoint, configuration, this._addFileNameSuffix),
-                MarkdownDocumenterHelpers_1.createDescriptionCell(entryPoint, configuration)
+                (0, MarkdownDocumenterHelpers_1.createEntryPointTitleCell)(entryPoint, configuration, this._addFileNameSuffix),
+                (0, MarkdownDocumenterHelpers_1.createDescriptionCell)(entryPoint, configuration)
             ]);
             entryPointsTable.addRow(row);
         }
@@ -561,10 +562,11 @@ page_type: reference
             configuration,
             headerTitles: ['Enumeration', 'Description']
         });
-        const functionsTable = new DocTable_1.DocTable({
+        const finalFunctionsTable = new DocTable_1.DocTable({
             configuration,
             headerTitles: ['Function', 'Description']
         });
+        const functionsRowGroup = {};
         const interfacesTable = new DocTable_1.DocTable({
             configuration,
             headerTitles: ['Interface', 'Description']
@@ -581,52 +583,119 @@ page_type: reference
             configuration,
             headerTitles: ['Type Alias', 'Description']
         });
-        const functionsDefinitions = [];
+        const functionsDefinitionsGroup = {};
+        const finalFunctionsDefinitions = [];
         const variablesDefinitions = [];
         const typeAliasDefinitions = [];
         const enumsDefinitions = [];
-        const apiMembers = apiContainer.kind === "EntryPoint" /* EntryPoint */
+        const apiMembers = apiContainer.kind === "EntryPoint" /* ApiItemKind.EntryPoint */
             ? apiContainer.members
             : apiContainer.members;
         for (const apiMember of apiMembers) {
             const row = new DocTableRow_1.DocTableRow({ configuration }, [
-                MarkdownDocumenterHelpers_1.createTitleCell(apiMember, configuration, this._addFileNameSuffix),
-                MarkdownDocumenterHelpers_1.createDescriptionCell(apiMember, configuration)
+                (0, MarkdownDocumenterHelpers_1.createTitleCell)(apiMember, configuration, this._addFileNameSuffix),
+                (0, MarkdownDocumenterHelpers_1.createDescriptionCell)(apiMember, configuration)
             ]);
             switch (apiMember.kind) {
-                case "Class" /* Class */:
+                case "Class" /* ApiItemKind.Class */:
                     classesTable.addRow(row);
                     this._writeApiItemPage(apiMember);
                     break;
-                case "Enum" /* Enum */:
+                case "Enum" /* ApiItemKind.Enum */:
                     enumerationsTable.addRow(row);
                     enumsDefinitions.push(...this._createCompleteOutputForApiItem(apiMember));
                     break;
-                case "Interface" /* Interface */:
+                case "Interface" /* ApiItemKind.Interface */:
                     interfacesTable.addRow(row);
                     this._writeApiItemPage(apiMember);
                     break;
-                case "Namespace" /* Namespace */:
+                case "Namespace" /* ApiItemKind.Namespace */:
                     namespacesTable.addRow(row);
                     this._writeApiItemPage(apiMember);
                     break;
-                case "Function" /* Function */:
-                    functionsTable.addRow(row);
-                    functionsDefinitions.push(...this._createCompleteOutputForApiItem(apiMember));
+                case "Function" /* ApiItemKind.Function */:
+                    /**
+                     * If this option is set, group functions by first param.
+                     * Organize using a map where the key is the first param.
+                     */
+                    if (this._sortFunctions) {
+                        const firstParam = apiMember
+                            .parameters[0] || { name: '' };
+                        if (!functionsRowGroup[firstParam.name]) {
+                            functionsRowGroup[firstParam.name] = [];
+                        }
+                        if (!functionsDefinitionsGroup[firstParam.name]) {
+                            functionsDefinitionsGroup[firstParam.name] = [];
+                        }
+                        functionsRowGroup[firstParam.name].push(row);
+                        functionsDefinitionsGroup[firstParam.name].push(...this._createCompleteOutputForApiItem(apiMember));
+                    }
+                    else {
+                        finalFunctionsTable.addRow(row);
+                        finalFunctionsDefinitions.push(...this._createCompleteOutputForApiItem(apiMember));
+                    }
                     break;
-                case "TypeAlias" /* TypeAlias */:
+                case "TypeAlias" /* ApiItemKind.TypeAlias */:
                     typeAliasesTable.addRow(row);
                     typeAliasDefinitions.push(...this._createCompleteOutputForApiItem(apiMember));
                     break;
-                case "Variable" /* Variable */:
+                case "Variable" /* ApiItemKind.Variable */:
                     variablesTable.addRow(row);
                     variablesDefinitions.push(...this._createCompleteOutputForApiItem(apiMember));
                     break;
             }
         }
-        if (functionsTable.rows.length > 0) {
+        /**
+         * Sort the functions groups by first param. If priority params were
+         * provided to --sort-functions, will put them first in the order
+         * given.
+         */
+        if (this._sortFunctions) {
+            let priorityParams = [];
+            if (this._sortFunctions.includes(',')) {
+                priorityParams = this._sortFunctions.split(',');
+            }
+            else {
+                priorityParams = [this._sortFunctions];
+            }
+            const sortedFunctionsFirstParamKeys = Object.keys(functionsRowGroup).sort((a, b) => {
+                if (priorityParams.includes(a) && priorityParams.includes(b)) {
+                    return priorityParams.indexOf(a) - priorityParams.indexOf(b);
+                }
+                else if (priorityParams.includes(a)) {
+                    return -1;
+                }
+                else if (priorityParams.includes(b)) {
+                    return 1;
+                }
+                return a.localeCompare(b);
+            });
+            for (const paramKey of sortedFunctionsFirstParamKeys) {
+                // Header for each group of functions grouped by first param.
+                // Doesn't make sense if there's only one group.
+                const headerText = paramKey ? `function(${paramKey}...)` : 'function()';
+                if (sortedFunctionsFirstParamKeys.length > 1) {
+                    finalFunctionsTable.addRow(new DocTableRow_1.DocTableRow({ configuration }, [
+                        new DocTableCell_1.DocTableCell({ configuration }, [
+                            new tsdoc_1.DocParagraph({ configuration }, [
+                                new DocEmphasisSpan_1.DocEmphasisSpan({ configuration, bold: true }, [
+                                    new tsdoc_1.DocPlainText({ configuration, text: headerText })
+                                ])
+                            ])
+                        ])
+                    ]));
+                }
+                for (const functionsRow of functionsRowGroup[paramKey]) {
+                    finalFunctionsTable.addRow(functionsRow);
+                }
+                for (const functionDefinition of functionsDefinitionsGroup[paramKey]) {
+                    finalFunctionsDefinitions.push(functionDefinition);
+                }
+            }
+        }
+        if (finalFunctionsTable.rows.length > 0) {
             output.push(new DocHeading_1.DocHeading({ configuration, title: 'Functions' }));
-            output.push(functionsTable);
+            output.push(finalFunctionsTable);
         }
         if (classesTable.rows.length > 0) {
             output.push(new DocHeading_1.DocHeading({ configuration, title: 'Classes' }));
@@ -652,8 +721,8 @@ page_type: reference
             output.push(new DocHeading_1.DocHeading({ configuration, title: 'Type Aliases' }));
             output.push(typeAliasesTable);
         }
-        if (functionsDefinitions.length > 0) {
-            output.push(...functionsDefinitions);
+        if (finalFunctionsDefinitions.length > 0) {
+            output.push(...finalFunctionsDefinitions);
         }
         if (variablesDefinitions.length > 0) {
             output.push(...variablesDefinitions);