Update dependencies

Author: michaelkourlas

.gitignore

@@ -1,5 +1,5 @@
-# WebStorm
-.idea/
+# Visual Studio Code
+.vscode/
 
 # JavaScript and TypeScript
 lib/

.travis.yml

@@ -39,7 +39,7 @@
     "clean-docs": "rimraf docs",
     "clean-test": "rimraf test/lib",
     "dev": "npm run-script clean && npm run-script lint && tsc -p tsconfig.json --sourceMap",
-    "docs": "npm run-script clean-docs && typedoc --mode file --module commonjs --out docs --target es5 --tsconfig tsconfig.json",
+    "docs": "npm run-script clean-docs && typedoc src/main.ts",
     "lint": "eslint . --ext .ts",
     "prod": "npm run-script clean && npm run-script lint && tsc -p tsconfig.json",
     "test-dev": "npm run-script clean-test && tsc -p test/tsconfig.json --sourceMap && mocha test/lib",
@@ -49,15 +49,15 @@
     "xmlcreate": "^2.0.3"
   },
   "devDependencies": {
-    "@types/chai": "^4.2.8",
-    "@types/mocha": "^7.0.1",
-    "@typescript-eslint/eslint-plugin": "^2.18.0",
-    "@typescript-eslint/parser": "^2.18.0",
+    "@types/chai": "^4.2.14",
+    "@types/mocha": "^8.2.0",
+    "@typescript-eslint/eslint-plugin": "^4.14.0",
+    "@typescript-eslint/parser": "^4.14.0",
     "chai": "^4.2.0",
-    "eslint": "^6.8.0",
-    "mocha": "^7.0.1",
-    "rimraf": "^3.0.1",
-    "typedoc": "^0.16.9",
-    "typescript": "^3.7.5"
+    "eslint": "^7.18.0",
+    "mocha": "^8.2.1",
+    "rimraf": "^3.0.2",
+    "typedoc": "^0.20.17",
+    "typescript": "^4.1.3"
   }
 }

package-lock.json

@@ -25,6 +25,14 @@ import {
     stringify
 } from "./utils";
 
+export {
+    IOptions,
+    IDeclarationOptions,
+    IDtdOptions,
+    ITypeHandlers,
+    IWrapHandlers,
+} from "./options";
+
 /**
  * Indicates that an object of a particular type should be suppressed from the
  * XML output.
@@ -40,15 +48,13 @@ export class Absent {
     /**
      * Returns the sole instance of Absent.
      */
-    public static get instance() {
+    public static get instance(): Absent {
         return Absent._instance;
     }
 }
 
 /**
  * Gets the type handler associated with a value.
- *
- * @private
  */
 function getHandler(value: unknown,
                     options: Options): ((value: unknown) => unknown) | undefined
@@ -66,8 +72,6 @@ function getHandler(value: unknown,
 
 /**
  * Parses a string into XML and adds it to the parent element or attribute.
- *
- * @private
  */
 function parseString(str: string,
                      parentElement: XmlAttribute<unknown> | XmlElement<unknown>,
@@ -126,8 +130,6 @@ function parseString(str: string,
 
 /**
  * Parses an attribute into XML and adds it to the parent element.
- *
- * @private
  */
 function parseAttribute(name: string, value: string,
                         parentElement: XmlElement<unknown>,
@@ -143,8 +145,6 @@ function parseAttribute(name: string, value: string,
 
 /**
  * Parses an object or Map entry into XML and adds it to the parent element.
- *
- * @private
  */
 function parseObjectOrMapEntry(key: string, value: unknown,
                                parentElement: XmlElement<unknown>,
@@ -194,8 +194,6 @@ function parseObjectOrMapEntry(key: string, value: unknown,
 
 /**
  * Parses an Object or Map into XML and adds it to the parent element.
- *
- * @private
  */
 function parseObjectOrMap(
     objectOrMap: Record<string, unknown> | Map<unknown, unknown>,
@@ -217,8 +215,6 @@ function parseObjectOrMap(
 
 /**
  * Parses an array or Set into XML and adds it to the parent element.
- *
- * @private
  */
 function parseArrayOrSet(key: string, arrayOrSet: unknown[] | Set<unknown>,
                          parentElement: XmlElement<unknown>,
@@ -275,8 +271,6 @@ function parseArrayOrSet(key: string, arrayOrSet: unknown[] | Set<unknown>,
 /**
  * Parses an arbitrary JavaScript value into XML and adds it to the parent
  * element.
- *
- * @private
  */
 function parseValue(key: string, value: unknown,
                     parentElement: XmlElement<unknown>,
@@ -303,15 +297,15 @@ function parseValue(key: string, value: unknown,
 
 /**
  * Converts the specified object to XML and adds the XML representation to the
- * specified XmlDocument object using the specified options.
+ * specified XmlElement object using the specified options.
  *
  * This function does not add a root element. In addition, it does not add an
  * XML declaration or DTD, and the associated options in {@link IOptions} are
  * ignored. If desired, these must be added manually.
  */
 export function parseToExistingElement(element: XmlElement<unknown>,
                                        object: unknown,
-                                       options?: IOptions)
+                                       options?: IOptions): void
 {
     const opts: Options = new Options(options);
     parseValue(element.name, object, element, opts);

package.json

@@ -299,8 +299,6 @@ export interface IOptions {
 /**
  * Implementation of the IOptions interface used to provide default values
  * to fields.
- *
- * @private
  */
 export class Options implements IOptions {
     public aliasString = "=";
@@ -398,8 +396,6 @@ export interface IDeclarationOptions {
 /**
  * Implementation of the IDeclarationOptions interface used to provide default
  * values to fields.
- *
- * @private
  */
 export class DeclarationOptions implements IDeclarationOptions {
     public include = true;
@@ -455,8 +451,6 @@ export interface IDtdOptions {
 /**
  * Implementation of the IDtdOptions interface used to provide default values
  * to fields.
- *
- * @private
  */
 export class DtdOptions implements IDtdOptions {
     public include = false;
@@ -509,8 +503,6 @@ export interface IFormatOptions {
 /**
  * Implementation of the IFormatOptions interface used to provide default values
  * to fields.
- *
- * @private
  */
 export class FormatOptions implements IFormatOptions {
     public doubleQuotes?: boolean;
@@ -541,8 +533,6 @@ export interface ITypeHandlers {
 /**
  * Implementation of the ITypeHandlers interface used to provide default values
  * to fields.
- *
- * @private
  */
 export class TypeHandlers implements ITypeHandlers {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -577,8 +567,6 @@ export interface IWrapHandlers {
 /**
  * Implementation of the IWrapHandlers interface used to provide default values
  * to fields.
- *
- * @private
  */
 export class WrapHandlers implements IWrapHandlers {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any

src/main.ts

@@ -14,51 +14,26 @@
  * limitations under the License.
  */
 
-/**
- * @private
- */
 export function isUndefined(val: unknown): val is undefined {
     return Object.prototype.toString.call(val) === "[object Undefined]";
 }
 
-/**
- * @private
- */
 export function isNull(val: unknown): val is null {
     return Object.prototype.toString.call(val) === "[object Null]";
 }
 
-/**
- * @private
- */
 export function isObject(val: unknown): val is Record<string, unknown> {
     return Object.prototype.toString.call(val) === "[object Object]";
 }
 
-/**
- * @private
- */
 export function isArray(val: unknown): val is unknown[] {
     return Object.prototype.toString.call(val) === "[object Array]";
 }
 
-/**
- * @private
- */
-export function isFunction(val: unknown): val is Function {
-    return Object.prototype.toString.call(val) === "[object Function]";
-}
-
-/**
- * @private
- */
 export function isSet(val: unknown): val is Set<unknown> {
     return Object.prototype.toString.call(val) === "[object Set]";
 }
 
-/**
- * @private
- */
 export function isMap(val: unknown): val is Map<unknown, unknown> {
     return Object.prototype.toString.call(val) === "[object Map]";
 }
@@ -71,13 +46,12 @@ export function isMap(val: unknown): val is Map<unknown, unknown> {
  * @param value The value to convert to a string.
  *
  * @returns A string representation of the specified value.
- *
- * @private
  */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
+// eslint-disable-next-line max-len
+// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
 export function stringify(value: any): string {
     if (!isUndefined(value) && !isNull(value)) {
-        if (!isFunction(value?.toString)) {
+        if (value?.toString) {
             value = value.toString();
         }
     }

src/options.ts

@@ -17,7 +17,6 @@
 import {assert} from "chai";
 import {
     isArray,
-    isFunction,
     isMap,
     isNull,
     isObject,
@@ -84,21 +83,6 @@ describe("utils", () => {
         });
     });
 
-    describe("#isFunction", () => {
-        it("should return true for functions", () => {
-            assert.isTrue(isFunction(() => 0));
-            assert.isTrue(isFunction(() => "test"));
-        });
-
-        it("should return false for values that are not functions", () => {
-            assert.isFalse(isFunction("test"));
-            assert.isFalse(isFunction(3));
-            assert.isFalse(isFunction(undefined));
-            assert.isFalse(isFunction(true));
-            assert.isFalse(isFunction(null));
-        });
-    });
-
     describe("#isSet", () => {
         it("should return true for sets", () => {
             assert.isTrue(isSet(new Set()));