summaryrefslogtreecommitdiff
path: root/js/global-eval.ts
diff options
context:
space:
mode:
authorKitson Kelly <me@kitsonkelly.com>2018-09-04 12:23:38 -0700
committerRyan Dahl <ry@tinyclouds.org>2018-09-05 08:45:55 -0400
commit10dc71133af211de40e29e7a7ab8c470a4a2c417 (patch)
treef44cd8d8dc430f22cec974ac4ccd4490453de20b /js/global-eval.ts
parent2c0d00840d09ce6d8f2b8615c9682ce4dfbfdb9d (diff)
Mark APIs at internal and include JSDoc in types
Diffstat (limited to 'js/global-eval.ts')
-rw-r--r--js/global-eval.ts14
1 files changed, 9 insertions, 5 deletions
diff --git a/js/global-eval.ts b/js/global-eval.ts
index ee37e6f24..1f77c4952 100644
--- a/js/global-eval.ts
+++ b/js/global-eval.ts
@@ -1,6 +1,10 @@
-// If you use the eval function indirectly, by invoking it via a reference
-// other than eval, as of ECMAScript 5 it works in the global scope rather than
-// the local scope. This means, for instance, that function declarations create
-// global functions, and that the code being evaluated doesn't have access to
-// local variables within the scope where it's being called.
+/**
+ * If you use the eval function indirectly, by invoking it via a reference
+ * other than eval, as of ECMAScript 5 it works in the global scope rather than
+ * the local scope. This means, for instance, that function declarations create
+ * global functions, and that the code being evaluated doesn't have access to
+ * local variables within the scope where it's being called.
+ *
+ * @internal
+ */
export const globalEval = eval;