vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-10-03 22:37:03 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Clean up comments for NodeJS.CallSite methods. Make "this" references clearer.

Browse Source
This commit is contained in:
Howard Mak
2017-12-07 13:46:40 -05:00
parent 4d1ff2f02e
commit 95b94efe8d
4 changed files with 184 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files
types/node/index.d.ts
Vendored
+46 -13
View File
@@ -322,43 +322,76 @@ declare namespace NodeJS {
}
export interface CallSite {
/** Value of this */
/**
* Value of "this"
*/
getThis(): any;
/** 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 property. */
/**
* 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
* property.
*/
getTypeName(): string | null;
/** Current function */
/**
* Current function
*/
getFunction(): Function | undefined;
/** 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. */
/**
* 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;
/** 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 toplevel 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;
}
types/node/v4/index.d.ts
Vendored
+46 -13
View File
@@ -240,43 +240,76 @@ declare namespace NodeJS {
}
export interface CallSite {
/** Value of this */
/**
* Value of "this"
*/
getThis(): any;
/** 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 property. */
/**
* 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
* property.
*/
getTypeName(): string | null;
/** Current function */
/**
* Current function
*/
getFunction(): Function | undefined;
/** 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. */
/**
* 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;
/** 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 toplevel 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;
}
types/node/v6/index.d.ts
Vendored
+46 -13
View File
@@ -269,43 +269,76 @@ declare namespace NodeJS {
}
export interface CallSite {
/** Value of this */
/**
* Value of "this"
*/
getThis(): any;
/** 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 property. */
/**
* 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
* property.
*/
getTypeName(): string | null;
/** Current function */
/**
* Current function
*/
getFunction(): Function | undefined;
/** 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. */
/**
* 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;
/** 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 toplevel 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;
}
types/node/v7/index.d.ts
Vendored
+46 -13
View File
@@ -281,43 +281,76 @@ declare namespace NodeJS {
}
export interface CallSite {
/** Value of this */
/**
* Value of "this"
*/
getThis(): any;
/** 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 property. */
/**
* 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
* property.
*/
getTypeName(): string | null;
/** Current function */
/**
* Current function
*/
getFunction(): Function | undefined;
/** 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. */
/**
* 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;
/** 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 toplevel 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;
}