Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update categories to match new planned sitemap #23677

Merged
merged 4 commits into from
May 6, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
74 changes: 37 additions & 37 deletions cli/tsc/dts/lib.deno.ns.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
* to ensure that these are still available when using the Deno namespace in
* conjunction with other type libs, like `dom`.
*
* @category ES Modules
* @category Platform
*/
declare interface ImportMeta {
/** A string representation of the fully qualified module URL. When the
Expand Down Expand Up @@ -322,7 +322,7 @@ declare namespace Deno {
* console.log(Deno.pid);
* ```
*
* @category Runtime Environment
* @category Runtime
*/
export const pid: number;

Expand All @@ -333,11 +333,11 @@ declare namespace Deno {
* console.log(Deno.ppid);
* ```
*
* @category Runtime Environment
* @category Runtime
*/
export const ppid: number;

/** @category Runtime Environment */
/** @category Runtime */
export interface MemoryUsage {
/** The number of bytes of the current Deno's process resident set size,
* which is the amount of memory occupied in main memory (RAM). */
Expand All @@ -355,7 +355,7 @@ declare namespace Deno {
* Returns an object describing the memory usage of the Deno process and the
* V8 subsystem measured in bytes.
*
* @category Runtime Environment
* @category Runtime
*/
export function memoryUsage(): MemoryUsage;

Expand All @@ -369,7 +369,7 @@ declare namespace Deno {
* Requires `allow-sys` permission.
*
* @tags allow-sys
* @category Runtime Environment
* @category Runtime
*/
export function hostname(): string;

Expand All @@ -389,7 +389,7 @@ declare namespace Deno {
* On Windows there is no API available to retrieve this information and this method returns `[ 0, 0, 0 ]`.
*
* @tags allow-sys
* @category Observability
* @category Runtime
*/
export function loadavg(): number[];

Expand Down Expand Up @@ -443,14 +443,14 @@ declare namespace Deno {
* Requires `allow-sys` permission.
*
* @tags allow-sys
* @category Runtime Environment
* @category Runtime
*/
export function systemMemoryInfo(): SystemMemoryInfo;

/**
* Information returned from a call to {@linkcode Deno.systemMemoryInfo}.
*
* @category Runtime Environment
* @category Runtime
*/
export interface SystemMemoryInfo {
/** Total installed memory in bytes. */
Expand Down Expand Up @@ -481,7 +481,7 @@ declare namespace Deno {
*
* See: https://no-color.org/
*
* @category Runtime Environment
* @category Runtime
*/
export const noColor: boolean;

Expand All @@ -497,7 +497,7 @@ declare namespace Deno {
* it should depend sys-info, which may not be desirable.
*
* @tags allow-sys
* @category Runtime Environment
* @category Runtime
*/
export function osRelease(): string;

Expand All @@ -511,7 +511,7 @@ declare namespace Deno {
* Requires `allow-sys` permission.
*
* @tags allow-sys
* @category Runtime Environment
* @category Runtime
*/
export function osUptime(): number;

Expand Down Expand Up @@ -1462,15 +1462,15 @@ declare namespace Deno {
* Deno.exit(5);
* ```
*
* @category Runtime Environment
* @category Runtime
*/
export function exit(code?: number): never;

/** An interface containing methods to interact with the process environment
* variables.
*
* @tags allow-env
* @category Runtime Environment
* @category Runtime
*/
export interface Env {
/** Retrieve the value of an environment variable.
Expand Down Expand Up @@ -1549,7 +1549,7 @@ declare namespace Deno {
* variables.
*
* @tags allow-env
* @category Runtime Environment
* @category Runtime
*/
export const env: Env;

Expand All @@ -1563,7 +1563,7 @@ declare namespace Deno {
* Requires `allow-read` permission.
*
* @tags allow-read
* @category Runtime Environment
* @category Runtime
*/
export function execPath(): string;

Expand All @@ -1584,7 +1584,7 @@ declare namespace Deno {
* Requires `allow-read` permission.
*
* @tags allow-read
* @category Runtime Environment
* @category Runtime
*/
export function chdir(directory: string | URL): void;

Expand All @@ -1603,7 +1603,7 @@ declare namespace Deno {
* Requires `allow-read` permission.
*
* @tags allow-read
* @category Runtime Environment
* @category Runtime
*/
export function cwd(): string;

Expand Down Expand Up @@ -4033,7 +4033,7 @@ declare namespace Deno {
*/
export function truncateSync(name: string, len?: number): void;

/** @category Observability
/** @category Runtime
*
* @deprecated This will be removed in Deno 2.0.
*/
Expand All @@ -4051,7 +4051,7 @@ declare namespace Deno {
bytesReceived: number;
}

/** @category Observability
/** @category Runtime
*
* @deprecated This will be removed in Deno 2.0.
*/
Expand Down Expand Up @@ -4082,7 +4082,7 @@ declare namespace Deno {
* └─────────────────────────┴────────┘
* ```
*
* @category Observability
* @category Runtime
*
* @deprecated This will be removed in Deno 2.0.
*/
Expand All @@ -4094,7 +4094,7 @@ declare namespace Deno {
*
* @deprecated This will be removed in Deno 2.0.
*
* @category Observability */
* @category Runtime */
export interface ResourceMap {
[rid: number]: unknown;
}
Expand All @@ -4114,7 +4114,7 @@ declare namespace Deno {
*
* @deprecated This will be removed in Deno 2.0.
*
* @category Observability
* @category Runtime
*/
export function resources(): ResourceMap;

Expand Down Expand Up @@ -4392,7 +4392,7 @@ declare namespace Deno {
/** Operating signals which can be listened for or sent to sub-processes. What
* signals and what their standard behaviors are OS dependent.
*
* @category Runtime Environment */
* @category Runtime */
export type Signal =
| "SIGABRT"
| "SIGALRM"
Expand Down Expand Up @@ -4443,7 +4443,7 @@ declare namespace Deno {
* _Note_: On Windows only `"SIGINT"` (CTRL+C) and `"SIGBREAK"` (CTRL+Break)
* are supported.
*
* @category Runtime Environment
* @category Runtime
*/
export function addSignalListener(signal: Signal, handler: () => void): void;

Expand All @@ -4461,7 +4461,7 @@ declare namespace Deno {
* _Note_: On Windows only `"SIGINT"` (CTRL+C) and `"SIGBREAK"` (CTRL+Break)
* are supported.
*
* @category Runtime Environment
* @category Runtime
*/
export function removeSignalListener(
signal: Signal,
Expand Down Expand Up @@ -4745,7 +4745,7 @@ declare namespace Deno {

/** Option which can be specified when performing {@linkcode Deno.inspect}.
*
* @category Console and Debugging */
* @category I/O */
export interface InspectOptions {
/** Stylize output with ANSI colors.
*
Expand Down Expand Up @@ -4831,7 +4831,7 @@ declare namespace Deno {
* Deno.inspect({a: {b: {c: {d: 'hello'}}}}, {depth: 2}); // { a: { b: [Object] } }
* ```
*
* @category Console and Debugging
* @category I/O
*/
export function inspect(value: unknown, options?: InspectOptions): string;

Expand Down Expand Up @@ -5241,7 +5241,7 @@ declare namespace Deno {
*
* The intended use for the information is for logging and debugging purposes.
*
* @category Runtime Environment
* @category Runtime
*/
export const build: {
/** The [LLVM](https://llvm.org/) target triple, which is the combination
Expand Down Expand Up @@ -5277,7 +5277,7 @@ declare namespace Deno {
*
* The intended use for the information is for logging and debugging purposes.
*
* @category Runtime Environment
* @category Runtime
*/
export const version: {
/** Deno CLI's version. For example: `"1.26.0"`. */
Expand Down Expand Up @@ -5312,7 +5312,7 @@ declare namespace Deno {
* [`parseArgs()`](https://jsr.io/@std/cli/doc/parse-args/~/parseArgs) from
* the Deno Standard Library.
*
* @category Runtime Environment
* @category Runtime
*/
export const args: string[];

Expand All @@ -5325,7 +5325,7 @@ declare namespace Deno {
* {@link https://docs.deno.com/runtime/manual/advanced/migrate_deprecations | Deno 1.x to 2.x Migration Guide}
* for migration instructions.
*
* @category Console and Debugging
* @category I/O
*/
export const customInspect: unique symbol;

Expand All @@ -5335,7 +5335,7 @@ declare namespace Deno {
* Also see {@linkcode ImportMeta} for other related information.
*
* @tags allow-read
* @category Runtime Environment
* @category Runtime
*/
export const mainModule: string;

Expand Down Expand Up @@ -6178,14 +6178,14 @@ declare namespace Deno {
/**
* Make the timer of the given `id` block the event loop from finishing.
*
* @category Timers
* @category Runtime
*/
export function refTimer(id: number): void;

/**
* Make the timer of the given `id` not block the event loop from finishing.
*
* @category Timers
* @category Runtime
*/
export function unrefTimer(id: number): void;

Expand All @@ -6199,7 +6199,7 @@ declare namespace Deno {
* Requires `allow-sys` permission.
*
* @tags allow-sys
* @category Runtime Environment
* @category Runtime
*/
export function uid(): number | null;

Expand All @@ -6213,7 +6213,7 @@ declare namespace Deno {
* Requires `allow-sys` permission.
*
* @tags allow-sys
* @category Runtime Environment
* @category Runtime
*/
export function gid(): number | null;

Expand Down