ARROW-4396: [JS] Update Typedoc for TypeScript 3.2

js/package.json

@@ -20,7 +20,7 @@
     "clean:testdata": "gulp clean:testdata",
     "create:testdata": "gulp create:testdata",
     "test:coverage": "gulp test -t src --coverage",
-    "doc": "shx rm -rf ./doc && typedoc --tsconfig tsconfig.json --target ES5 --module commonjs --mode modules --ignoreCompilerErrors --out doc src",
+    "doc": "shx rm -rf ./doc && typedoc --options typedoc.js",
     "lint": "run-p lint:src lint:test",
     "lint:ci": "run-p lint:src:ci lint:test:ci",
     "lint:src": "tslint --fix --project -p tsconfig.json -c tslint.json \"src/**/*.ts\"",
@@ -70,43 +70,43 @@
   "devDependencies": {
     "@mattiasbuelens/web-streams-polyfill": "0.2.1",
     "@types/glob": "7.1.1",
-    "@types/jest": "23.3.10",
+    "@types/jest": "23.3.13",
     "async-done": "1.3.1",
     "benchmark": "2.1.4",
     "coveralls": "3.0.2",
     "del": "3.0.0",
-    "esm": "3.0.84",
+    "esm": "3.1.4",
     "glob": "7.1.3",
-    "google-closure-compiler": "20181210.0.0",
+    "google-closure-compiler": "20190121.0.0",
     "gulp": "4.0.0",
     "gulp-json-transform": "0.4.6",
     "gulp-rename": "1.4.0",
     "gulp-sourcemaps": "2.6.4",
     "gulp-typescript": "5.0.0",
-    "ix": "2.4.3",
+    "ix": "2.5.1",
     "jest": "23.6.0",
     "jest-environment-node-debug": "2.0.0",
     "jest-silent-reporter": "0.1.1",
     "json": "9.0.6",
-    "lerna": "3.8.0",
-    "memfs": "2.14.2",
+    "lerna": "3.10.7",
+    "memfs": "2.15.0",
     "mkdirp": "0.5.1",
     "multistream": "2.1.1",
     "npm-run-all": "4.1.5",
     "randomatic": "3.1.1",
-    "rimraf": "2.6.2",
+    "rimraf": "2.6.3",
     "rxjs": "5.5.11",
     "shx": "0.3.2",
     "source-map-loader": "0.2.4",
     "terser-webpack-plugin": "1.2.1",
     "trash": "4.3.0",
     "ts-jest": "23.10.5",
-    "ts-node": "7.0.1",
-    "tslint": "5.12.0",
-    "typedoc": "0.13.0",
-    "typescript": "3.2.2",
+    "ts-node": "8.0.2",
+    "tslint": "5.12.1",
+    "typedoc": "0.14.2",
+    "typescript": "3.2.4",
     "web-stream-tools": "0.0.1",
-    "webpack": "4.28.3",
+    "webpack": "4.29.0",
     "xml2js": "0.4.19"
   },
   "engines": {

js/src/Arrow.ts

@@ -84,6 +84,7 @@ import * as util_vector_ from './util/vector';
 import * as predicate from './compute/predicate';
 
 export { predicate };
+/** @ignore */
 export const util = {
     ...util_int_,
     ...util_bit_,

js/src/ipc/metadata/message.ts

@@ -184,6 +184,7 @@ export class FieldNode {
     }
 }
 
+/** @ignore */
 function messageHeaderFromJSON(message: any, type: MessageHeader) {
     return (() => {
         switch (type) {
@@ -195,6 +196,7 @@ function messageHeaderFromJSON(message: any, type: MessageHeader) {
     }) as MessageHeaderDecoder;
 }
 
+/** @ignore */
 function decodeMessageHeader(message: _Message, type: MessageHeader) {
     return (() => {
         switch (type) {

js/src/ipc/node/iterable.ts

@@ -18,6 +18,7 @@
 import { Readable } from 'stream';
 import { isIterable, isAsyncIterable } from '../../util/compat';
 
+/** @ignore */
 type ReadableOptions = import('stream').ReadableOptions;
 
 /** @ignore */

js/src/ipc/node/reader.ts

@@ -26,6 +26,7 @@ export function recordBatchReaderThroughNodeStream<T extends { [key: string]: Da
     return new RecordBatchReaderDuplex<T>(options);
 }
 
+/** @ignore */
 type CB = (error?: Error | null | undefined) => void;
 
 /** @ignore */

js/src/ipc/node/writer.ts

@@ -25,6 +25,7 @@ export function recordBatchWriterThroughNodeStream<T extends { [key: string]: Da
     return new RecordBatchWriterDuplex(new this<T>(options));
 }
 
+/** @ignore */
 type CB = (error?: Error | null | undefined) => void;
 
 /** @ignore */

js/src/util/bn.ts

@@ -17,10 +17,14 @@
 
 import { toArrayBufferView, ArrayBufferViewInput } from './buffer';
 
+/** @ignore */
 type BigNumArray = IntArray | UintArray;
+/** @ignore */
 type IntArray = Int8Array | Int16Array | Int32Array;
+/** @ignore */
 type UintArray = Uint8Array | Uint16Array | Uint32Array | Uint8ClampedArray;
 
+/** @ignore */
 const BigNumNMixin = {
     toJSON(this: BN<BigNumArray>, ) { return `"${bignumToString(this)}"`; },
     valueOf(this: BN<BigNumArray>, ) { return bignumToNumber(this); },

js/src/util/utf8.ts

@@ -21,8 +21,9 @@ import {
     TextEncoder as TextEncoderPolyfill,
 } from 'text-encoding-utf-8';
 
-/** @suppress {missingRequire} */
+/** @ignore @suppress {missingRequire} */
 const _Buffer = typeof Buffer === 'function' ? Buffer : null;
+/** @ignore */
 const useNativeEncoders = typeof TextDecoder === 'function' && typeof TextEncoder === 'function';
 
 /** @ignore */

js/src/vector/chunked.ts

@@ -23,7 +23,9 @@ import { DataType, Dictionary } from '../type';
 import { Clonable, Sliceable, Applicative } from '../vector';
 import { DictionaryVector } from './dictionary';
 
+/** @ignore */
 type ChunkedDict<T extends DataType> = T extends Dictionary ? T['dictionaryVector'] : null | never;
+/** @ignore */
 type ChunkedKeys<T extends DataType> = T extends Dictionary ? Vector<T['indices']> | Chunked<T['indices']> : null | never;
 
 /** @ignore */

js/src/visitor/bytewidth.ts

@@ -62,4 +62,5 @@ export class ByteWidthVisitor extends Visitor {
     public visitSchema          (schema: Schema        ) { return this.visitFields(schema.fields).reduce(sum, 0); }
 }
 
+/** @ignore */
 export const instance = new ByteWidthVisitor();

js/src/visitor/get.ts

@@ -312,4 +312,5 @@ GetVisitor.prototype.visitIntervalYearMonth    =    getIntervalYearMonth;
 GetVisitor.prototype.visitFixedSizeList        =        getFixedSizeList;
 GetVisitor.prototype.visitMap                  =               getNested;
 
+/** @ignore */
 export const instance = new GetVisitor();

js/src/visitor/indexof.ts

@@ -178,4 +178,5 @@ IndexOfVisitor.prototype.visitIntervalYearMonth    = indexOfValue;
 IndexOfVisitor.prototype.visitFixedSizeList        = indexOfValue;
 IndexOfVisitor.prototype.visitMap                  = indexOfValue;
 
+/** @ignore */
 export const instance = new IndexOfVisitor();

js/src/visitor/iterator.ts

@@ -167,4 +167,5 @@ IteratorVisitor.prototype.visitIntervalYearMonth    = vectorIterator;
 IteratorVisitor.prototype.visitFixedSizeList        = vectorIterator;
 IteratorVisitor.prototype.visitMap                  = vectorIterator;
 
+/** @ignore */
 export const instance = new IteratorVisitor();

js/src/visitor/set.ts

@@ -323,4 +323,5 @@ SetVisitor.prototype.visitIntervalYearMonth    =    setIntervalYearMonth;
 SetVisitor.prototype.visitFixedSizeList        =        setFixedSizeList;
 SetVisitor.prototype.visitMap                  =               setNested;
 
+/** @ignore */
 export const instance = new SetVisitor();

js/src/visitor/toarray.ts

@@ -148,4 +148,5 @@ ToArrayVisitor.prototype.visitIntervalYearMonth    = arrayOfVector;
 ToArrayVisitor.prototype.visitFixedSizeList        = arrayOfVector;
 ToArrayVisitor.prototype.visitMap                  = arrayOfVector;
 
+/** @ignore */
 export const instance = new ToArrayVisitor();

js/src/visitor/typeassembler.ts

@@ -151,4 +151,5 @@ export class TypeAssembler extends Visitor {
     }
 }
 
+/** @ignore */
 export const instance = new TypeAssembler();

js/src/visitor/typector.ts

@@ -76,4 +76,5 @@ export class GetDataTypeConstructor extends Visitor {
     public visitMap                  () { return type.Map_; }
 }
 
+/** @ignore */
 export const instance = new GetDataTypeConstructor();

js/src/visitor/vectorctor.ts

@@ -93,4 +93,5 @@ export class GetVectorConstructor extends Visitor {
     public visitMap                  () { return MapVector; }
 }
 
+/** @ignore */
 export const instance = new GetVectorConstructor();

js/typedoc.js

@@ -0,0 +1,35 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+module.exports = {
+    src: 'src',
+    out: 'doc',
+    mode: 'file',
+    name: 'Apache Arrow',
+    target: 'ES6',
+    module: 'commonjs',
+    tsconfig: 'tsconfig.json',
+    excludePrivate: true,
+    excludeProtected: true,
+    excludeNotExported: true,
+    includeDefinitions: true,
+    ignoreCompilerErrors: true,
+    exclude: [
+        'src/fb/*.ts',
+        'src/bin/*.ts'
+    ]
+};