summaryrefslogtreecommitdiff
path: root/js/types.ts
diff options
context:
space:
mode:
authorKitson Kelly <me@kitsonkelly.com>2018-10-15 07:29:50 +1100
committerRyan Dahl <ry@tinyclouds.org>2018-10-14 17:38:23 -0400
commit10a97679ac80b4304c75d33cbc59c5736d11deb1 (patch)
treeb51b9183ed251f61373069e5c4d35e39603bedb2 /js/types.ts
parent1840a1971317f5b8fc6e322b3a414b7f8a593c88 (diff)
Align JSDoc to style guide.
Diffstat (limited to 'js/types.ts')
-rw-r--r--js/types.ts62
1 files changed, 20 insertions, 42 deletions
diff --git a/js/types.ts b/js/types.ts
index c29dedc81..4e35d1227 100644
--- a/js/types.ts
+++ b/js/types.ts
@@ -41,82 +41,60 @@ export interface ModuleInfo {
// tslint:enable:max-line-length
export interface CallSite {
- /**
- * Value of "this"
- */
+ /** Value of `this` */
// tslint:disable-next-line:no-any
getThis(): any;
- /**
- * Type of "this" as a string.
+ /** Type of `this` as a string.
+ *
* This is the name of the function stored in the constructor field of
- * "this", if available. Otherwise the object's [[Class]] internal
+ * `this`, if available. Otherwise the object's `[[Class]]` internal
* property.
*/
getTypeName(): string | null;
- /**
- * Current function
- */
+ /** Current function. */
getFunction(): Function | undefined;
- /**
- * Name of the current function, typically its name property.
+ /** Name of the current function, typically its name property.
+ *
* If a name property is not available an attempt will be made to try
* to infer a name from the function's context.
*/
getFunctionName(): string | null;
- /**
- * Name of the property [of "this" or one of its prototypes] that holds
- * the current function
+ /** Name of the property (of `this` or one of its prototypes) that holds
+ * the current function.
*/
getMethodName(): string | null;
- /**
- * Name of the script [if this function was defined in a script]
- */
+ /** Name of the script (if this function was defined in a script). */
getFileName(): string | null;
- /**
- * Get the script name or source URL for the source map
- */
+ /** Get the script name or source URL for the source map. */
getScriptNameOrSourceURL(): string;
- /**
- * Current line number [if this function was defined in a script]
- */
+ /** Current line number (if this function was defined in a script). */
getLineNumber(): number | null;
- /**
- * Current column number [if this function was defined in a script]
- */
+ /** Current column number (if this function was defined in a script). */
getColumnNumber(): number | null;
- /**
- * A call site object representing the location where eval was called
- * [if this function was created using a call to eval]
+ /** A call site object representing the location where eval was called (if
+ * this function was created using a call to `eval`)
*/
getEvalOrigin(): string | undefined;
- /**
- * Is this a toplevel invocation, that is, is "this" the global object?
- */
+ /** Is this a top level invocation, that is, is `this` the global object? */
isToplevel(): boolean;
- /**
- * Does this call take place in code defined by a call to eval?
- */
+ /** Does this call take place in code defined by a call to `eval`? */
isEval(): boolean;
- /**
- * Is this call in native V8 code?
- */
+ /** Is this call in native V8 code? */
isNative(): boolean;
- /**
- * Is this a constructor call?
- */
+ /** Is this a constructor call? */
isConstructor(): boolean;
}
@@ -136,7 +114,7 @@ export interface RawSourceMap extends StartOfSourceMap {
declare global {
// Declare "static" methods in Error
interface ErrorConstructor {
- /** Create .stack property on a target object */
+ /** Create `.stack` property on a target object */
captureStackTrace(targetObject: object, constructorOpt?: Function): void;
// tslint:disable:max-line-length