init some jsdoc on a couple utils methods

inst/www/shared/shiny-testmode.js

@@ -1,3 +1,3 @@
 /*! shiny 1.6.0.9021 | (c) 2012-2021 RStudio, PBC. | License: GPL-3 | file LICENSE */
 (function(){var a=eval;window.addEventListener("message",function(i){var e=i.data;e.code&&a(e.code)});})();
-//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vc3JjdHMvc3JjL3V0aWxzL2V2YWwudHMiLCAiLi4vLi4vLi4vc3JjdHMvZXh0cmFzL3NoaW55LXRlc3Rtb2RlLnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyIvL2VzYnVpbGQuZ2l0aHViLmlvL2NvbnRlbnQtdHlwZXMvI2RpcmVjdC1ldmFsXG4vL3RsL2RyO1xuLy8gKiBEaXJlY3QgdXNhZ2Ugb2YgYGV2YWwoXCJ4XCIpYCBpcyBiYWQgd2l0aCBidW5kbGVkIGNvZGUuXG4vLyAqIEluc3RlYWQsIHVzZSBpbmRpcmVjdCBjYWxscyB0byBgZXZhbGAgc3VjaCBhcyBgaW5kaXJlY3RFdmFsKFwieFwiKWBcbi8vICAgKiBFdmVuIGp1c3QgcmVuYW1pbmcgdGhlIGZ1bmN0aW9uIHdvcmtzIHdlbGwgZW5vdWdoLlxuLy8gPiBUaGlzIGlzIGtub3duIGFzIFwiaW5kaXJlY3QgZXZhbFwiIGJlY2F1c2UgZXZhbCBpcyBub3QgYmVpbmcgY2FsbGVkIGRpcmVjdGx5LCBhbmQgc28gZG9lcyBub3QgdHJpZ2dlciB0aGUgZ3JhbW1hdGljYWwgc3BlY2lhbCBjYXNlIGZvciBkaXJlY3QgZXZhbCBpbiB0aGUgSmF2YVNjcmlwdCBWTS4gWW91IGNhbiBjYWxsIGluZGlyZWN0IGV2YWwgdXNpbmcgYW55IHN5bnRheCBhdCBhbGwgZXhjZXB0IGZvciBhbiBleHByZXNzaW9uIG9mIHRoZSBleGFjdCBmb3JtIGV2YWwoJ3gnKS4gRm9yIGV4YW1wbGUsIHZhciBldmFsMiA9IGV2YWw7IGV2YWwyKCd4JykgYW5kIFtldmFsXVswXSgneCcpIGFuZCB3aW5kb3cuZXZhbCgneCcpIGFyZSBhbGwgaW5kaXJlY3QgZXZhbCBjYWxscy5cbi8vID4gV2hlbiB5b3UgdXNlIGluZGlyZWN0IGV2YWwsIHRoZSBjb2RlIGlzIGV2YWx1YXRlZCBpbiB0aGUgZ2xvYmFsIHNjb3BlIGluc3RlYWQgb2YgaW4gdGhlIGlubGluZSBzY29wZSBvZiB0aGUgY2FsbGVyLlxudmFyIGluZGlyZWN0RXZhbCA9IGV2YWw7XG5leHBvcnQgeyBpbmRpcmVjdEV2YWwgfTsiLCAiaW1wb3J0IHsgaW5kaXJlY3RFdmFsIH0gZnJvbSBcIi4uL3NyYy91dGlscy9ldmFsXCI7IC8vIExpc3RlbiBmb3IgbWVzc2FnZXMgZnJvbSBwYXJlbnQgZnJhbWUuIFRoaXMgZmlsZSBpcyBvbmx5IGFkZGVkIHdoZW4gdGhlXG4vLyBzaGlueS50ZXN0bW9kZSBvcHRpb24gaXMgVFJVRS5cblxud2luZG93LmFkZEV2ZW50TGlzdGVuZXIoXCJtZXNzYWdlXCIsIGZ1bmN0aW9uIChlKSB7XG4gIHZhciBtZXNzYWdlID0gZS5kYXRhO1xuICBpZiAobWVzc2FnZS5jb2RlKSBpbmRpcmVjdEV2YWwobWVzc2FnZS5jb2RlKTtcbn0pOyJdLAogICJtYXBwaW5ncyI6ICI7WUFPQSxHQUFJLEdBQWUsS0NKbkIsT0FBTyxpQkFBaUIsVUFBVyxTQUFVLEVBQUcsQ0FDOUMsR0FBSSxHQUFVLEVBQUUsS0FDaEIsQUFBSSxFQUFRLE1BQU0sRUFBYSxFQUFRIiwKICAibmFtZXMiOiBbXQp9Cg==
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vc3JjdHMvc3JjL3V0aWxzL2V2YWwudHMiLCAiLi4vLi4vLi4vc3JjdHMvZXh0cmFzL3NoaW55LXRlc3Rtb2RlLnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyIvL2VzYnVpbGQuZ2l0aHViLmlvL2NvbnRlbnQtdHlwZXMvI2RpcmVjdC1ldmFsXG4vL3RsL2RyO1xuLy8gKiBEaXJlY3QgdXNhZ2Ugb2YgYGV2YWwoXCJ4XCIpYCBpcyBiYWQgd2l0aCBidW5kbGVkIGNvZGUuXG4vLyAqIEluc3RlYWQsIHVzZSBpbmRpcmVjdCBjYWxscyB0byBgZXZhbGAgc3VjaCBhcyBgaW5kaXJlY3RFdmFsKFwieFwiKWBcbi8vICAgKiBFdmVuIGp1c3QgcmVuYW1pbmcgdGhlIGZ1bmN0aW9uIHdvcmtzIHdlbGwgZW5vdWdoLlxuLy8gPiBUaGlzIGlzIGtub3duIGFzIFwiaW5kaXJlY3QgZXZhbFwiIGJlY2F1c2UgZXZhbCBpcyBub3QgYmVpbmcgY2FsbGVkIGRpcmVjdGx5LCBhbmQgc28gZG9lcyBub3QgdHJpZ2dlciB0aGUgZ3JhbW1hdGljYWwgc3BlY2lhbCBjYXNlIGZvciBkaXJlY3QgZXZhbCBpbiB0aGUgSmF2YVNjcmlwdCBWTS4gWW91IGNhbiBjYWxsIGluZGlyZWN0IGV2YWwgdXNpbmcgYW55IHN5bnRheCBhdCBhbGwgZXhjZXB0IGZvciBhbiBleHByZXNzaW9uIG9mIHRoZSBleGFjdCBmb3JtIGV2YWwoJ3gnKS4gRm9yIGV4YW1wbGUsIHZhciBldmFsMiA9IGV2YWw7IGV2YWwyKCd4JykgYW5kIFtldmFsXVswXSgneCcpIGFuZCB3aW5kb3cuZXZhbCgneCcpIGFyZSBhbGwgaW5kaXJlY3QgZXZhbCBjYWxscy5cbi8vID4gV2hlbiB5b3UgdXNlIGluZGlyZWN0IGV2YWwsIHRoZSBjb2RlIGlzIGV2YWx1YXRlZCBpbiB0aGUgZ2xvYmFsIHNjb3BlIGluc3RlYWQgb2YgaW4gdGhlIGlubGluZSBzY29wZSBvZiB0aGUgY2FsbGVyLlxuXG4vKipcbiAqIEV2YWx1YXRlcyBKYXZhU2NyaXB0IGNvZGUgYW5kIGV4ZWN1dGVzIGl0IHZpYSBfSW5kaXJlY3QgRXZhbHVhdGlvbl9cbiAqIEBwYXJhbSB5IEEgU3RyaW5nIHZhbHVlIHRoYXQgY29udGFpbnMgdmFsaWQgSmF2YVNjcmlwdCBjb2RlLlxuICpcbiAqIEZyb20gW2VzYnVpbGRdKGVzYnVpbGQuZ2l0aHViLmlvL2NvbnRlbnQtdHlwZXMvI2RpcmVjdC1ldmFsKTogRGlyZWN0IHVzYWdlIG9mIGBldmFsKFwieFwiKWAgaXMgYmFkIHdpdGggYnVuZGxlZCBjb2RlLiBJbnN0ZWFkLCB1c2UgaW5kaXJlY3QgY2FsbHMgdG8gYGV2YWxgIHN1Y2ggYXMgYGluZGlyZWN0RXZhbChcInhcIilgLiBFdmVuIGp1c3QgcmVuYW1pbmcgdGhlIGZ1bmN0aW9uIHdvcmtzIHdlbGwgZW5vdWdoLlxuICpcbiAqID4gVGhpcyBpcyBrbm93biBhcyBcImluZGlyZWN0IGV2YWxcIiBiZWNhdXNlIGV2YWwgaXMgbm90IGJlaW5nIGNhbGxlZCBkaXJlY3RseSwgYW5kIHNvIGRvZXMgbm90IHRyaWdnZXIgdGhlIGdyYW1tYXRpY2FsIHNwZWNpYWwgY2FzZSBmb3IgZGlyZWN0IGV2YWwgaW4gdGhlIEphdmFTY3JpcHQgVk0uIFlvdSBjYW4gY2FsbCBpbmRpcmVjdCBldmFsIHVzaW5nIGFueSBzeW50YXggYXQgYWxsIGV4Y2VwdCBmb3IgYW4gZXhwcmVzc2lvbiBvZiB0aGUgZXhhY3QgZm9ybSBgZXZhbCgneCcpYC4gRm9yIGV4YW1wbGUsIGB2YXIgZXZhbDIgPSBldmFsOyBldmFsMigneCcpYCBhbmQgYFtldmFsXVswXSgneCcpYCBhbmQgd2luZG93LmBldmFsKCd4JylgIGFyZSBhbGwgaW5kaXJlY3QgZXZhbCBjYWxscy5cbiAqID4gV2hlbiB5b3UgdXNlIGluZGlyZWN0IGV2YWwsIHRoZSBjb2RlIGlzIGV2YWx1YXRlZCBpbiB0aGUgZ2xvYmFsIHNjb3BlIGluc3RlYWQgb2YgaW4gdGhlIGlubGluZSBzY29wZSBvZiB0aGUgY2FsbGVyLlxuICpcbiAqL1xudmFyIGluZGlyZWN0RXZhbCA9IGV2YWw7XG5leHBvcnQgeyBpbmRpcmVjdEV2YWwgfTsiLCAiaW1wb3J0IHsgaW5kaXJlY3RFdmFsIH0gZnJvbSBcIi4uL3NyYy91dGlscy9ldmFsXCI7IC8vIExpc3RlbiBmb3IgbWVzc2FnZXMgZnJvbSBwYXJlbnQgZnJhbWUuIFRoaXMgZmlsZSBpcyBvbmx5IGFkZGVkIHdoZW4gdGhlXG4vLyBzaGlueS50ZXN0bW9kZSBvcHRpb24gaXMgVFJVRS5cblxud2luZG93LmFkZEV2ZW50TGlzdGVuZXIoXCJtZXNzYWdlXCIsIGZ1bmN0aW9uIChlKSB7XG4gIHZhciBtZXNzYWdlID0gZS5kYXRhO1xuICBpZiAobWVzc2FnZS5jb2RlKSBpbmRpcmVjdEV2YWwobWVzc2FnZS5jb2RlKTtcbn0pOyJdLAogICJtYXBwaW5ncyI6ICI7WUFrQkEsR0FBSSxHQUFlLEtDZm5CLE9BQU8saUJBQWlCLFVBQVcsU0FBVSxFQUFHLENBQzlDLEdBQUksR0FBVSxFQUFFLEtBQ2hCLEFBQUksRUFBUSxNQUFNLEVBQWEsRUFBUSIsCiAgIm5hbWVzIjogW10KfQo=

srcts/TODO.md

@@ -92,11 +92,16 @@
 * √ Completely remove `parcel` from `./package.json` and only use `esbuild`
 * √ Delete 'shiny-es5' files
 * Delete 'old' folder
+  * Maybe not. Might be good to keep for a cycle.
 * _Uglify_ js files (like in previous Gruntfile.js)
   * datepicker
   * ionrangeslider
   * selectize
-
+* Documentation
+  * Check out
+    * https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html#this
+    * https://github.com/gajus/eslint-plugin-jsdoc
+  * Looks like it can handle markdown
 
 
 # Eventual TODO

srcts/src/utils/eval.ts

@@ -6,6 +6,16 @@
 // > This is known as "indirect eval" because eval is not being called directly, and so does not trigger the grammatical special case for direct eval in the JavaScript VM. You can call indirect eval using any syntax at all except for an expression of the exact form eval('x'). For example, var eval2 = eval; eval2('x') and [eval][0]('x') and window.eval('x') are all indirect eval calls.
 // > When you use indirect eval, the code is evaluated in the global scope instead of in the inline scope of the caller.
 
+/**
+ * Evaluates JavaScript code and executes it via _Indirect Evaluation_
+ * @param y A String value that contains valid JavaScript code.
+ *
+ * From [esbuild](esbuild.github.io/content-types/#direct-eval): Direct usage of `eval("x")` is bad with bundled code. Instead, use indirect calls to `eval` such as `indirectEval("x")`. Even just renaming the function works well enough.
+ *
+ * > This is known as "indirect eval" because eval is not being called directly, and so does not trigger the grammatical special case for direct eval in the JavaScript VM. You can call indirect eval using any syntax at all except for an expression of the exact form `eval('x')`. For example, `var eval2 = eval; eval2('x')` and `[eval][0]('x')` and window.`eval('x')` are all indirect eval calls.
+ * > When you use indirect eval, the code is evaluated in the global scope instead of in the inline scope of the caller.
+ *
+ */
 const indirectEval = eval;
 
 export { indirectEval };

srcts/src/utils/object.ts

@@ -1,3 +1,9 @@
+/**
+ * Wrapper around `Object.prototype.hasOwnProperty.call(x,y)`
+ * @param x Object to inspect
+ * @param y Key to inspect in `x`
+ * @returns Whether object `x` actually has property `y`.
+ * */
 function hasOwnProperty(x: { [key: string]: unknown }, y: string): boolean {
   return Object.prototype.hasOwnProperty.call(x, y);
 }

srcts/types/utils/eval.d.ts

@@ -1,2 +1,12 @@
+/**
+ * Evaluates JavaScript code and executes it via _Indirect Evaluation_
+ * @param y A String value that contains valid JavaScript code.
+ *
+ * From [esbuild](esbuild.github.io/content-types/#direct-eval): Direct usage of `eval("x")` is bad with bundled code. Instead, use indirect calls to `eval` such as `indirectEval("x")`. Even just renaming the function works well enough.
+ *
+ * > This is known as "indirect eval" because eval is not being called directly, and so does not trigger the grammatical special case for direct eval in the JavaScript VM. You can call indirect eval using any syntax at all except for an expression of the exact form `eval('x')`. For example, `var eval2 = eval; eval2('x')` and `[eval][0]('x')` and window.`eval('x')` are all indirect eval calls.
+ * > When you use indirect eval, the code is evaluated in the global scope instead of in the inline scope of the caller.
+ *
+ */
 declare const indirectEval: typeof eval;
 export { indirectEval };

srcts/types/utils/object.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Wrapper around `Object.prototype.hasOwnProperty.call(x,y)`
+ * @param x Object to inspect
+ * @param y Key to inspect in `x`
+ * @returns Whether object `x` actually has property `y`.
+ * */
 declare function hasOwnProperty(x: {
     [key: string]: unknown;
 }, y: string): boolean;