foster/denoland-deno
1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-12-31 03:29:10 -05:00
Code Issues Packages 1 Wiki Activity

chore: improve JSDoc for built-in APIs (#16048)

Browse source 
Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
This commit is contained in:
Kitson Kelly 2022-09-29 06:21:08 +10:00 committed by GitHub
parent e2828ad762
commit cfbcb3b613
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 1545 additions and 894 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2423
cli/dts/lib.deno.ns.d.ts vendored
View file

File diff suppressed because it is too large Load diff

14
cli/dts/lib.deno.shared_globals.d.ts vendored
View file

@ -542,10 +542,10 @@ declare class Worker extends EventTarget {
terminate(): void;
}
/** @category Performance API */
/** @category Performance */
declare type PerformanceEntryList = PerformanceEntry[];
/** @category Performance API */
/** @category Performance */
declare class Performance extends EventTarget {
/** Returns a timestamp representing the start of the performance measurement. */
readonly timeOrigin: number;
@ -595,10 +595,10 @@ declare class Performance extends EventTarget {
toJSON(): any;
}
/** @category Performance API */
/** @category Performance */
declare var performance: Performance;
/** @category Performance API */
/** @category Performance */
declare interface PerformanceMarkOptions {
/** Metadata to be included in the mark. */
detail?: any;
@ -627,7 +627,7 @@ declare interface PerformanceMeasureOptions {
* mark or measure (for example by calling the `.mark()` method) at an explicit
* point in an application.
*
* @category Performance API
* @category Performance
*/
declare class PerformanceEntry {
readonly duration: number;
@ -642,7 +642,7 @@ declare class PerformanceEntry {
* `performance.mark()` to add a named `DOMHighResTimeStamp` (the mark) to the
* performance timeline.
*
* @category Performance API
* @category Performance
*/
declare class PerformanceMark extends PerformanceEntry {
readonly detail: any;
@ -655,7 +655,7 @@ declare class PerformanceMark extends PerformanceEntry {
* `performance.measure()` to add a named `DOMHighResTimeStamp` (the measure)
* between two marks to the performance timeline.
*
* @category Performance API
* @category Performance
*/
declare class PerformanceMeasure extends PerformanceEntry {
readonly detail: any;

2
cli/tests/integration/lsp_tests.rs
View file

@ -1360,7 +1360,7 @@ fn lsp_hover_unstable_enabled() {
"language":"typescript",
"value":"const Deno.ppid: number"
},
"The pid of the current process's parent.",
"The process ID of parent process of this instance of the Deno CLI.\n\n```ts\nconsole.log(Deno.ppid);\n```",
"\n\n*@category* - Runtime Environment",
],
"range":{