// Copyright 2018-2026 the Deno authors. MIT license. /** The global namespace where Deno specific, non-standard APIs are located. */ declare namespace Deno { /** A set of error constructors that are raised by Deno APIs. * * Can be used to provide more specific handling of failures within code * which is using Deno APIs. For example, handling attempting to open a file * which does not exist: * * ```ts * try { * const file = await Deno.open("./some/file.txt"); * } catch (error) { * if (error instanceof Deno.errors.NotFound) { * console.error("the file was not found"); * } else { * // otherwise re-throw * throw error; * } * } * ``` * * @category Errors */ export namespace errors { /** * Raised when the underlying operating system indicates that the file * was not found. * * @category Errors */ export class NotFound extends Error {} /** * Raised when the underlying operating system indicates the current user * which the Deno process is running under does not have the appropriate * permissions to a file or resource. * * Before Deno 2.0, this error was raised when the user _did not_ provide * required `--allow-*` flag. As of Deno 2.0, that case is now handled by * the {@link NotCapable} error. * * @category Errors */ export class PermissionDenied extends Error {} /** * Raised when the underlying operating system reports that a connection to * a resource is refused. * * @category Errors */ export class ConnectionRefused extends Error {} /** * Raised when the underlying operating system reports that a connection has * been reset. With network servers, it can be a _normal_ occurrence where a * client will abort a connection instead of properly shutting it down. * * @category Errors */ export class ConnectionReset extends Error {} /** * Raised when the underlying operating system reports an `ECONNABORTED` * error. * * @category Errors */ export class ConnectionAborted extends Error {} /** * Raised when the underlying operating system reports an `ENOTCONN` error. * * @category Errors */ export class NotConnected extends Error {} /** * Raised when attempting to open a server listener on an address and port * that already has a listener. * * @category Errors */ export class AddrInUse extends Error {} /** * Raised when the underlying operating system reports an `EADDRNOTAVAIL` * error. * * @category Errors */ export class AddrNotAvailable extends Error {} /** * Raised when trying to write to a resource and a broken pipe error occurs. * This can happen when trying to write directly to `stdout` or `stderr` * and the operating system is unable to pipe the output for a reason * external to the Deno runtime. * * @category Errors */ export class BrokenPipe extends Error {} /** * Raised when trying to create a resource, like a file, that already * exits. * * @category Errors */ export class AlreadyExists extends Error {} /** * Raised when an operation returns data that is invalid for the * operation being performed. * * @category Errors */ export class InvalidData extends Error {} /** * Raised when the underlying operating system reports that an I/O operation * has timed out (`ETIMEDOUT`). * * @category Errors */ export class TimedOut extends Error {} /** * Raised when the underlying operating system reports an `EINTR` error. In * many cases, this underlying IO error will be handled internally within * Deno, or result in an {@link BadResource} error instead. * * @category Errors */ export class Interrupted extends Error {} /** * Raised when the underlying operating system would need to block to * complete but an asynchronous (non-blocking) API is used. * * @category Errors */ export class WouldBlock extends Error {} /** * Raised when expecting to write to a IO buffer resulted in zero bytes * being written. * * @category Errors */ export class WriteZero extends Error {} /** * Raised when attempting to read bytes from a resource, but the EOF was * unexpectedly encountered. * * @category Errors */ export class UnexpectedEof extends Error {} /** * The underlying IO resource is invalid or closed, and so the operation * could not be performed. * * @category Errors */ export class BadResource extends Error {} /** * Raised in situations where when attempting to load a dynamic import, * too many redirects were encountered. * * @category Errors */ export class Http extends Error {} /** * Raised when the underlying IO resource is not available because it is * being awaited on in another block of code. * * @category Errors */ export class Busy extends Error {} /** * Raised when the underlying Deno API is asked to perform a function that * is not currently supported. * * @category Errors */ export class NotSupported extends Error {} /** * Raised when too many symbolic links were encountered when resolving the * filename. * * @category Errors */ export class FilesystemLoop extends Error {} /** * Raised when trying to open, create or write to a directory. * * @category Errors */ export class IsADirectory extends Error {} /** * Raised when performing a socket operation but the remote host is * not reachable. * * @category Errors */ export class NetworkUnreachable extends Error {} /** * Raised when trying to perform an operation on a path that is not a * directory, when directory is required. * * @category Errors */ export class NotADirectory extends Error {} /** * Raised when trying to perform an operation while the relevant Deno * permission (like `--allow-read`) has not been granted. * * Before Deno 2.0, this condition was covered by the {@link PermissionDenied} * error. * * @category Errors */ export class NotCapable extends Error {} export {}; // only export exports } /** The current process ID of this instance of the Deno CLI. * * ```ts * console.log(Deno.pid); * ``` * * @category Runtime */ export const pid: number; /** * The process ID of parent process of this instance of the Deno CLI. * * ```ts * console.log(Deno.ppid); * ``` * * @category Runtime */ export const ppid: number; /** @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). */ rss: number; /** The total size of the heap for V8, in bytes. */ heapTotal: number; /** The amount of the heap used for V8, in bytes. */ heapUsed: number; /** Memory, in bytes, associated with JavaScript objects outside of the * JavaScript isolate. */ external: number; } /** * Returns an object describing the memory usage of the Deno process and the * V8 subsystem measured in bytes. * * @category Runtime */ export function memoryUsage(): MemoryUsage; /** * Get the `hostname` of the machine the Deno process is running on. * * ```ts * console.log(Deno.hostname()); * ``` * * Requires `allow-sys` permission. * * @tags allow-sys * @category Runtime */ export function hostname(): string; /** * Returns an array containing the 1, 5, and 15 minute load averages. The * load average is a measure of CPU and IO utilization of the last one, five, * and 15 minute periods expressed as a fractional number. Zero means there * is no load. On Windows, the three values are always the same and represent * the current load, not the 1, 5 and 15 minute load averages. * * ```ts * console.log(Deno.loadavg()); // e.g. [ 0.71, 0.44, 0.44 ] * ``` * * Requires `allow-sys` permission. * * On Windows there is no API available to retrieve this information and this method returns `[ 0, 0, 0 ]`. * * @tags allow-sys * @category Runtime */ export function loadavg(): number[]; /** * The information for a network interface returned from a call to * {@linkcode Deno.networkInterfaces}. * * @category Network */ export interface NetworkInterfaceInfo { /** The network interface name. */ name: string; /** The IP protocol version. */ family: "IPv4" | "IPv6"; /** The IP address bound to the interface. */ address: string; /** The netmask applied to the interface. */ netmask: string; /** The IPv6 scope id or `null`. */ scopeid: number | null; /** The CIDR range. */ cidr: string; /** The MAC address. */ mac: string; } /** * Returns an array of the network interface information. * * ```ts * console.log(Deno.networkInterfaces()); * ``` * * Requires `allow-sys` permission. * * @tags allow-sys * @category Network */ export function networkInterfaces(): NetworkInterfaceInfo[]; /** * Displays the total amount of free and used physical and swap memory in the * system, as well as the buffers and caches used by the kernel. * * This is similar to the `free` command in Linux * * ```ts * console.log(Deno.systemMemoryInfo()); * ``` * * Requires `allow-sys` permission. * * @tags allow-sys * @category Runtime */ export function systemMemoryInfo(): SystemMemoryInfo; /** * Information returned from a call to {@linkcode Deno.systemMemoryInfo}. * * @category Runtime */ export interface SystemMemoryInfo { /** Total installed memory in bytes. */ total: number; /** Unused memory in bytes. */ free: number; /** Estimation of how much memory, in bytes, is available for starting new * applications, without swapping. Unlike the data provided by the cache or * free fields, this field takes into account page cache and also that not * all reclaimable memory will be reclaimed due to items being in use. */ available: number; /** Memory used by kernel buffers. */ buffers: number; /** Memory used by the page cache and slabs. */ cached: number; /** Total swap memory. */ swapTotal: number; /** Unused swap memory. */ swapFree: number; } /** Reflects the `NO_COLOR` environment variable at program start. * * When the value is `true`, the Deno CLI will attempt to not send color codes * to `stderr` or `stdout` and other command line programs should also attempt * to respect this value. * * See: https://no-color.org/ * * @category Runtime */ export const noColor: boolean; /** * Returns the release version of the Operating System. * * ```ts * console.log(Deno.osRelease()); * ``` * * Requires `allow-sys` permission. * Under consideration to possibly move to Deno.build or Deno.versions and if * it should depend sys-info, which may not be desirable. * * @tags allow-sys * @category Runtime */ export function osRelease(): string; /** * Returns the Operating System uptime in number of seconds. * * ```ts * console.log(Deno.osUptime()); * ``` * * Requires `allow-sys` permission. * * @tags allow-sys * @category Runtime */ export function osUptime(): number; /** * Options which define the permissions within a test or worker context. * * `"inherit"` ensures that all permissions of the parent process will be * applied to the test context. `"none"` ensures the test context has no * permissions. A `PermissionOptionsObject` provides a more specific * set of permissions to the test context. * * @category Permissions */ export type PermissionOptions = "inherit" | "none" | PermissionOptionsObject; /** * A set of options which can define the permissions within a test or worker * context at a highly specific level. * * @category Permissions */ export interface PermissionOptionsObject { /** Specifies if the `env` permission should be requested or revoked. * If set to `"inherit"`, the current `env` permission will be inherited. * If set to `true`, the global `env` permission will be requested. * If set to `false`, the global `env` permission will be revoked. * * @default {false} */ env?: "inherit" | boolean | string[]; /** Specifies if the `ffi` permission should be requested or revoked. * If set to `"inherit"`, the current `ffi` permission will be inherited. * If set to `true`, the global `ffi` permission will be requested. * If set to `false`, the global `ffi` permission will be revoked. * * @default {false} */ ffi?: "inherit" | boolean | Array; /** Specifies if the `import` permission should be requested or revoked. * If set to `"inherit"` the current `import` permission will be inherited. * If set to `true`, the global `import` permission will be requested. * If set to `false`, the global `import` permission will be revoked. * If set to `Array`, the `import` permissions will be requested with the * specified domains. */ import?: "inherit" | boolean | Array; /** Specifies if the `net` permission should be requested or revoked. * if set to `"inherit"`, the current `net` permission will be inherited. * if set to `true`, the global `net` permission will be requested. * if set to `false`, the global `net` permission will be revoked. * if set to `string[]`, the `net` permission will be requested with the * specified host strings with the format `"[:]`. * * @default {false} * * Examples: * * ```ts * import { assertEquals } from "jsr:@std/assert"; * * Deno.test({ * name: "inherit", * permissions: { * net: "inherit", * }, * async fn() { * const status = await Deno.permissions.query({ name: "net" }) * assertEquals(status.state, "granted"); * }, * }); * ``` * * ```ts * import { assertEquals } from "jsr:@std/assert"; * * Deno.test({ * name: "true", * permissions: { * net: true, * }, * async fn() { * const status = await Deno.permissions.query({ name: "net" }); * assertEquals(status.state, "granted"); * }, * }); * ``` * * ```ts * import { assertEquals } from "jsr:@std/assert"; * * Deno.test({ * name: "false", * permissions: { * net: false, * }, * async fn() { * const status = await Deno.permissions.query({ name: "net" }); * assertEquals(status.state, "denied"); * }, * }); * ``` * * ```ts * import { assertEquals } from "jsr:@std/assert"; * * Deno.test({ * name: "localhost:8080", * permissions: { * net: ["localhost:8080"], * }, * async fn() { * const status = await Deno.permissions.query({ name: "net", host: "localhost:8080" }); * assertEquals(status.state, "granted"); * }, * }); * ``` */ net?: "inherit" | boolean | string[]; /** Specifies if the `read` permission should be requested or revoked. * If set to `"inherit"`, the current `read` permission will be inherited. * If set to `true`, the global `read` permission will be requested. * If set to `false`, the global `read` permission will be revoked. * If set to `Array`, the `read` permission will be requested with the * specified file paths. * * @default {false} */ read?: "inherit" | boolean | Array; /** Specifies if the `run` permission should be requested or revoked. * If set to `"inherit"`, the current `run` permission will be inherited. * If set to `true`, the global `run` permission will be requested. * If set to `false`, the global `run` permission will be revoked. * * @default {false} */ run?: "inherit" | boolean | Array; /** Specifies if the `sys` permission should be requested or revoked. * If set to `"inherit"`, the current `sys` permission will be inherited. * If set to `true`, the global `sys` permission will be requested. * If set to `false`, the global `sys` permission will be revoked. * * @default {false} */ sys?: "inherit" | boolean | string[]; /** Specifies if the `write` permission should be requested or revoked. * If set to `"inherit"`, the current `write` permission will be inherited. * If set to `true`, the global `write` permission will be requested. * If set to `false`, the global `write` permission will be revoked. * If set to `Array`, the `write` permission will be requested with the * specified file paths. * * @default {false} */ write?: "inherit" | boolean | Array; } /** * Context that is passed to a testing function, which can be used to either * gain information about the current test, or register additional test * steps within the current test. * * @category Testing */ export interface TestContext { /** The current test name. */ name: string; /** The string URL of the current test. */ origin: string; /** If the current test is a step of another test, the parent test context * will be set here. */ parent?: TestContext; /** Run a sub step of the parent test or step. Returns a promise * that resolves to a boolean signifying if the step completed successfully. * * The returned promise never rejects unless the arguments are invalid. * * If the test was ignored the promise returns `false`. * * ```ts * Deno.test({ * name: "a parent test", * async fn(t) { * console.log("before the step"); * await t.step({ * name: "step 1", * fn(t) { * console.log("current step:", t.name); * } * }); * console.log("after the step"); * } * }); * ``` */ step(definition: TestStepDefinition): Promise; /** Run a sub step of the parent test or step. Returns a promise * that resolves to a boolean signifying if the step completed successfully. * * The returned promise never rejects unless the arguments are invalid. * * If the test was ignored the promise returns `false`. * * ```ts * Deno.test( * "a parent test", * async (t) => { * console.log("before the step"); * await t.step( * "step 1", * (t) => { * console.log("current step:", t.name); * } * ); * console.log("after the step"); * } * ); * ``` */ step( name: string, fn: (t: TestContext) => void | Promise, ): Promise; /** Run a sub step of the parent test or step. Returns a promise * that resolves to a boolean signifying if the step completed successfully. * * The returned promise never rejects unless the arguments are invalid. * * If the test was ignored the promise returns `false`. * * ```ts * Deno.test(async function aParentTest(t) { * console.log("before the step"); * await t.step(function step1(t) { * console.log("current step:", t.name); * }); * console.log("after the step"); * }); * ``` */ step(fn: (t: TestContext) => void | Promise): Promise; } /** @category Testing */ export interface TestStepDefinition { /** The test function that will be tested when this step is executed. The * function can take an argument which will provide information about the * current step's context. */ fn: (t: TestContext) => void | Promise; /** The name of the step. */ name: string; /** If truthy the current test step will be ignored. * * This is a quick way to skip over a step, but also can be used for * conditional logic, like determining if an environment feature is present. */ ignore?: boolean; /** Check that the number of async completed operations after the test step * is the same as number of dispatched operations. This ensures that the * code tested does not start async operations which it then does * not await. This helps in preventing logic errors and memory leaks * in the application code. * * Defaults to the parent test or step's value. */ sanitizeOps?: boolean; /** Ensure the test step does not "leak" resources - like open files or * network connections - by ensuring the open resources at the start of the * step match the open resources at the end of the step. * * Defaults to the parent test or step's value. */ sanitizeResources?: boolean; /** Ensure the test step does not prematurely cause the process to exit, * for example via a call to {@linkcode Deno.exit}. * * Defaults to the parent test or step's value. */ sanitizeExit?: boolean; } /** @category Testing */ export interface TestDefinition { fn: (t: TestContext) => void | Promise; /** The name of the test. */ name: string; /** If truthy the current test step will be ignored. * * It is a quick way to skip over a step, but also can be used for * conditional logic, like determining if an environment feature is present. */ ignore?: boolean; /** If at least one test has `only` set to `true`, only run tests that have * `only` set to `true` and fail the test suite. */ only?: boolean; /** Check that the number of async completed operations after the test step * is the same as number of dispatched operations. This ensures that the * code tested does not start async operations which it then does * not await. This helps in preventing logic errors and memory leaks * in the application code. * * @default {true} */ sanitizeOps?: boolean; /** Ensure the test step does not "leak" resources - like open files or * network connections - by ensuring the open resources at the start of the * test match the open resources at the end of the test. * * @default {true} */ sanitizeResources?: boolean; /** Ensure the test case does not prematurely cause the process to exit, * for example via a call to {@linkcode Deno.exit}. * * @default {true} */ sanitizeExit?: boolean; /** Specifies the permissions that should be used to run the test. * * Set this to "inherit" to keep the calling runtime permissions, set this * to "none" to revoke all permissions, or set a more specific set of * permissions using a {@linkcode PermissionOptionsObject}. * * @default {"inherit"} */ permissions?: PermissionOptions; } /** Register a test which will be run when `deno test` is used on the command * line and the containing module looks like a test module. * * `fn` can be async if required. * * Tests are discovered before they are executed, so registrations must happen * at module load time. * Nested `Deno.test()` calls are not supported. * Use `t.step()` for nested tests. * * ```ts * import { assertEquals } from "jsr:@std/assert"; * * Deno.test({ * name: "example test", * fn() { * assertEquals("world", "world"); * }, * }); * * Deno.test({ * name: "example ignored test", * ignore: Deno.build.os === "windows", * fn() { * // This test is ignored only on Windows machines * }, * }); * * Deno.test({ * name: "example async test", * async fn() { * const decoder = new TextDecoder("utf-8"); * const data = await Deno.readFile("hello_world.txt"); * assertEquals(decoder.decode(data), "Hello world"); * } * }); * ``` * * @category Testing */ export const test: DenoTest; /** * @category Testing */ export interface DenoTest { /** Register a test which will be run when `deno test` is used on the command * line and the containing module looks like a test module. * * `fn` can be async if required. * * ```ts * import { assertEquals } from "jsr:@std/assert"; * * Deno.test({ * name: "example test", * fn() { * assertEquals("world", "world"); * }, * }); * * Deno.test({ * name: "example ignored test", * ignore: Deno.build.os === "windows", * fn() { * // This test is ignored only on Windows machines * }, * }); * * Deno.test({ * name: "example async test", * async fn() { * const decoder = new TextDecoder("utf-8"); * const data = await Deno.readFile("hello_world.txt"); * assertEquals(decoder.decode(data), "Hello world"); * } * }); * ``` * * @category Testing */ (t: TestDefinition): void; /** Register a test which will be run when `deno test` is used on the command * line and the containing module looks like a test module. * * `fn` can be async if required. * * ```ts * import { assertEquals } from "jsr:@std/assert"; * * Deno.test("My test description", () => { * assertEquals("hello", "hello"); * }); * * Deno.test("My async test description", async () => { * const decoder = new TextDecoder("utf-8"); * const data = await Deno.readFile("hello_world.txt"); * assertEquals(decoder.decode(data), "Hello world"); * }); * ``` * * @category Testing */ (name: string, fn: (t: TestContext) => void | Promise): void; /** Register a test which will be run when `deno test` is used on the command * line and the containing module looks like a test module. * * `fn` can be async if required. Declared function must have a name. * * ```ts * import { assertEquals } from "jsr:@std/assert"; * * Deno.test(function myTestName() { * assertEquals("hello", "hello"); * }); * * Deno.test(async function myOtherTestName() { * const decoder = new TextDecoder("utf-8"); * const data = await Deno.readFile("hello_world.txt"); * assertEquals(decoder.decode(data), "Hello world"); * }); * ``` * * @category Testing */ (fn: (t: TestContext) => void | Promise): void; /** Register a test which will be run when `deno test` is used on the command * line and the containing module looks like a test module. * * `fn` can be async if required. * * ```ts * import { assert, fail, assertEquals } from "jsr:@std/assert"; * * Deno.test("My test description", { permissions: { read: true } }, (): void => { * assertEquals("hello", "hello"); * }); * * Deno.test("My async test description", { permissions: { read: false } }, async (): Promise => { * const decoder = new TextDecoder("utf-8"); * const data = await Deno.readFile("hello_world.txt"); * assertEquals(decoder.decode(data), "Hello world"); * }); * ``` * * @category Testing */ ( name: string, options: Omit, fn: (t: TestContext) => void | Promise, ): void; /** Register a test which will be run when `deno test` is used on the command * line and the containing module looks like a test module. * * `fn` can be async if required. * * ```ts * import { assertEquals } from "jsr:@std/assert"; * * Deno.test( * { * name: "My test description", * permissions: { read: true }, * }, * () => { * assertEquals("hello", "hello"); * }, * ); * * Deno.test( * { * name: "My async test description", * permissions: { read: false }, * }, * async () => { * const decoder = new TextDecoder("utf-8"); * const data = await Deno.readFile("hello_world.txt"); * assertEquals(decoder.decode(data), "Hello world"); * }, * ); * ``` * * @category Testing */ ( options: Omit, fn: (t: TestContext) => void | Promise, ): void; /** Register a test which will be run when `deno test` is used on the command * line and the containing module looks like a test module. * * `fn` can be async if required. Declared function must have a name. * * ```ts * import { assertEquals } from "jsr:@std/assert"; * * Deno.test( * { permissions: { read: true } }, * function myTestName() { * assertEquals("hello", "hello"); * }, * ); * * Deno.test( * { permissions: { read: false } }, * async function myOtherTestName() { * const decoder = new TextDecoder("utf-8"); * const data = await Deno.readFile("hello_world.txt"); * assertEquals(decoder.decode(data), "Hello world"); * }, * ); * ``` * * @category Testing */ ( options: Omit, fn: (t: TestContext) => void | Promise, ): void; /** Shorthand property for ignoring a particular test case. * * @category Testing */ ignore(t: Omit): void; /** Shorthand property for ignoring a particular test case. * * @category Testing */ ignore(name: string, fn: (t: TestContext) => void | Promise): void; /** Shorthand property for ignoring a particular test case. * * @category Testing */ ignore(fn: (t: TestContext) => void | Promise): void; /** Shorthand property for ignoring a particular test case. * * @category Testing */ ignore( name: string, options: Omit, fn: (t: TestContext) => void | Promise, ): void; /** Shorthand property for ignoring a particular test case. * * @category Testing */ ignore( options: Omit, fn: (t: TestContext) => void | Promise, ): void; /** Shorthand property for ignoring a particular test case. * * @category Testing */ ignore( options: Omit, fn: (t: TestContext) => void | Promise, ): void; /** Shorthand property for focusing a particular test case. * * @category Testing */ only(t: Omit): void; /** Shorthand property for focusing a particular test case. * * @category Testing */ only(name: string, fn: (t: TestContext) => void | Promise): void; /** Shorthand property for focusing a particular test case. * * @category Testing */ only(fn: (t: TestContext) => void | Promise): void; /** Shorthand property for focusing a particular test case. * * @category Testing */ only( name: string, options: Omit, fn: (t: TestContext) => void | Promise, ): void; /** Shorthand property for focusing a particular test case. * * @category Testing */ only( options: Omit, fn: (t: TestContext) => void | Promise, ): void; /** Shorthand property for focusing a particular test case. * * @category Testing */ only( options: Omit, fn: (t: TestContext) => void | Promise, ): void; /** Register a function to be called before all tests in the current scope. * * These functions are run in FIFO order (first in, first out). * * If an exception is raised during execution of this hook, the remaining `beforeAll` hooks will not be run. * * ```ts * Deno.test.beforeAll(() => { * // Setup code that runs once before all tests * console.log("Setting up test suite"); * }); * ``` * * @category Testing */ beforeAll( fn: () => void | Promise, ): void; /** Register a function to be called before each test in the current scope. * * These functions are run in FIFO order (first in, first out). * * If an exception is raised during execution of this hook, the remaining hooks will not be run and the currently running * test case will be marked as failed. * * ```ts * Deno.test.beforeEach(() => { * // Setup code that runs before each test * console.log("Setting up test"); * }); * ``` * * @category Testing */ beforeEach(fn: () => void | Promise): void; /** Register a function to be called after each test in the current scope. * * These functions are run in LIFO order (last in, first out). * * If an exception is raised during execution of this hook, the remaining hooks will not be run and the currently running * test case will be marked as failed. * * ```ts * Deno.test.afterEach(() => { * // Cleanup code that runs after each test * console.log("Cleaning up test"); * }); * ``` * * @category Testing */ afterEach(fn: () => void | Promise): void; /** Register a function to be called after all tests in the current scope have finished running. * * These functions are run in the LIFO order (last in, first out). * * If an exception is raised during execution of this hook, the remaining `afterAll` hooks will not be run. * * ```ts * Deno.test.afterAll(() => { * // Cleanup code that runs once after all tests * console.log("Cleaning up test suite"); * }); * ``` * * @category Testing */ afterAll(fn: () => void | Promise): void; } /** * Context that is passed to a benchmarked function. The instance is shared * between iterations of the benchmark. Its methods can be used for example * to override of the measured portion of the function. * * @category Testing */ export interface BenchContext { /** The current benchmark name. */ name: string; /** The string URL of the current benchmark. */ origin: string; /** Restarts the timer for the bench measurement. This should be called * after doing setup work which should not be measured. * * Warning: This method should not be used for benchmarks averaging less * than 10μs per iteration. In such cases it will be disabled but the call * will still have noticeable overhead, resulting in a warning. * * ```ts * Deno.bench("foo", async (t) => { * const data = await Deno.readFile("data.txt"); * t.start(); * // some operation on `data`... * }); * ``` */ start(): void; /** End the timer early for the bench measurement. This should be called * before doing teardown work which should not be measured. * * Warning: This method should not be used for benchmarks averaging less * than 10μs per iteration. In such cases it will be disabled but the call * will still have noticeable overhead, resulting in a warning. * * ```ts * Deno.bench("foo", async (t) => { * using file = await Deno.open("data.txt"); * t.start(); * // some operation on `file`... * t.end(); * }); * ``` */ end(): void; } /** * The interface for defining a benchmark test using {@linkcode Deno.bench}. * * @category Testing */ export interface BenchDefinition { /** The test function which will be benchmarked. */ fn: (b: BenchContext) => void | Promise; /** The name of the test, which will be used in displaying the results. */ name: string; /** If truthy, the benchmark test will be ignored/skipped. */ ignore?: boolean; /** Group name for the benchmark. * * Grouped benchmarks produce a group time summary, where the difference * in performance between each test of the group is compared. */ group?: string; /** Benchmark should be used as the baseline for other benchmarks. * * If there are multiple baselines in a group, the first one is used as the * baseline. */ baseline?: boolean; /** If at least one bench has `only` set to true, only run benches that have * `only` set to `true` and fail the bench suite. */ only?: boolean; /** Number of iterations to perform. * @remarks When the benchmark is very fast, this will only be used as a * suggestion in order to get a more accurate measurement. */ n?: number; /** Number of warmups to do before running the benchmark. * @remarks A warmup will always be performed even if this is `0` in order to * determine the speed of the benchmark in order to improve the measurement. When * the benchmark is very fast, this will be used as a suggestion. */ warmup?: number; /** Ensure the bench case does not prematurely cause the process to exit, * for example via a call to {@linkcode Deno.exit}. * * @default {true} */ sanitizeExit?: boolean; /** Specifies the permissions that should be used to run the bench. * * Set this to `"inherit"` to keep the calling thread's permissions. * * Set this to `"none"` to revoke all permissions. * * @default {"inherit"} */ permissions?: PermissionOptions; } /** * Register a benchmark test which will be run when `deno bench` is used on * the command line and the containing module looks like a bench module. * * If the test function (`fn`) returns a promise or is async, the test runner * will await resolution to consider the test complete. * * ```ts * import { assertEquals } from "jsr:@std/assert"; * * Deno.bench({ * name: "example test", * fn() { * assertEquals("world", "world"); * }, * }); * * Deno.bench({ * name: "example ignored test", * ignore: Deno.build.os === "windows", * fn() { * // This test is ignored only on Windows machines * }, * }); * * Deno.bench({ * name: "example async test", * async fn() { * const decoder = new TextDecoder("utf-8"); * const data = await Deno.readFile("hello_world.txt"); * assertEquals(decoder.decode(data), "Hello world"); * } * }); * ``` * * @category Testing */ export function bench(b: BenchDefinition): void; /** * Register a benchmark test which will be run when `deno bench` is used on * the command line and the containing module looks like a bench module. * * If the test function (`fn`) returns a promise or is async, the test runner * will await resolution to consider the test complete. * * ```ts * import { assertEquals } from "jsr:@std/assert"; * * Deno.bench("My test description", () => { * assertEquals("hello", "hello"); * }); * * Deno.bench("My async test description", async () => { * const decoder = new TextDecoder("utf-8"); * const data = await Deno.readFile("hello_world.txt"); * assertEquals(decoder.decode(data), "Hello world"); * }); * ``` * * @category Testing */ export function bench( name: string, fn: (b: BenchContext) => void | Promise, ): void; /** * Register a benchmark test which will be run when `deno bench` is used on * the command line and the containing module looks like a bench module. * * If the test function (`fn`) returns a promise or is async, the test runner * will await resolution to consider the test complete. * * ```ts * import { assertEquals } from "jsr:@std/assert"; * * Deno.bench(function myTestName() { * assertEquals("hello", "hello"); * }); * * Deno.bench(async function myOtherTestName() { * const decoder = new TextDecoder("utf-8"); * const data = await Deno.readFile("hello_world.txt"); * assertEquals(decoder.decode(data), "Hello world"); * }); * ``` * * @category Testing */ export function bench(fn: (b: BenchContext) => void | Promise): void; /** * Register a benchmark test which will be run when `deno bench` is used on * the command line and the containing module looks like a bench module. * * If the test function (`fn`) returns a promise or is async, the test runner * will await resolution to consider the test complete. * * ```ts * import { assertEquals } from "jsr:@std/assert"; * * Deno.bench( * "My test description", * { permissions: { read: true } }, * () => { * assertEquals("hello", "hello"); * } * ); * * Deno.bench( * "My async test description", * { permissions: { read: false } }, * async () => { * const decoder = new TextDecoder("utf-8"); * const data = await Deno.readFile("hello_world.txt"); * assertEquals(decoder.decode(data), "Hello world"); * } * ); * ``` * * @category Testing */ export function bench( name: string, options: Omit, fn: (b: BenchContext) => void | Promise, ): void; /** * Register a benchmark test which will be run when `deno bench` is used on * the command line and the containing module looks like a bench module. * * If the test function (`fn`) returns a promise or is async, the test runner * will await resolution to consider the test complete. * * ```ts * import { assertEquals } from "jsr:@std/assert"; * * Deno.bench( * { name: "My test description", permissions: { read: true } }, * () => { * assertEquals("hello", "hello"); * } * ); * * Deno.bench( * { name: "My async test description", permissions: { read: false } }, * async () => { * const decoder = new TextDecoder("utf-8"); * const data = await Deno.readFile("hello_world.txt"); * assertEquals(decoder.decode(data), "Hello world"); * } * ); * ``` * * @category Testing */ export function bench( options: Omit, fn: (b: BenchContext) => void | Promise, ): void; /** * Register a benchmark test which will be run when `deno bench` is used on * the command line and the containing module looks like a bench module. * * If the test function (`fn`) returns a promise or is async, the test runner * will await resolution to consider the test complete. * * ```ts * import { assertEquals } from "jsr:@std/assert"; * * Deno.bench( * { permissions: { read: true } }, * function myTestName() { * assertEquals("hello", "hello"); * } * ); * * Deno.bench( * { permissions: { read: false } }, * async function myOtherTestName() { * const decoder = new TextDecoder("utf-8"); * const data = await Deno.readFile("hello_world.txt"); * assertEquals(decoder.decode(data), "Hello world"); * } * ); * ``` * * @category Testing */ export function bench( options: Omit, fn: (b: BenchContext) => void | Promise, ): void; /** Exit the Deno process with optional exit code. * * If no exit code is supplied then Deno will exit with return code of `0`. * * In worker contexts this is an alias to `self.close();`. * * ```ts * Deno.exit(5); * ``` * * @category Runtime */ export function exit(code?: number): never; /** The exit code for the Deno process. * * If no exit code has been supplied, then Deno will assume a return code of `0`. * * When setting an exit code value, a number or non-NaN string must be provided, * otherwise a TypeError will be thrown. * * ```ts * console.log(Deno.exitCode); //-> 0 * Deno.exitCode = 1; * console.log(Deno.exitCode); //-> 1 * ``` * * @category Runtime */ export var exitCode: number; /** An interface containing methods to interact with the process environment * variables. * * Environment variables can also be loaded from a `.env` file by using the * `--env-file` flag when running a Deno program: * * ```sh * deno run --env-file=.env --allow-env main.ts * ``` * * If `--env-file` is specified without a value, it defaults to loading `.env` * from the current working directory: * * ```sh * deno run --env-file --allow-env main.ts * ``` * * Learn more at [the Deno docs](https://docs.deno.com/runtime/reference/env_variables/). * * @tags allow-env * @category Runtime */ export interface Env { /** Retrieve the value of an environment variable. * * Returns `undefined` if the supplied environment variable is not defined. * * ```ts * console.log(Deno.env.get("HOME")); // e.g. outputs "/home/alice" * console.log(Deno.env.get("MADE_UP_VAR")); // outputs undefined * ``` * * Requires `allow-env` permission. * * @tags allow-env */ get(key: string): string | undefined; /** Set the value of an environment variable. * * ```ts * Deno.env.set("SOME_VAR", "Value"); * Deno.env.get("SOME_VAR"); // outputs "Value" * ``` * * Requires `allow-env` permission. * * @tags allow-env */ set(key: string, value: string): void; /** Delete the value of an environment variable. * * ```ts * Deno.env.set("SOME_VAR", "Value"); * Deno.env.delete("SOME_VAR"); // outputs "undefined" * ``` * * Requires `allow-env` permission. * * @tags allow-env */ delete(key: string): void; /** Check whether an environment variable is present or not. * * ```ts * Deno.env.set("SOME_VAR", "Value"); * Deno.env.has("SOME_VAR"); // outputs true * ``` * * Requires `allow-env` permission. * * @tags allow-env */ has(key: string): boolean; /** Returns a snapshot of the environment variables at invocation as a * simple object of keys and values. * * ```ts * Deno.env.set("TEST_VAR", "A"); * const myEnv = Deno.env.toObject(); * console.log(myEnv.SHELL); * Deno.env.set("TEST_VAR", "B"); * console.log(myEnv.TEST_VAR); // outputs "A" * ``` * * Requires `allow-env` permission. * * @tags allow-env */ toObject(): { [index: string]: string }; } /** An interface containing methods to interact with the process environment * variables. * * @tags allow-env * @category Runtime */ export const env: Env; /** * Returns the path to the current deno executable. * * ```ts * console.log(Deno.execPath()); // e.g. "/home/alice/.local/bin/deno" * ``` * * @category Runtime */ export function execPath(): string; /** * Change the current working directory to the specified path. * * ```ts * Deno.chdir("/home/userA"); * Deno.chdir("../userB"); * Deno.chdir("C:\\Program Files (x86)\\Java"); * ``` * * Throws {@linkcode Deno.errors.NotFound} if directory not found. * * Throws {@linkcode Deno.errors.PermissionDenied} if the user does not have * operating system file access rights. * * Requires `allow-read` permission. * * @tags allow-read * @category Runtime */ export function chdir(directory: string | URL): void; /** * Return a string representing the current working directory. * * If the current directory can be reached via multiple paths (due to symbolic * links), `cwd()` may return any one of them. * * ```ts * const currentWorkingDirectory = Deno.cwd(); * ``` * * Throws {@linkcode Deno.errors.NotFound} if directory not available. * * @category Runtime */ export function cwd(): string; /** * Creates `newpath` as a hard link to `oldpath`. * * ```ts * await Deno.link("old/name", "new/name"); * ``` * * Requires `allow-read` and `allow-write` permissions. * * @tags allow-read, allow-write * @category File System */ export function link(oldpath: string, newpath: string): Promise; /** * Synchronously creates `newpath` as a hard link to `oldpath`. * * ```ts * Deno.linkSync("old/name", "new/name"); * ``` * * Requires `allow-read` and `allow-write` permissions. * * @tags allow-read, allow-write * @category File System */ export function linkSync(oldpath: string, newpath: string): void; /** * A enum which defines the seek mode for IO related APIs that support * seeking. * * @category I/O */ export enum SeekMode { /* Seek from the start of the file/resource. */ Start = 0, /* Seek from the current position within the file/resource. */ Current = 1, /* Seek from the end of the current file/resource. */ End = 2, } /** Open a file and resolve to an instance of {@linkcode Deno.FsFile}. The * file does not need to previously exist if using the `create` or `createNew` * open options. The caller may have the resulting file automatically closed * by the runtime once it's out of scope by declaring the file variable with * the `using` keyword. * * ```ts * using file = await Deno.open("/foo/bar.txt", { read: true, write: true }); * // Do work with file * ``` * * Alternatively, the caller may manually close the resource when finished with * it. * * ```ts * const file = await Deno.open("/foo/bar.txt", { read: true, write: true }); * // Do work with file * file.close(); * ``` * * Requires `allow-read` and/or `allow-write` permissions depending on * options. * * @tags allow-read, allow-write * @category File System */ export function open( path: string | URL, options?: OpenOptions, ): Promise; /** Synchronously open a file and return an instance of * {@linkcode Deno.FsFile}. The file does not need to previously exist if * using the `create` or `createNew` open options. The caller may have the * resulting file automatically closed by the runtime once it's out of scope * by declaring the file variable with the `using` keyword. * * ```ts * using file = Deno.openSync("/foo/bar.txt", { read: true, write: true }); * // Do work with file * ``` * * Alternatively, the caller may manually close the resource when finished with * it. * * ```ts * const file = Deno.openSync("/foo/bar.txt", { read: true, write: true }); * // Do work with file * file.close(); * ``` * * Requires `allow-read` and/or `allow-write` permissions depending on * options. * * @tags allow-read, allow-write * @category File System */ export function openSync(path: string | URL, options?: OpenOptions): FsFile; /** Creates a file if none exists or truncates an existing file and resolves to * an instance of {@linkcode Deno.FsFile}. * * ```ts * const file = await Deno.create("/foo/bar.txt"); * ``` * * Requires `allow-read` and `allow-write` permissions. * * @tags allow-read, allow-write * @category File System */ export function create(path: string | URL): Promise; /** Creates a file if none exists or truncates an existing file and returns * an instance of {@linkcode Deno.FsFile}. * * ```ts * const file = Deno.createSync("/foo/bar.txt"); * ``` * * Requires `allow-read` and `allow-write` permissions. * * @tags allow-read, allow-write * @category File System */ export function createSync(path: string | URL): FsFile; /** The Deno abstraction for reading and writing files. * * This is the most straight forward way of handling files within Deno and is * recommended over using the discrete functions within the `Deno` namespace. * * ```ts * using file = await Deno.open("/foo/bar.txt", { read: true }); * const fileInfo = await file.stat(); * if (fileInfo.isFile) { * const buf = new Uint8Array(100); * const numberOfBytesRead = await file.read(buf); // 11 bytes * const text = new TextDecoder().decode(buf); // "hello world" * } * ``` * * @category File System */ export class FsFile implements Disposable { /** A {@linkcode ReadableStream} instance representing to the byte contents * of the file. This makes it easy to interoperate with other web streams * based APIs. * * ```ts * using file = await Deno.open("my_file.txt", { read: true }); * const decoder = new TextDecoder(); * for await (const chunk of file.readable) { * console.log(decoder.decode(chunk)); * } * ``` */ readonly readable: ReadableStream>; /** A {@linkcode WritableStream} instance to write the contents of the * file. This makes it easy to interoperate with other web streams based * APIs. * * ```ts * const items = ["hello", "world"]; * using file = await Deno.open("my_file.txt", { write: true }); * const encoder = new TextEncoder(); * const writer = file.writable.getWriter(); * for (const item of items) { * await writer.write(encoder.encode(item)); * } * ``` */ readonly writable: WritableStream>; /** Write the contents of the array buffer (`p`) to the file. * * Resolves to the number of bytes written. * * **It is not guaranteed that the full buffer will be written in a single * call.** * * ```ts * const encoder = new TextEncoder(); * const data = encoder.encode("Hello world"); * using file = await Deno.open("/foo/bar.txt", { write: true }); * const bytesWritten = await file.write(data); // 11 * ``` * * @category I/O */ write(p: Uint8Array): Promise; /** Synchronously write the contents of the array buffer (`p`) to the file. * * Returns the number of bytes written. * * **It is not guaranteed that the full buffer will be written in a single * call.** * * ```ts * const encoder = new TextEncoder(); * const data = encoder.encode("Hello world"); * using file = Deno.openSync("/foo/bar.txt", { write: true }); * const bytesWritten = file.writeSync(data); // 11 * ``` */ writeSync(p: Uint8Array): number; /** Truncates (or extends) the file to reach the specified `len`. If `len` * is not specified, then the entire file contents are truncated. * * ### Truncate the entire file * * ```ts * using file = await Deno.open("my_file.txt", { write: true }); * await file.truncate(); * ``` * * ### Truncate part of the file * * ```ts * // if "my_file.txt" contains the text "hello world": * using file = await Deno.open("my_file.txt", { write: true }); * await file.truncate(7); * const buf = new Uint8Array(100); * await file.read(buf); * const text = new TextDecoder().decode(buf); // "hello w" * ``` */ truncate(len?: number): Promise; /** Synchronously truncates (or extends) the file to reach the specified * `len`. If `len` is not specified, then the entire file contents are * truncated. * * ### Truncate the entire file * * ```ts * using file = Deno.openSync("my_file.txt", { write: true }); * file.truncateSync(); * ``` * * ### Truncate part of the file * * ```ts * // if "my_file.txt" contains the text "hello world": * using file = Deno.openSync("my_file.txt", { write: true }); * file.truncateSync(7); * const buf = new Uint8Array(100); * file.readSync(buf); * const text = new TextDecoder().decode(buf); // "hello w" * ``` */ truncateSync(len?: number): void; /** Read the file into an array buffer (`p`). * * Resolves to either the number of bytes read during the operation or EOF * (`null`) if there was nothing more to read. * * It is possible for a read to successfully return with `0` bytes. This * does not indicate EOF. * * **It is not guaranteed that the full buffer will be read in a single * call.** * * ```ts * // if "/foo/bar.txt" contains the text "hello world": * using file = await Deno.open("/foo/bar.txt"); * const buf = new Uint8Array(100); * const numberOfBytesRead = await file.read(buf); // 11 bytes * const text = new TextDecoder().decode(buf); // "hello world" * ``` */ read(p: Uint8Array): Promise; /** Synchronously read from the file into an array buffer (`p`). * * Returns either the number of bytes read during the operation or EOF * (`null`) if there was nothing more to read. * * It is possible for a read to successfully return with `0` bytes. This * does not indicate EOF. * * **It is not guaranteed that the full buffer will be read in a single * call.** * * ```ts * // if "/foo/bar.txt" contains the text "hello world": * using file = Deno.openSync("/foo/bar.txt"); * const buf = new Uint8Array(100); * const numberOfBytesRead = file.readSync(buf); // 11 bytes * const text = new TextDecoder().decode(buf); // "hello world" * ``` */ readSync(p: Uint8Array): number | null; /** Seek to the given `offset` under mode given by `whence`. The call * resolves to the new position within the resource (bytes from the start). * * ```ts * // Given the file contains "Hello world" text, which is 11 bytes long: * using file = await Deno.open( * "hello.txt", * { read: true, write: true, truncate: true, create: true }, * ); * await file.write(new TextEncoder().encode("Hello world")); * * // advance cursor 6 bytes * const cursorPosition = await file.seek(6, Deno.SeekMode.Start); * console.log(cursorPosition); // 6 * const buf = new Uint8Array(100); * await file.read(buf); * console.log(new TextDecoder().decode(buf)); // "world" * ``` * * The seek modes work as follows: * * ```ts * // Given the file contains "Hello world" text, which is 11 bytes long: * const file = await Deno.open( * "hello.txt", * { read: true, write: true, truncate: true, create: true }, * ); * await file.write(new TextEncoder().encode("Hello world")); * * // Seek 6 bytes from the start of the file * console.log(await file.seek(6, Deno.SeekMode.Start)); // "6" * // Seek 2 more bytes from the current position * console.log(await file.seek(2, Deno.SeekMode.Current)); // "8" * // Seek backwards 2 bytes from the end of the file * console.log(await file.seek(-2, Deno.SeekMode.End)); // "9" (i.e. 11-2) * ``` */ seek(offset: number | bigint, whence: SeekMode): Promise; /** Synchronously seek to the given `offset` under mode given by `whence`. * The new position within the resource (bytes from the start) is returned. * * ```ts * using file = Deno.openSync( * "hello.txt", * { read: true, write: true, truncate: true, create: true }, * ); * file.writeSync(new TextEncoder().encode("Hello world")); * * // advance cursor 6 bytes * const cursorPosition = file.seekSync(6, Deno.SeekMode.Start); * console.log(cursorPosition); // 6 * const buf = new Uint8Array(100); * file.readSync(buf); * console.log(new TextDecoder().decode(buf)); // "world" * ``` * * The seek modes work as follows: * * ```ts * // Given the file contains "Hello world" text, which is 11 bytes long: * using file = Deno.openSync( * "hello.txt", * { read: true, write: true, truncate: true, create: true }, * ); * file.writeSync(new TextEncoder().encode("Hello world")); * * // Seek 6 bytes from the start of the file * console.log(file.seekSync(6, Deno.SeekMode.Start)); // "6" * // Seek 2 more bytes from the current position * console.log(file.seekSync(2, Deno.SeekMode.Current)); // "8" * // Seek backwards 2 bytes from the end of the file * console.log(file.seekSync(-2, Deno.SeekMode.End)); // "9" (i.e. 11-2) * ``` */ seekSync(offset: number | bigint, whence: SeekMode): number; /** Resolves to a {@linkcode Deno.FileInfo} for the file. * * ```ts * import { assert } from "jsr:@std/assert"; * * using file = await Deno.open("hello.txt"); * const fileInfo = await file.stat(); * assert(fileInfo.isFile); * ``` */ stat(): Promise; /** Synchronously returns a {@linkcode Deno.FileInfo} for the file. * * ```ts * import { assert } from "jsr:@std/assert"; * * using file = Deno.openSync("hello.txt") * const fileInfo = file.statSync(); * assert(fileInfo.isFile); * ``` */ statSync(): FileInfo; /** * Flushes any pending data and metadata operations of the given file * stream to disk. * * ```ts * const file = await Deno.open( * "my_file.txt", * { read: true, write: true, create: true }, * ); * await file.write(new TextEncoder().encode("Hello World")); * await file.truncate(1); * await file.sync(); * console.log(await Deno.readTextFile("my_file.txt")); // H * ``` * * @category I/O */ sync(): Promise; /** * Synchronously flushes any pending data and metadata operations of the given * file stream to disk. * * ```ts * const file = Deno.openSync( * "my_file.txt", * { read: true, write: true, create: true }, * ); * file.writeSync(new TextEncoder().encode("Hello World")); * file.truncateSync(1); * file.syncSync(); * console.log(Deno.readTextFileSync("my_file.txt")); // H * ``` * * @category I/O */ syncSync(): void; /** * Flushes any pending data operations of the given file stream to disk. * ```ts * using file = await Deno.open( * "my_file.txt", * { read: true, write: true, create: true }, * ); * await file.write(new TextEncoder().encode("Hello World")); * await file.syncData(); * console.log(await Deno.readTextFile("my_file.txt")); // Hello World * ``` * * @category I/O */ syncData(): Promise; /** * Synchronously flushes any pending data operations of the given file stream * to disk. * * ```ts * using file = Deno.openSync( * "my_file.txt", * { read: true, write: true, create: true }, * ); * file.writeSync(new TextEncoder().encode("Hello World")); * file.syncDataSync(); * console.log(Deno.readTextFileSync("my_file.txt")); // Hello World * ``` * * @category I/O */ syncDataSync(): void; /** * Changes the access (`atime`) and modification (`mtime`) times of the * file stream resource. Given times are either in seconds (UNIX epoch * time) or as `Date` objects. * * ```ts * using file = await Deno.open("file.txt", { create: true, write: true }); * await file.utime(1556495550, new Date()); * ``` * * @category File System */ utime(atime: number | Date, mtime: number | Date): Promise; /** * Synchronously changes the access (`atime`) and modification (`mtime`) * times of the file stream resource. Given times are either in seconds * (UNIX epoch time) or as `Date` objects. * * ```ts * using file = Deno.openSync("file.txt", { create: true, write: true }); * file.utime(1556495550, new Date()); * ``` * * @category File System */ utimeSync(atime: number | Date, mtime: number | Date): void; /** * Checks if the file resource is a TTY (terminal). * * ```ts * // This example is system and context specific * using file = await Deno.open("/dev/tty6"); * file.isTerminal(); // true * ``` */ isTerminal(): boolean; /** * Set TTY to be under raw mode or not. In raw mode, characters are read and * returned as is, without being processed. All special processing of * characters by the terminal is disabled, including echoing input * characters. Reading from a TTY device in raw mode is faster than reading * from a TTY device in canonical mode. * * ```ts * using file = await Deno.open("/dev/tty6"); * file.setRaw(true, { cbreak: true }); * ``` */ setRaw(mode: boolean, options?: SetRawOptions): void; /** * Acquire an advisory file-system lock for the file. * * @param [exclusive=false] */ lock(exclusive?: boolean): Promise; /** * Synchronously acquire an advisory file-system lock synchronously for the file. * * @param [exclusive=false] */ lockSync(exclusive?: boolean): void; /** * Try to acquire an advisory file-system lock for the file. Returns `true` * if the lock was acquired, `false` if the file is already locked. * * Unlike {@linkcode Deno.FsFile.lock}, this method will not block if the * lock cannot be acquired. * * @param [exclusive=false] */ tryLock(exclusive?: boolean): Promise; /** * Synchronously try to acquire an advisory file-system lock for the file. * Returns `true` if the lock was acquired, `false` if the file is already locked. * * Unlike {@linkcode Deno.FsFile.lockSync}, this method will not block if the * lock cannot be acquired. * * @param [exclusive=false] */ tryLockSync(exclusive?: boolean): boolean; /** * Release an advisory file-system lock for the file. */ unlock(): Promise; /** * Synchronously release an advisory file-system lock for the file. */ unlockSync(): void; /** Close the file. Closing a file when you are finished with it is * important to avoid leaking resources. * * ```ts * using file = await Deno.open("my_file.txt"); * // do work with "file" object * ``` */ close(): void; [Symbol.dispose](): void; } /** Gets the size of the console as columns/rows. * * ```ts * const { columns, rows } = Deno.consoleSize(); * ``` * * This returns the size of the console window as reported by the operating * system. It's not a reflection of how many characters will fit within the * console window, but can be used as part of that calculation. * * @category I/O */ export function consoleSize(): { columns: number; rows: number; }; /** @category I/O */ export interface SetRawOptions { /** * The `cbreak` option can be used to indicate that characters that * correspond to a signal should still be generated. When disabling raw * mode, this option is ignored. This functionality currently only works on * Linux and Mac OS. */ cbreak: boolean; } /** A reference to `stdin` which can be used to read directly from `stdin`. * * It implements the Deno specific * {@linkcode https://jsr.io/@std/io/doc/types/~/Reader | Reader}, * {@linkcode https://jsr.io/@std/io/doc/types/~/ReaderSync | ReaderSync}, * and {@linkcode https://jsr.io/@std/io/doc/types/~/Closer | Closer} * interfaces as well as provides a {@linkcode ReadableStream} interface. * * ### Reading chunks from the readable stream * * ```ts * const decoder = new TextDecoder(); * for await (const chunk of Deno.stdin.readable) { * const text = decoder.decode(chunk); * // do something with the text * } * ``` * * @category I/O */ export const stdin: { /** Read the incoming data from `stdin` into an array buffer (`p`). * * Resolves to either the number of bytes read during the operation or EOF * (`null`) if there was nothing more to read. * * It is possible for a read to successfully return with `0` bytes. This * does not indicate EOF. * * **It is not guaranteed that the full buffer will be read in a single * call.** * * ```ts * // If the text "hello world" is piped into the script: * const buf = new Uint8Array(100); * const numberOfBytesRead = await Deno.stdin.read(buf); // 11 bytes * const text = new TextDecoder().decode(buf); // "hello world" * ``` * * @category I/O */ read(p: Uint8Array): Promise; /** Synchronously read from the incoming data from `stdin` into an array * buffer (`p`). * * Returns either the number of bytes read during the operation or EOF * (`null`) if there was nothing more to read. * * It is possible for a read to successfully return with `0` bytes. This * does not indicate EOF. * * **It is not guaranteed that the full buffer will be read in a single * call.** * * ```ts * // If the text "hello world" is piped into the script: * const buf = new Uint8Array(100); * const numberOfBytesRead = Deno.stdin.readSync(buf); // 11 bytes * const text = new TextDecoder().decode(buf); // "hello world" * ``` * * @category I/O */ readSync(p: Uint8Array): number | null; /** Closes `stdin`, freeing the resource. * * ```ts * Deno.stdin.close(); * ``` */ close(): void; /** A readable stream interface to `stdin`. */ readonly readable: ReadableStream>; /** * Set TTY to be under raw mode or not. In raw mode, characters are read and * returned as is, without being processed. All special processing of * characters by the terminal is disabled, including echoing input * characters. Reading from a TTY device in raw mode is faster than reading * from a TTY device in canonical mode. * * ```ts * Deno.stdin.setRaw(true, { cbreak: true }); * ``` * * @category I/O */ setRaw(mode: boolean, options?: SetRawOptions): void; /** * Checks if `stdin` is a TTY (terminal). * * ```ts * // This example is system and context specific * Deno.stdin.isTerminal(); // true * ``` * * @category I/O */ isTerminal(): boolean; }; /** A reference to `stdout` which can be used to write directly to `stdout`. * It implements the Deno specific * {@linkcode https://jsr.io/@std/io/doc/types/~/Writer | Writer}, * {@linkcode https://jsr.io/@std/io/doc/types/~/WriterSync | WriterSync}, * and {@linkcode https://jsr.io/@std/io/doc/types/~/Closer | Closer} interfaces as well as provides a * {@linkcode WritableStream} interface. * * These are low level constructs, and the {@linkcode console} interface is a * more straight forward way to interact with `stdout` and `stderr`. * * @category I/O */ export const stdout: { /** Write the contents of the array buffer (`p`) to `stdout`. * * Resolves to the number of bytes written. * * **It is not guaranteed that the full buffer will be written in a single * call.** * * ```ts * const encoder = new TextEncoder(); * const data = encoder.encode("Hello world"); * const bytesWritten = await Deno.stdout.write(data); // 11 * ``` * * @category I/O */ write(p: Uint8Array): Promise; /** Synchronously write the contents of the array buffer (`p`) to `stdout`. * * Returns the number of bytes written. * * **It is not guaranteed that the full buffer will be written in a single * call.** * * ```ts * const encoder = new TextEncoder(); * const data = encoder.encode("Hello world"); * const bytesWritten = Deno.stdout.writeSync(data); // 11 * ``` */ writeSync(p: Uint8Array): number; /** Closes `stdout`, freeing the resource. * * ```ts * Deno.stdout.close(); * ``` */ close(): void; /** A writable stream interface to `stdout`. */ readonly writable: WritableStream>; /** * Checks if `stdout` is a TTY (terminal). * * ```ts * // This example is system and context specific * Deno.stdout.isTerminal(); // true * ``` * * @category I/O */ isTerminal(): boolean; }; /** A reference to `stderr` which can be used to write directly to `stderr`. * It implements the Deno specific * {@linkcode https://jsr.io/@std/io/doc/types/~/Writer | Writer}, * {@linkcode https://jsr.io/@std/io/doc/types/~/WriterSync | WriterSync}, * and {@linkcode https://jsr.io/@std/io/doc/types/~/Closer | Closer} interfaces as well as provides a * {@linkcode WritableStream} interface. * * These are low level constructs, and the {@linkcode console} interface is a * more straight forward way to interact with `stdout` and `stderr`. * * @category I/O */ export const stderr: { /** Write the contents of the array buffer (`p`) to `stderr`. * * Resolves to the number of bytes written. * * **It is not guaranteed that the full buffer will be written in a single * call.** * * ```ts * const encoder = new TextEncoder(); * const data = encoder.encode("Hello world"); * const bytesWritten = await Deno.stderr.write(data); // 11 * ``` * * @category I/O */ write(p: Uint8Array): Promise; /** Synchronously write the contents of the array buffer (`p`) to `stderr`. * * Returns the number of bytes written. * * **It is not guaranteed that the full buffer will be written in a single * call.** * * ```ts * const encoder = new TextEncoder(); * const data = encoder.encode("Hello world"); * const bytesWritten = Deno.stderr.writeSync(data); // 11 * ``` */ writeSync(p: Uint8Array): number; /** Closes `stderr`, freeing the resource. * * ```ts * Deno.stderr.close(); * ``` */ close(): void; /** A writable stream interface to `stderr`. */ readonly writable: WritableStream>; /** * Checks if `stderr` is a TTY (terminal). * * ```ts * // This example is system and context specific * Deno.stderr.isTerminal(); // true * ``` * * @category I/O */ isTerminal(): boolean; }; /** * Options which can be set when doing {@linkcode Deno.open} and * {@linkcode Deno.openSync}. * * @category File System */ export interface OpenOptions { /** Sets the option for read access. This option, when `true`, means that * the file should be read-able if opened. * * @default {true} */ read?: boolean; /** Sets the option for write access. This option, when `true`, means that * the file should be write-able if opened. If the file already exists, * any write calls on it will overwrite its contents, by default without * truncating it. * * @default {false} */ write?: boolean; /** Sets the option for the append mode. This option, when `true`, means * that writes will append to a file instead of overwriting previous * contents. * * Note that setting `{ write: true, append: true }` has the same effect as * setting only `{ append: true }`. * * @default {false} */ append?: boolean; /** Sets the option for truncating a previous file. If a file is * successfully opened with this option set it will truncate the file to `0` * size if it already exists. The file must be opened with write access * for truncate to work. * * @default {false} */ truncate?: boolean; /** Sets the option to allow creating a new file, if one doesn't already * exist at the specified path. Requires write or append access to be * used. * * @default {false} */ create?: boolean; /** If set to `true`, no file, directory, or symlink is allowed to exist at * the target location. Requires write or append access to be used. When * createNew is set to `true`, create and truncate are ignored. * * @default {false} */ createNew?: boolean; /** Permissions to use if creating the file (defaults to `0o666`, before * the process's umask). * * Ignored on Windows. */ mode?: number; } /** * Options which can be set when using {@linkcode Deno.readFile} or * {@linkcode Deno.readFileSync}. * * @category File System */ export interface ReadFileOptions { /** * An abort signal to allow cancellation of the file read operation. * If the signal becomes aborted the readFile operation will be stopped * and the promise returned will be rejected with an AbortError. */ signal?: AbortSignal; } /** * Options which can be set when using {@linkcode Deno.mkdir} and * {@linkcode Deno.mkdirSync}. * * @category File System */ export interface MkdirOptions { /** If set to `true`, means that any intermediate directories will also be * created (as with the shell command `mkdir -p`). * * Intermediate directories are created with the same permissions. * * When recursive is set to `true`, succeeds silently (without changing any * permissions) if a directory already exists at the path, or if the path * is a symlink to an existing directory. * * @default {false} */ recursive?: boolean; /** Permissions to use when creating the directory (defaults to `0o777`, * before the process's umask). * * Ignored on Windows. */ mode?: number; } /** Creates a new directory with the specified path. * * ```ts * await Deno.mkdir("new_dir"); * await Deno.mkdir("nested/directories", { recursive: true }); * await Deno.mkdir("restricted_access_dir", { mode: 0o700 }); * ``` * * Throws if the directory already exists, unless `recursive` is set to * `true`. * * Requires `allow-write` permission. * * @tags allow-write * @category File System */ export function mkdir( path: string | URL, options?: MkdirOptions, ): Promise; /** Synchronously creates a new directory with the specified path. * * ```ts * Deno.mkdirSync("new_dir"); * Deno.mkdirSync("nested/directories", { recursive: true }); * Deno.mkdirSync("restricted_access_dir", { mode: 0o700 }); * ``` * * Throws if the directory already exists, unless `recursive` is set to * `true`. * * Requires `allow-write` permission. * * @tags allow-write * @category File System */ export function mkdirSync(path: string | URL, options?: MkdirOptions): void; /** * Options which can be set when using {@linkcode Deno.makeTempDir}, * {@linkcode Deno.makeTempDirSync}, {@linkcode Deno.makeTempFile}, and * {@linkcode Deno.makeTempFileSync}. * * @category File System */ export interface MakeTempOptions { /** Directory where the temporary directory should be created (defaults to * the env variable `TMPDIR`, or the system's default, usually `/tmp`). * * Note that if the passed `dir` is relative, the path returned by * `makeTempFile()` and `makeTempDir()` will also be relative. Be mindful of * this when changing working directory. */ dir?: string; /** String that should precede the random portion of the temporary * directory's name. */ prefix?: string; /** String that should follow the random portion of the temporary * directory's name. */ suffix?: string; } /** Creates a new temporary directory in the default directory for temporary * files, unless `dir` is specified. Other optional options include * prefixing and suffixing the directory name with `prefix` and `suffix` * respectively. * * This call resolves to the full path to the newly created directory. * * Multiple programs calling this function simultaneously will create different * directories. It is the caller's responsibility to remove the directory when * no longer needed. * * ```ts * const tempDirName0 = await Deno.makeTempDir(); // e.g. /tmp/2894ea76 * const tempDirName1 = await Deno.makeTempDir({ prefix: 'my_temp' }); // e.g. /tmp/my_temp339c944d * ``` * * Requires `allow-write` permission. * * @tags allow-write * @category File System */ // TODO(ry) Doesn't check permissions. export function makeTempDir(options?: MakeTempOptions): Promise; /** Synchronously creates a new temporary directory in the default directory * for temporary files, unless `dir` is specified. Other optional options * include prefixing and suffixing the directory name with `prefix` and * `suffix` respectively. * * The full path to the newly created directory is returned. * * Multiple programs calling this function simultaneously will create different * directories. It is the caller's responsibility to remove the directory when * no longer needed. * * ```ts * const tempDirName0 = Deno.makeTempDirSync(); // e.g. /tmp/2894ea76 * const tempDirName1 = Deno.makeTempDirSync({ prefix: 'my_temp' }); // e.g. /tmp/my_temp339c944d * ``` * * Requires `allow-write` permission. * * @tags allow-write * @category File System */ // TODO(ry) Doesn't check permissions. export function makeTempDirSync(options?: MakeTempOptions): string; /** Creates a new temporary file in the default directory for temporary * files, unless `dir` is specified. * * Other options include prefixing and suffixing the directory name with * `prefix` and `suffix` respectively. * * This call resolves to the full path to the newly created file. * * Multiple programs calling this function simultaneously will create * different files. It is the caller's responsibility to remove the file when * no longer needed. * * ```ts * const tmpFileName0 = await Deno.makeTempFile(); // e.g. /tmp/419e0bf2 * const tmpFileName1 = await Deno.makeTempFile({ prefix: 'my_temp' }); // e.g. /tmp/my_temp754d3098 * ``` * * Requires `allow-write` permission. * * @tags allow-write * @category File System */ export function makeTempFile(options?: MakeTempOptions): Promise; /** Synchronously creates a new temporary file in the default directory for * temporary files, unless `dir` is specified. * * Other options include prefixing and suffixing the directory name with * `prefix` and `suffix` respectively. * * The full path to the newly created file is returned. * * Multiple programs calling this function simultaneously will create * different files. It is the caller's responsibility to remove the file when * no longer needed. * * ```ts * const tempFileName0 = Deno.makeTempFileSync(); // e.g. /tmp/419e0bf2 * const tempFileName1 = Deno.makeTempFileSync({ prefix: 'my_temp' }); // e.g. /tmp/my_temp754d3098 * ``` * * Requires `allow-write` permission. * * @tags allow-write * @category File System */ export function makeTempFileSync(options?: MakeTempOptions): string; /** Changes the permission of a specific file/directory of specified path. * Ignores the process's umask. * * ```ts * await Deno.chmod("/path/to/file", 0o666); * ``` * * The mode is a sequence of 3 octal numbers. The first/left-most number * specifies the permissions for the owner. The second number specifies the * permissions for the group. The last/right-most number specifies the * permissions for others. For example, with a mode of 0o764, the owner (7) * can read/write/execute, the group (6) can read/write and everyone else (4) * can read only. * * | Number | Description | * | ------ | ----------- | * | 7 | read, write, and execute | * | 6 | read and write | * | 5 | read and execute | * | 4 | read only | * | 3 | write and execute | * | 2 | write only | * | 1 | execute only | * | 0 | no permission | * * Note: On Windows, only the read and write permissions can be modified. * Distinctions between owner, group, and others are not supported. * * Requires `allow-write` permission. * * @tags allow-write * @category File System */ export function chmod(path: string | URL, mode: number): Promise; /** Synchronously changes the permission of a specific file/directory of * specified path. Ignores the process's umask. * * ```ts * Deno.chmodSync("/path/to/file", 0o666); * ``` * * For a full description, see {@linkcode Deno.chmod}. * * Requires `allow-write` permission. * * @tags allow-write * @category File System */ export function chmodSync(path: string | URL, mode: number): void; /** Change owner of a regular file or directory. * * This functionality is not available on Windows. * * ```ts * await Deno.chown("myFile.txt", 1000, 1002); * ``` * * Requires `allow-write` permission. * * Throws Error (not implemented) if executed on Windows. * * @tags allow-write * @category File System * * @param path path to the file * @param uid user id (UID) of the new owner, or `null` for no change * @param gid group id (GID) of the new owner, or `null` for no change */ export function chown( path: string | URL, uid: number | null, gid: number | null, ): Promise; /** Synchronously change owner of a regular file or directory. * * This functionality is not available on Windows. * * ```ts * Deno.chownSync("myFile.txt", 1000, 1002); * ``` * * Requires `allow-write` permission. * * Throws Error (not implemented) if executed on Windows. * * @tags allow-write * @category File System * * @param path path to the file * @param uid user id (UID) of the new owner, or `null` for no change * @param gid group id (GID) of the new owner, or `null` for no change */ export function chownSync( path: string | URL, uid: number | null, gid: number | null, ): void; /** * Options which can be set when using {@linkcode Deno.remove} and * {@linkcode Deno.removeSync}. * * @category File System */ export interface RemoveOptions { /** If set to `true`, path will be removed even if it's a non-empty directory. * * @default {false} */ recursive?: boolean; } /** Removes the named file or directory. * * ```ts * await Deno.remove("/path/to/empty_dir/or/file"); * await Deno.remove("/path/to/populated_dir/or/file", { recursive: true }); * ``` * * Throws error if permission denied, path not found, or path is a non-empty * directory and the `recursive` option isn't set to `true`. * * Requires `allow-write` permission. * * @tags allow-write * @category File System */ export function remove( path: string | URL, options?: RemoveOptions, ): Promise; /** Synchronously removes the named file or directory. * * ```ts * Deno.removeSync("/path/to/empty_dir/or/file"); * Deno.removeSync("/path/to/populated_dir/or/file", { recursive: true }); * ``` * * Throws error if permission denied, path not found, or path is a non-empty * directory and the `recursive` option isn't set to `true`. * * Requires `allow-write` permission. * * @tags allow-write * @category File System */ export function removeSync(path: string | URL, options?: RemoveOptions): void; /** Synchronously renames (moves) `oldpath` to `newpath`. Paths may be files or * directories. If `newpath` already exists and is not a directory, * `renameSync()` replaces it. OS-specific restrictions may apply when * `oldpath` and `newpath` are in different directories. * * ```ts * Deno.renameSync("old/path", "new/path"); * ``` * * On Unix-like OSes, this operation does not follow symlinks at either path. * * It varies between platforms when the operation throws errors, and if so what * they are. It's always an error to rename anything to a non-empty directory. * * Requires `allow-read` and `allow-write` permissions. * * @tags allow-read, allow-write * @category File System */ export function renameSync( oldpath: string | URL, newpath: string | URL, ): void; /** Renames (moves) `oldpath` to `newpath`. Paths may be files or directories. * If `newpath` already exists and is not a directory, `rename()` replaces it. * OS-specific restrictions may apply when `oldpath` and `newpath` are in * different directories. * * ```ts * await Deno.rename("old/path", "new/path"); * ``` * * On Unix-like OSes, this operation does not follow symlinks at either path. * * It varies between platforms when the operation throws errors, and if so * what they are. It's always an error to rename anything to a non-empty * directory. * * Requires `allow-read` and `allow-write` permissions. * * @tags allow-read, allow-write * @category File System */ export function rename( oldpath: string | URL, newpath: string | URL, ): Promise; /** Asynchronously reads and returns the entire contents of a file as an UTF-8 * decoded string. Reading a directory throws an error. * * ```ts * const data = await Deno.readTextFile("hello.txt"); * console.log(data); * ``` * * Requires `allow-read` permission. * * @tags allow-read * @category File System */ export function readTextFile( path: string | URL, options?: ReadFileOptions, ): Promise; /** Synchronously reads and returns the entire contents of a file as an UTF-8 * decoded string. Reading a directory throws an error. * * ```ts * const data = Deno.readTextFileSync("hello.txt"); * console.log(data); * ``` * * Requires `allow-read` permission. * * @tags allow-read * @category File System */ export function readTextFileSync(path: string | URL): string; /** Reads and resolves to the entire contents of a file as an array of bytes. * `TextDecoder` can be used to transform the bytes to string if required. * Rejects with an error when reading a directory. * * ```ts * const decoder = new TextDecoder("utf-8"); * const data = await Deno.readFile("hello.txt"); * console.log(decoder.decode(data)); * ``` * * Requires `allow-read` permission. * * @tags allow-read * @category File System */ export function readFile( path: string | URL, options?: ReadFileOptions, ): Promise>; /** Synchronously reads and returns the entire contents of a file as an array * of bytes. `TextDecoder` can be used to transform the bytes to string if * required. Throws an error when reading a directory. * * ```ts * const decoder = new TextDecoder("utf-8"); * const data = Deno.readFileSync("hello.txt"); * console.log(decoder.decode(data)); * ``` * * Requires `allow-read` permission. * * @tags allow-read * @category File System */ export function readFileSync(path: string | URL): Uint8Array; /** Provides information about a file and is returned by * {@linkcode Deno.stat}, {@linkcode Deno.lstat}, {@linkcode Deno.statSync}, * and {@linkcode Deno.lstatSync} or from calling `stat()` and `statSync()` * on an {@linkcode Deno.FsFile} instance. * * @category File System */ export interface FileInfo { /** True if this is info for a regular file. Mutually exclusive to * `FileInfo.isDirectory` and `FileInfo.isSymlink`. */ isFile: boolean; /** True if this is info for a regular directory. Mutually exclusive to * `FileInfo.isFile` and `FileInfo.isSymlink`. */ isDirectory: boolean; /** True if this is info for a symlink. Mutually exclusive to * `FileInfo.isFile` and `FileInfo.isDirectory`. */ isSymlink: boolean; /** The size of the file, in bytes. */ size: number; /** The last modification time of the file. This corresponds to the `mtime` * field from `stat` on Linux/Mac OS and `ftLastWriteTime` on Windows. This * may not be available on all platforms. */ mtime: Date | null; /** The last access time of the file. This corresponds to the `atime` * field from `stat` on Unix and `ftLastAccessTime` on Windows. This may not * be available on all platforms. */ atime: Date | null; /** The creation time of the file. This corresponds to the `birthtime` * field from `stat` on Mac/BSD and `ftCreationTime` on Windows. This may * not be available on all platforms. */ birthtime: Date | null; /** The last change time of the file. This corresponds to the `ctime` * field from `stat` on Mac/BSD and `ChangeTime` on Windows. This may * not be available on all platforms. */ ctime: Date | null; /** ID of the device containing the file. */ dev: number; /** Corresponds to the inode number on Unix systems. On Windows, this is * the file index number that is unique within a volume. This may not be * available on all platforms. */ ino: number | null; /** The underlying raw `st_mode` bits that contain the standard Unix * permissions for this file/directory. */ mode: number | null; /** Number of hard links pointing to this file. */ nlink: number | null; /** User ID of the owner of this file. * * _Linux/Mac OS only._ */ uid: number | null; /** Group ID of the owner of this file. * * _Linux/Mac OS only._ */ gid: number | null; /** Device ID of this file. * * _Linux/Mac OS only._ */ rdev: number | null; /** Blocksize for filesystem I/O. * * _Linux/Mac OS only._ */ blksize: number | null; /** Number of blocks allocated to the file, in 512-byte units. */ blocks: number | null; /** True if this is info for a block device. * * _Linux/Mac OS only._ */ isBlockDevice: boolean | null; /** True if this is info for a char device. * * _Linux/Mac OS only._ */ isCharDevice: boolean | null; /** True if this is info for a fifo. * * _Linux/Mac OS only._ */ isFifo: boolean | null; /** True if this is info for a socket. * * _Linux/Mac OS only._ */ isSocket: boolean | null; } /** Resolves to the absolute normalized path, with symbolic links resolved. * * ```ts * // e.g. given /home/alice/file.txt and current directory /home/alice * await Deno.symlink("file.txt", "symlink_file.txt"); * const realPath = await Deno.realPath("./file.txt"); * const realSymLinkPath = await Deno.realPath("./symlink_file.txt"); * console.log(realPath); // outputs "/home/alice/file.txt" * console.log(realSymLinkPath); // outputs "/home/alice/file.txt" * ``` * * Requires `allow-read` permission for the target path. * * Also requires `allow-read` permission for the `CWD` if the target path is * relative. * * @tags allow-read * @category File System */ export function realPath(path: string | URL): Promise; /** Synchronously returns absolute normalized path, with symbolic links * resolved. * * ```ts * // e.g. given /home/alice/file.txt and current directory /home/alice * Deno.symlinkSync("file.txt", "symlink_file.txt"); * const realPath = Deno.realPathSync("./file.txt"); * const realSymLinkPath = Deno.realPathSync("./symlink_file.txt"); * console.log(realPath); // outputs "/home/alice/file.txt" * console.log(realSymLinkPath); // outputs "/home/alice/file.txt" * ``` * * Requires `allow-read` permission for the target path. * * Also requires `allow-read` permission for the `CWD` if the target path is * relative. * * @tags allow-read * @category File System */ export function realPathSync(path: string | URL): string; /** * Information about a directory entry returned from {@linkcode Deno.readDir} * and {@linkcode Deno.readDirSync}. * * @category File System */ export interface DirEntry { /** The file name of the entry. It is just the entity name and does not * include the full path. */ name: string; /** True if this is info for a regular file. Mutually exclusive to * `DirEntry.isDirectory` and `DirEntry.isSymlink`. */ isFile: boolean; /** True if this is info for a regular directory. Mutually exclusive to * `DirEntry.isFile` and `DirEntry.isSymlink`. */ isDirectory: boolean; /** True if this is info for a symlink. Mutually exclusive to * `DirEntry.isFile` and `DirEntry.isDirectory`. */ isSymlink: boolean; } /** Reads the directory given by `path` and returns an async iterable of * {@linkcode Deno.DirEntry}. The order of entries is not guaranteed. * * ```ts * for await (const dirEntry of Deno.readDir("/")) { * console.log(dirEntry.name); * } * ``` * * Throws error if `path` is not a directory. * * Requires `allow-read` permission. * * @tags allow-read * @category File System */ export function readDir(path: string | URL): AsyncIterable; /** Synchronously reads the directory given by `path` and returns an iterable * of {@linkcode Deno.DirEntry}. The order of entries is not guaranteed. * * ```ts * for (const dirEntry of Deno.readDirSync("/")) { * console.log(dirEntry.name); * } * ``` * * Throws error if `path` is not a directory. * * Requires `allow-read` permission. * * @tags allow-read * @category File System */ export function readDirSync(path: string | URL): IteratorObject; /** Copies the contents and permissions of one file to another specified path, * by default creating a new file if needed, else overwriting. Fails if target * path is a directory or is unwritable. * * ```ts * await Deno.copyFile("from.txt", "to.txt"); * ``` * * Requires `allow-read` permission on `fromPath`. * * Requires `allow-write` permission on `toPath`. * * @tags allow-read, allow-write * @category File System */ export function copyFile( fromPath: string | URL, toPath: string | URL, ): Promise; /** Synchronously copies the contents and permissions of one file to another * specified path, by default creating a new file if needed, else overwriting. * Fails if target path is a directory or is unwritable. * * ```ts * Deno.copyFileSync("from.txt", "to.txt"); * ``` * * Requires `allow-read` permission on `fromPath`. * * Requires `allow-write` permission on `toPath`. * * @tags allow-read, allow-write * @category File System */ export function copyFileSync( fromPath: string | URL, toPath: string | URL, ): void; /** Resolves to the full path destination of the named symbolic link. * * ```ts * await Deno.symlink("./test.txt", "./test_link.txt"); * const target = await Deno.readLink("./test_link.txt"); // full path of ./test.txt * ``` * * Throws TypeError if called with a hard link. * * Requires `allow-read` permission. * * @tags allow-read * @category File System */ export function readLink(path: string | URL): Promise; /** Synchronously returns the full path destination of the named symbolic * link. * * ```ts * Deno.symlinkSync("./test.txt", "./test_link.txt"); * const target = Deno.readLinkSync("./test_link.txt"); // full path of ./test.txt * ``` * * Throws TypeError if called with a hard link. * * Requires `allow-read` permission. * * @tags allow-read * @category File System */ export function readLinkSync(path: string | URL): string; /** Resolves to a {@linkcode Deno.FileInfo} for the specified `path`. If * `path` is a symlink, information for the symlink will be returned instead * of what it points to. * * ```ts * import { assert } from "jsr:@std/assert"; * const fileInfo = await Deno.lstat("hello.txt"); * assert(fileInfo.isFile); * ``` * * Requires `allow-read` permission. * * @tags allow-read * @category File System */ export function lstat(path: string | URL): Promise; /** Synchronously returns a {@linkcode Deno.FileInfo} for the specified * `path`. If `path` is a symlink, information for the symlink will be * returned instead of what it points to. * * ```ts * import { assert } from "jsr:@std/assert"; * const fileInfo = Deno.lstatSync("hello.txt"); * assert(fileInfo.isFile); * ``` * * Requires `allow-read` permission. * * @tags allow-read * @category File System */ export function lstatSync(path: string | URL): FileInfo; /** Resolves to a {@linkcode Deno.FileInfo} for the specified `path`. Will * always follow symlinks. * * ```ts * import { assert } from "jsr:@std/assert"; * const fileInfo = await Deno.stat("hello.txt"); * assert(fileInfo.isFile); * ``` * * Requires `allow-read` permission. * * @tags allow-read * @category File System */ export function stat(path: string | URL): Promise; /** Synchronously returns a {@linkcode Deno.FileInfo} for the specified * `path`. Will always follow symlinks. * * ```ts * import { assert } from "jsr:@std/assert"; * const fileInfo = Deno.statSync("hello.txt"); * assert(fileInfo.isFile); * ``` * * Requires `allow-read` permission. * * @tags allow-read * @category File System */ export function statSync(path: string | URL): FileInfo; /** Options for writing to a file. * * @category File System */ export interface WriteFileOptions { /** If set to `true`, will append to a file instead of overwriting previous * contents. * * @default {false} */ append?: boolean; /** Sets the option to allow creating a new file, if one doesn't already * exist at the specified path. * * @default {true} */ create?: boolean; /** If set to `true`, no file, directory, or symlink is allowed to exist at * the target location. When createNew is set to `true`, `create` is ignored. * * @default {false} */ createNew?: boolean; /** Permissions always applied to file. */ mode?: number; /** An abort signal to allow cancellation of the file write operation. * * If the signal becomes aborted the write file operation will be stopped * and the promise returned will be rejected with an {@linkcode AbortError}. */ signal?: AbortSignal; } /** Write `data` to the given `path`, by default creating a new file if * needed, else overwriting. * * ```ts * const encoder = new TextEncoder(); * const data = encoder.encode("Hello world\n"); * await Deno.writeFile("hello1.txt", data); // overwrite "hello1.txt" or create it * await Deno.writeFile("hello2.txt", data, { create: false }); // only works if "hello2.txt" exists * await Deno.writeFile("hello3.txt", data, { mode: 0o777 }); // set permissions on new file * await Deno.writeFile("hello4.txt", data, { append: true }); // add data to the end of the file * ``` * * Requires `allow-write` permission, and `allow-read` if `options.create` is * `false`. * * @tags allow-read, allow-write * @category File System */ export function writeFile( path: string | URL, data: Uint8Array | ReadableStream, options?: WriteFileOptions, ): Promise; /** Synchronously write `data` to the given `path`, by default creating a new * file if needed, else overwriting. * * ```ts * const encoder = new TextEncoder(); * const data = encoder.encode("Hello world\n"); * Deno.writeFileSync("hello1.txt", data); // overwrite "hello1.txt" or create it * Deno.writeFileSync("hello2.txt", data, { create: false }); // only works if "hello2.txt" exists * Deno.writeFileSync("hello3.txt", data, { mode: 0o777 }); // set permissions on new file * Deno.writeFileSync("hello4.txt", data, { append: true }); // add data to the end of the file * ``` * * Requires `allow-write` permission, and `allow-read` if `options.create` is * `false`. * * @tags allow-read, allow-write * @category File System */ export function writeFileSync( path: string | URL, data: Uint8Array, options?: WriteFileOptions, ): void; /** Write string `data` to the given `path`, by default creating a new file if * needed, else overwriting. * * ```ts * await Deno.writeTextFile("hello1.txt", "Hello world\n"); // overwrite "hello1.txt" or create it * ``` * * Requires `allow-write` permission, and `allow-read` if `options.create` is * `false`. * * @tags allow-read, allow-write * @category File System */ export function writeTextFile( path: string | URL, data: string | ReadableStream, options?: WriteFileOptions, ): Promise; /** Synchronously write string `data` to the given `path`, by default creating * a new file if needed, else overwriting. * * ```ts * Deno.writeTextFileSync("hello1.txt", "Hello world\n"); // overwrite "hello1.txt" or create it * ``` * * Requires `allow-write` permission, and `allow-read` if `options.create` is * `false`. * * @tags allow-read, allow-write * @category File System */ export function writeTextFileSync( path: string | URL, data: string, options?: WriteFileOptions, ): void; /** Truncates (or extends) the specified file, to reach the specified `len`. * If `len` is not specified then the entire file contents are truncated. * * ### Truncate the entire file * ```ts * await Deno.truncate("my_file.txt"); * ``` * * ### Truncate part of the file * * ```ts * const file = await Deno.makeTempFile(); * await Deno.writeTextFile(file, "Hello World"); * await Deno.truncate(file, 7); * const data = await Deno.readFile(file); * console.log(new TextDecoder().decode(data)); // "Hello W" * ``` * * Requires `allow-write` permission. * * @tags allow-write * @category File System */ export function truncate(name: string, len?: number): Promise; /** Synchronously truncates (or extends) the specified file, to reach the * specified `len`. If `len` is not specified then the entire file contents * are truncated. * * ### Truncate the entire file * * ```ts * Deno.truncateSync("my_file.txt"); * ``` * * ### Truncate part of the file * * ```ts * const file = Deno.makeTempFileSync(); * Deno.writeFileSync(file, new TextEncoder().encode("Hello World")); * Deno.truncateSync(file, 7); * const data = Deno.readFileSync(file); * console.log(new TextDecoder().decode(data)); * ``` * * Requires `allow-write` permission. * * @tags allow-write * @category File System */ export function truncateSync(name: string, len?: number): void; /** * Additional information for FsEvent objects with the "other" kind. * * - `"rescan"`: rescan notices indicate either a lapse in the events or a * change in the filesystem such that events received so far can no longer * be relied on to represent the state of the filesystem now. An * application that simply reacts to file changes may not care about this. * An application that keeps an in-memory representation of the filesystem * will need to care, and will need to refresh that representation directly * from the filesystem. * * @category File System */ export type FsEventFlag = "rescan"; /** * Represents a unique file system event yielded by a * {@linkcode Deno.FsWatcher}. * * @category File System */ export interface FsEvent { /** The kind/type of the file system event. */ kind: | "any" | "access" | "create" | "modify" | "rename" | "remove" | "other"; /** An array of paths that are associated with the file system event. */ paths: string[]; /** Any additional flags associated with the event. */ flag?: FsEventFlag; } /** * Returned by {@linkcode Deno.watchFs}. It is an async iterator yielding up * system events. To stop watching the file system by calling `.close()` * method. * * @category File System */ export interface FsWatcher extends AsyncIterable, Disposable { /** Stops watching the file system and closes the watcher resource. */ close(): void; /** * Stops watching the file system and closes the watcher resource. */ return?(value?: any): Promise>; [Symbol.asyncIterator](): AsyncIterableIterator; } /** Watch for file system events against one or more `paths`, which can be * files or directories. These paths must exist already. One user action (e.g. * `touch test.file`) can generate multiple file system events. Likewise, * one user action can result in multiple file paths in one event (e.g. `mv * old_name.txt new_name.txt`). * * The recursive option is `true` by default and, for directories, will watch * the specified directory and all sub directories. * * Note that the exact ordering of the events can vary between operating * systems. * * ```ts * const watcher = Deno.watchFs("/"); * for await (const event of watcher) { * console.log(">>>> event", event); * // { kind: "create", paths: [ "/foo.txt" ] } * } * ``` * * Call `watcher.close()` to stop watching. * * ```ts * const watcher = Deno.watchFs("/"); * * setTimeout(() => { * watcher.close(); * }, 5000); * * for await (const event of watcher) { * console.log(">>>> event", event); * } * ``` * * Requires `allow-read` permission. * * @tags allow-read * @category File System */ export function watchFs( paths: string | string[], options?: { recursive: boolean }, ): FsWatcher; /** Operating signals which can be listened for or sent to sub-processes. What * signals and what their standard behaviors are OS dependent. * * @category Runtime */ export type Signal = | "SIGABRT" | "SIGALRM" | "SIGBREAK" | "SIGBUS" | "SIGCHLD" | "SIGCONT" | "SIGEMT" | "SIGFPE" | "SIGHUP" | "SIGILL" | "SIGINFO" | "SIGINT" | "SIGIO" | "SIGPOLL" | "SIGUNUSED" | "SIGKILL" | "SIGPIPE" | "SIGPROF" | "SIGPWR" | "SIGQUIT" | "SIGSEGV" | "SIGSTKFLT" | "SIGSTOP" | "SIGSYS" | "SIGTERM" | "SIGTRAP" | "SIGTSTP" | "SIGTTIN" | "SIGTTOU" | "SIGURG" | "SIGUSR1" | "SIGUSR2" | "SIGVTALRM" | "SIGWINCH" | "SIGXCPU" | "SIGXFSZ"; /** Registers the given function as a listener of the given signal event. * * ```ts * Deno.addSignalListener( * "SIGTERM", * () => { * console.log("SIGTERM!") * } * ); * ``` * * _Note_: On Windows only `"SIGINT"` (CTRL+C), `"SIGBREAK"` (CTRL+Break), * `"SIGTERM"`, `"SIGQUIT"`, `"SIGHUP"`, and `"SIGWINCH"` are supported. * * @category Runtime */ export function addSignalListener(signal: Signal, handler: () => void): void; /** Removes the given signal listener that has been registered with * {@linkcode Deno.addSignalListener}. * * ```ts * const listener = () => { * console.log("SIGTERM!") * }; * Deno.addSignalListener("SIGTERM", listener); * Deno.removeSignalListener("SIGTERM", listener); * ``` * * _Note_: On Windows only `"SIGINT"` (CTRL+C), `"SIGBREAK"` (CTRL+Break), * `"SIGTERM"`, `"SIGQUIT"`, `"SIGHUP"`, and `"SIGWINCH"` are supported. * * @category Runtime */ export function removeSignalListener( signal: Signal, handler: () => void, ): void; /** Create a child process. * * If any stdio options are not set to `"piped"`, accessing the corresponding * field on the `Command` or its `CommandOutput` will throw a `TypeError`. * * If `stdin` is set to `"piped"`, the `stdin` {@linkcode WritableStream} * needs to be closed manually. * * `Command` acts as a builder. Each call to {@linkcode Command.spawn} or * {@linkcode Command.output} will spawn a new subprocess. * * @example Spawn a subprocess and pipe the output to a file * * ```ts * const command = new Deno.Command(Deno.execPath(), { * args: [ * "eval", * "console.log('Hello World')", * ], * stdin: "piped", * stdout: "piped", * }); * const child = command.spawn(); * * // open a file and pipe the subprocess output to it. * child.stdout.pipeTo( * Deno.openSync("output", { write: true, create: true }).writable, * ); * * // manually close stdin * child.stdin.close(); * const status = await child.status; * ``` * * @example Spawn a subprocess and collect its output * * ```ts * const command = new Deno.Command(Deno.execPath(), { * args: [ * "eval", * "console.log('hello'); console.error('world')", * ], * }); * const { code, stdout, stderr } = await command.output(); * console.assert(code === 0); * console.assert("hello\n" === new TextDecoder().decode(stdout)); * console.assert("world\n" === new TextDecoder().decode(stderr)); * ``` * * @example Spawn a subprocess and collect its output synchronously * * ```ts * const command = new Deno.Command(Deno.execPath(), { * args: [ * "eval", * "console.log('hello'); console.error('world')", * ], * }); * const { code, stdout, stderr } = command.outputSync(); * console.assert(code === 0); * console.assert("hello\n" === new TextDecoder().decode(stdout)); * console.assert("world\n" === new TextDecoder().decode(stderr)); * ``` * * @tags allow-run * @category Subprocess */ export class Command { constructor(command: string | URL, options?: CommandOptions); /** * Executes the {@linkcode Deno.Command}, waiting for it to finish and * collecting all of its output. * * Will throw an error if `stdin: "piped"` is set. * * If options `stdout` or `stderr` are not set to `"piped"`, accessing the * corresponding field on {@linkcode Deno.CommandOutput} will throw a `TypeError`. */ output(): Promise; /** * Synchronously executes the {@linkcode Deno.Command}, waiting for it to * finish and collecting all of its output. * * Will throw an error if `stdin: "piped"` is set. * * If options `stdout` or `stderr` are not set to `"piped"`, accessing the * corresponding field on {@linkcode Deno.CommandOutput} will throw a `TypeError`. */ outputSync(): CommandOutput; /** * Spawns a streamable subprocess, allowing to use the other methods. */ spawn(): ChildProcess; } /** * The interface for handling a child process returned from * {@linkcode Deno.Command.spawn}. * * @category Subprocess */ export class ChildProcess implements AsyncDisposable { get stdin(): WritableStream>; get stdout(): SubprocessReadableStream; get stderr(): SubprocessReadableStream; readonly pid: number; /** Get the status of the child. */ readonly status: Promise; /** Waits for the child to exit completely, returning all its output and * status. */ output(): Promise; /** Kills the process with given {@linkcode Deno.Signal} or numeric signal. * * Defaults to `SIGTERM` if no signal is provided. * * @param [signo="SIGTERM"] */ kill(signo?: Signal | number): void; /** Ensure that the status of the child process prevents the Deno process * from exiting. */ ref(): void; /** Ensure that the status of the child process does not block the Deno * process from exiting. */ unref(): void; [Symbol.asyncDispose](): Promise; } /** * The interface for stdout and stderr streams for child process returned from * {@linkcode Deno.Command.spawn}. * * @category Subprocess */ export interface SubprocessReadableStream extends ReadableStream> { /** * Reads the stream to completion. It returns a promise that resolves with * an `ArrayBuffer`. */ arrayBuffer(): Promise; /** * Reads the stream to completion. It returns a promise that resolves with * a `Uint8Array`. */ bytes(): Promise>; /** * Reads the stream to completion. It returns a promise that resolves with * the result of parsing the body text as JSON. */ json(): Promise; /** * Reads the stream to completion. It returns a promise that resolves with * a `USVString` (text). */ text(): Promise; } /** * Options which can be set when calling {@linkcode Deno.Command}. * * @category Subprocess */ export interface CommandOptions { /** Arguments to pass to the process. */ args?: string[]; /** * The working directory of the process. * * If not specified, the `cwd` of the parent process is used. */ cwd?: string | URL; /** * Clear environmental variables from parent process. * * Doesn't guarantee that only `env` variables are present, as the OS may * set environmental variables for processes. * * @default {false} */ clearEnv?: boolean; /** Environmental variables to pass to the subprocess. */ env?: Record; /** * Sets the child process’s user ID. This translates to a setuid call in the * child process. Failure in the set uid call will cause the spawn to fail. */ uid?: number; /** Similar to `uid`, but sets the group ID of the child process. */ gid?: number; /** * An {@linkcode AbortSignal} that allows closing the process using the * corresponding {@linkcode AbortController} by sending the process a * SIGTERM signal. * * Not supported in {@linkcode Deno.Command.outputSync}. */ signal?: AbortSignal; /** How `stdin` of the spawned process should be handled. * * Defaults to `"inherit"` for `output` & `outputSync`, * and `"inherit"` for `spawn`. */ stdin?: "piped" | "inherit" | "null"; /** How `stdout` of the spawned process should be handled. * * Defaults to `"piped"` for `output` & `outputSync`, * and `"inherit"` for `spawn`. */ stdout?: "piped" | "inherit" | "null"; /** How `stderr` of the spawned process should be handled. * * Defaults to `"piped"` for `output` & `outputSync`, * and `"inherit"` for `spawn`. */ stderr?: "piped" | "inherit" | "null"; /** Skips quoting and escaping of the arguments on windows. This option * is ignored on non-windows platforms. * * @default {false} */ windowsRawArguments?: boolean; /** Whether to detach the spawned process from the current process. * This allows the spawned process to continue running after the current * process exits. * * Note: In order to allow the current process to exit, you need to ensure * you call `unref()` on the child process. * * In addition, the stdio streams – if inherited or piped – may keep the * current process from exiting until the streams are closed. * * @default {false} */ detached?: boolean; } /** * @category Subprocess */ export interface CommandStatus { /** If the child process exits with a 0 status code, `success` will be set * to `true`, otherwise `false`. */ success: boolean; /** The exit code of the child process. */ code: number; /** The signal associated with the child process. */ signal: Signal | null; } /** * The interface returned from calling {@linkcode Deno.Command.output} or * {@linkcode Deno.Command.outputSync} which represents the result of spawning the * child process. * * @category Subprocess */ export interface CommandOutput extends CommandStatus { /** The buffered output from the child process' `stdout`. */ readonly stdout: Uint8Array; /** The buffered output from the child process' `stderr`. */ readonly stderr: Uint8Array; } /** Spawns a new subprocess, returning a {@linkcode Deno.ChildProcess} handle. * * @experimental **UNSTABLE**: New API, yet to be vetted. * * This is a shorthand for `new Deno.Command(command, options).spawn()`. * * By default, `stdin`, `stdout`, and `stderr` are set to `"inherit"`. * * @example Spawn a subprocess * * ```ts * const child = Deno.spawn(Deno.execPath(), { * args: ["eval", "console.log('hello')"], * stdout: "piped", * }); * const output = await child.stdout.text(); * console.log(output); // "hello\n" * const status = await child.status; * ``` * * @tags allow-run * @category Subprocess */ export function spawn( command: string | URL, options?: CommandOptions, ): ChildProcess; /** Spawns a new subprocess with the given arguments, returning a * {@linkcode Deno.ChildProcess} handle. * * @experimental **UNSTABLE**: New API, yet to be vetted. * * This is a shorthand for `new Deno.Command(command, { ...options, args }).spawn()`. * * By default, `stdin`, `stdout`, and `stderr` are set to `"inherit"`. * * @example Spawn a subprocess with args * * ```ts * const child = Deno.spawn(Deno.execPath(), ["eval", "console.log('hello')"], { * stdout: "piped", * }); * const output = await child.stdout.text(); * console.log(output); // "hello\n" * const status = await child.status; * ``` * * @tags allow-run * @category Subprocess */ export function spawn( command: string | URL, args: string[], options?: Omit, ): ChildProcess; /** Spawns a subprocess, waits for it to finish, and returns the output. * * @experimental **UNSTABLE**: New API, yet to be vetted. * * This is a shorthand for `new Deno.Command(command, options).output()`. * * Will throw an error if `stdin: "piped"` is set. * * @example Spawn and wait for output * * ```ts * const { code, stdout, stderr } = await Deno.spawnAndWait(Deno.execPath(), { * args: ["eval", "console.log('hello')"], * }); * console.log(new TextDecoder().decode(stdout)); // "hello\n" * ``` * * @tags allow-run * @category Subprocess */ export function spawnAndWait( command: string | URL, options?: CommandOptions, ): Promise; /** Spawns a subprocess with the given arguments, waits for it to finish, * and returns the output. * * @experimental **UNSTABLE**: New API, yet to be vetted. * * This is a shorthand for `new Deno.Command(command, { ...options, args }).output()`. * * Will throw an error if `stdin: "piped"` is set. * * @example Spawn and wait with args * * ```ts * const { code, stdout } = await Deno.spawnAndWait( * Deno.execPath(), * ["eval", "console.log('hello')"], * ); * console.log(new TextDecoder().decode(stdout)); // "hello\n" * ``` * * @tags allow-run * @category Subprocess */ export function spawnAndWait( command: string | URL, args: string[], options?: Omit, ): Promise; /** Synchronously spawns a subprocess, waits for it to finish, and returns * the output. * * @experimental **UNSTABLE**: New API, yet to be vetted. * * This is a shorthand for `new Deno.Command(command, options).outputSync()`. * * Will throw an error if `stdin: "piped"` is set. * * @example Spawn and wait synchronously * * ```ts * const { code, stdout } = Deno.spawnAndWaitSync(Deno.execPath(), { * args: ["eval", "console.log('hello')"], * }); * console.log(new TextDecoder().decode(stdout)); // "hello\n" * ``` * * @tags allow-run * @category Subprocess */ export function spawnAndWaitSync( command: string | URL, options?: CommandOptions, ): CommandOutput; /** Synchronously spawns a subprocess with the given arguments, waits for it * to finish, and returns the output. * * @experimental **UNSTABLE**: New API, yet to be vetted. * * This is a shorthand for * `new Deno.Command(command, { ...options, args }).outputSync()`. * * Will throw an error if `stdin: "piped"` is set. * * @example Spawn and wait synchronously with args * * ```ts * const { code, stdout } = Deno.spawnAndWaitSync( * Deno.execPath(), * ["eval", "console.log('hello')"], * ); * console.log(new TextDecoder().decode(stdout)); // "hello\n" * ``` * * @tags allow-run * @category Subprocess */ export function spawnAndWaitSync( command: string | URL, args: string[], options?: Omit, ): CommandOutput; /** Option which can be specified when performing {@linkcode Deno.inspect}. * * @category I/O */ export interface InspectOptions { /** Stylize output with ANSI colors. * * @default {false} */ colors?: boolean; /** Try to fit more than one entry of a collection on the same line. * * @default {true} */ compact?: boolean; /** Traversal depth for nested objects. * * @default {4} */ depth?: number; /** The maximum length for an inspection to take up a single line. * * @default {80} */ breakLength?: number; /** Whether or not to escape sequences. * * @default {true} */ escapeSequences?: boolean; /** The maximum number of iterable entries to print. * * @default {100} */ iterableLimit?: number; /** Show a Proxy's target and handler. * * @default {false} */ showProxy?: boolean; /** Sort Object, Set and Map entries by key. * * @default {false} */ sorted?: boolean; /** Add a trailing comma for multiline collections. * * @default {false} */ trailingComma?: boolean; /** Evaluate the result of calling getters. * * @default {false} */ getters?: boolean; /** Show an object's non-enumerable properties. * * @default {false} */ showHidden?: boolean; /** The maximum length of a string before it is truncated with an * ellipsis. */ strAbbreviateSize?: number; } /** Converts the input into a string that has the same format as printed by * `console.log()`. * * ```ts * const obj = { * a: 10, * b: "hello", * }; * const objAsString = Deno.inspect(obj); // { a: 10, b: "hello" } * console.log(obj); // prints same value as objAsString, e.g. { a: 10, b: "hello" } * ``` * * A custom inspect functions can be registered on objects, via the symbol * `Symbol.for("Deno.customInspect")`, to control and customize the output * of `inspect()` or when using `console` logging: * * ```ts * class A { * x = 10; * y = "hello"; * [Symbol.for("Deno.customInspect")]() { * return `x=${this.x}, y=${this.y}`; * } * } * * const inStringFormat = Deno.inspect(new A()); // "x=10, y=hello" * console.log(inStringFormat); // prints "x=10, y=hello" * ``` * * A depth can be specified by using the `depth` option: * * ```ts * Deno.inspect({a: {b: {c: {d: 'hello'}}}}, {depth: 2}); // { a: { b: [Object] } } * ``` * * @category I/O */ export function inspect(value: unknown, options?: InspectOptions): string; /** The name of a privileged feature which needs permission. * * @category Permissions */ export type PermissionName = | "run" | "read" | "write" | "net" | "env" | "sys" | "ffi"; /** The current status of the permission: * * - `"granted"` - the permission has been granted. * - `"denied"` - the permission has been explicitly denied. * - `"prompt"` - the permission has not explicitly granted nor denied. * * @category Permissions */ export type PermissionState = "granted" | "denied" | "prompt"; /** The permission descriptor for the `allow-run` and `deny-run` permissions, which controls * access to what sub-processes can be executed by Deno. The option `command` * allows scoping the permission to a specific executable. * * **Warning, in practice, `allow-run` is effectively the same as `allow-all` * in the sense that malicious code could execute any arbitrary code on the * host.** * * @category Permissions */ export interface RunPermissionDescriptor { name: "run"; /** An `allow-run` or `deny-run` permission can be scoped to a specific executable, * which would be relative to the start-up CWD of the Deno CLI. */ command?: string | URL; } /** The permission descriptor for the `allow-read` and `deny-read` permissions, which controls * access to reading resources from the local host. The option `path` allows * scoping the permission to a specific path (and if the path is a directory * any sub paths). * * Permission granted under `allow-read` only allows runtime code to attempt * to read, the underlying operating system may apply additional permissions. * * @category Permissions */ export interface ReadPermissionDescriptor { name: "read"; /** An `allow-read` or `deny-read` permission can be scoped to a specific path (and if * the path is a directory, any sub paths). */ path?: string | URL; } /** The permission descriptor for the `allow-write` and `deny-write` permissions, which * controls access to writing to resources from the local host. The option * `path` allow scoping the permission to a specific path (and if the path is * a directory any sub paths). * * Permission granted under `allow-write` only allows runtime code to attempt * to write, the underlying operating system may apply additional permissions. * * @category Permissions */ export interface WritePermissionDescriptor { name: "write"; /** An `allow-write` or `deny-write` permission can be scoped to a specific path (and if * the path is a directory, any sub paths). */ path?: string | URL; } /** The permission descriptor for the `allow-net` and `deny-net` permissions, which controls * access to opening network ports and connecting to remote hosts via the * network. The option `host` allows scoping the permission for outbound * connection to a specific host and port. * * @category Permissions */ export interface NetPermissionDescriptor { name: "net"; /** Optional host string of the form `"[:]"`. Examples: * * "github.com" * "deno.land:8080" */ host?: string; } /** The permission descriptor for the `allow-env` and `deny-env` permissions, which controls * access to being able to read and write to the process environment variables * as well as access other information about the environment. The option * `variable` allows scoping the permission to a specific environment * variable. * * @category Permissions */ export interface EnvPermissionDescriptor { name: "env"; /** Optional environment variable name (e.g. `PATH`). */ variable?: string; } /** The permission descriptor for the `allow-sys` and `deny-sys` permissions, which controls * access to sensitive host system information, which malicious code might * attempt to exploit. The option `kind` allows scoping the permission to a * specific piece of information. * * @category Permissions */ export interface SysPermissionDescriptor { name: "sys"; /** The specific information to scope the permission to. */ kind?: | "loadavg" | "hostname" | "systemMemoryInfo" | "networkInterfaces" | "osRelease" | "osUptime" | "uid" | "gid" | "username" | "cpus" | "homedir" | "statfs" | "getPriority" | "setPriority"; } /** The permission descriptor for the `allow-ffi` and `deny-ffi` permissions, which controls * access to loading _foreign_ code and interfacing with it via the * [Foreign Function Interface API](https://docs.deno.com/runtime/manual/runtime/ffi_api) * available in Deno. The option `path` allows scoping the permission to a * specific path on the host. * * @category Permissions */ export interface FfiPermissionDescriptor { name: "ffi"; /** Optional path on the local host to scope the permission to. */ path?: string | URL; } /** The permission descriptor for the `allow-import` and `deny-import` permissions, which controls * access to importing from remote hosts via the network. The option `host` allows scoping the * permission for outbound connection to a specific host and port. * * @category Permissions */ export interface ImportPermissionDescriptor { name: "import"; /** Optional host string of the form `"[:]"`. Examples: * * "github.com" * "deno.land:8080" */ host?: string; } /** Permission descriptors which define a permission and can be queried, * requested, or revoked. * * View the specifics of the individual descriptors for more information about * each permission kind. * * @category Permissions */ export type PermissionDescriptor = | RunPermissionDescriptor | ReadPermissionDescriptor | WritePermissionDescriptor | NetPermissionDescriptor | EnvPermissionDescriptor | SysPermissionDescriptor | FfiPermissionDescriptor | ImportPermissionDescriptor; /** The interface which defines what event types are supported by * {@linkcode PermissionStatus} instances. * * @category Permissions */ export interface PermissionStatusEventMap { change: Event; } /** An {@linkcode EventTarget} returned from the {@linkcode Deno.permissions} * API which can provide updates to any state changes of the permission. * * @category Permissions */ export class PermissionStatus extends EventTarget { // deno-lint-ignore no-explicit-any onchange: ((this: PermissionStatus, ev: Event) => any) | null; readonly state: PermissionState; /** * Describes if permission is only granted partially, eg. an access * might be granted to "/foo" directory, but denied for "/foo/bar". * In such case this field will be set to `true` when querying for * read permissions of "/foo" directory. */ readonly partial: boolean; addEventListener( type: K, listener: ( this: PermissionStatus, ev: PermissionStatusEventMap[K], ) => any, options?: boolean | AddEventListenerOptions, ): void; addEventListener( type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions, ): void; removeEventListener( type: K, listener: ( this: PermissionStatus, ev: PermissionStatusEventMap[K], ) => any, options?: boolean | EventListenerOptions, ): void; removeEventListener( type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions, ): void; } /** * Deno's permission management API. * * The class which provides the interface for the {@linkcode Deno.permissions} * global instance and is based on the web platform * [Permissions API](https://developer.mozilla.org/en-US/docs/Web/API/Permissions_API), * though some proposed parts of the API which are useful in a server side * runtime context were removed or abandoned in the web platform specification * which is why it was chosen to locate it in the {@linkcode Deno} namespace * instead. * * By default, if the `stdin`/`stdout` is TTY for the Deno CLI (meaning it can * send and receive text), then the CLI will prompt the user to grant * permission when an un-granted permission is requested. This behavior can * be changed by using the `--no-prompt` command at startup. When prompting * the CLI will request the narrowest permission possible, potentially making * it annoying to the user. The permissions APIs allow the code author to * request a wider set of permissions at one time in order to provide a better * user experience. * * @category Permissions */ export class Permissions { /** Resolves to the current status of a permission. * * Note, if the permission is already granted, `request()` will not prompt * the user again, therefore `query()` is only necessary if you are going * to react differently existing permissions without wanting to modify them * or prompt the user to modify them. * * ```ts * const status = await Deno.permissions.query({ name: "read", path: "/etc" }); * console.log(status.state); * ``` */ query(desc: PermissionDescriptor): Promise; /** Returns the current status of a permission. * * Note, if the permission is already granted, `request()` will not prompt * the user again, therefore `querySync()` is only necessary if you are going * to react differently existing permissions without wanting to modify them * or prompt the user to modify them. * * ```ts * const status = Deno.permissions.querySync({ name: "read", path: "/etc" }); * console.log(status.state); * ``` */ querySync(desc: PermissionDescriptor): PermissionStatus; /** Revokes a permission, and resolves to the state of the permission. * * ```ts * import { assert } from "jsr:@std/assert"; * * const status = await Deno.permissions.revoke({ name: "run" }); * assert(status.state !== "granted") * ``` */ revoke(desc: PermissionDescriptor): Promise; /** Revokes a permission, and returns the state of the permission. * * ```ts * import { assert } from "jsr:@std/assert"; * * const status = Deno.permissions.revokeSync({ name: "run" }); * assert(status.state !== "granted") * ``` */ revokeSync(desc: PermissionDescriptor): PermissionStatus; /** Requests the permission, and resolves to the state of the permission. * * If the permission is already granted, the user will not be prompted to * grant the permission again. * * ```ts * const status = await Deno.permissions.request({ name: "env" }); * if (status.state === "granted") { * console.log("'env' permission is granted."); * } else { * console.log("'env' permission is denied."); * } * ``` */ request(desc: PermissionDescriptor): Promise; /** Requests the permission, and returns the state of the permission. * * If the permission is already granted, the user will not be prompted to * grant the permission again. * * ```ts * const status = Deno.permissions.requestSync({ name: "env" }); * if (status.state === "granted") { * console.log("'env' permission is granted."); * } else { * console.log("'env' permission is denied."); * } * ``` */ requestSync(desc: PermissionDescriptor): PermissionStatus; } /** Deno's permission management API. * * It is a singleton instance of the {@linkcode Permissions} object and is * based on the web platform * [Permissions API](https://developer.mozilla.org/en-US/docs/Web/API/Permissions_API), * though some proposed parts of the API which are useful in a server side * runtime context were removed or abandoned in the web platform specification * which is why it was chosen to locate it in the {@linkcode Deno} namespace * instead. * * By default, if the `stdin`/`stdout` is TTY for the Deno CLI (meaning it can * send and receive text), then the CLI will prompt the user to grant * permission when an un-granted permission is requested. This behavior can * be changed by using the `--no-prompt` command at startup. When prompting * the CLI will request the narrowest permission possible, potentially making * it annoying to the user. The permissions APIs allow the code author to * request a wider set of permissions at one time in order to provide a better * user experience. * * Requesting already granted permissions will not prompt the user and will * return that the permission was granted. * * ### Querying * * ```ts * const status = await Deno.permissions.query({ name: "read", path: "/etc" }); * console.log(status.state); * ``` * * ```ts * const status = Deno.permissions.querySync({ name: "read", path: "/etc" }); * console.log(status.state); * ``` * * ### Revoking * * ```ts * import { assert } from "jsr:@std/assert"; * * const status = await Deno.permissions.revoke({ name: "run" }); * assert(status.state !== "granted") * ``` * * ```ts * import { assert } from "jsr:@std/assert"; * * const status = Deno.permissions.revokeSync({ name: "run" }); * assert(status.state !== "granted") * ``` * * ### Requesting * * ```ts * const status = await Deno.permissions.request({ name: "env" }); * if (status.state === "granted") { * console.log("'env' permission is granted."); * } else { * console.log("'env' permission is denied."); * } * ``` * * ```ts * const status = Deno.permissions.requestSync({ name: "env" }); * if (status.state === "granted") { * console.log("'env' permission is granted."); * } else { * console.log("'env' permission is denied."); * } * ``` * * @category Permissions */ export const permissions: Permissions; /** Information related to the build of the current Deno runtime. * * Users are discouraged from code branching based on this information, as * assumptions about what is available in what build environment might change * over time. Developers should specifically sniff out the features they * intend to use. * * The intended use for the information is for logging and debugging purposes. * * @category Runtime */ export const build: { /** The [LLVM](https://llvm.org/) target triple, which is the combination * of `${arch}-${vendor}-${os}` and represent the specific build target that * the current runtime was built for. */ target: string; /** Instruction set architecture that the Deno CLI was built for. */ arch: "x86_64" | "aarch64"; /** The operating system that the Deno CLI was built for. `"darwin"` is * also known as OSX or MacOS. */ os: | "darwin" | "linux" | "android" | "windows" | "freebsd" | "netbsd" | "aix" | "solaris" | "illumos"; standalone: boolean; /** The computer vendor that the Deno CLI was built for. */ vendor: string; /** Optional environment flags that were set for this build of Deno CLI. */ env?: string; }; /** Version information related to the current Deno CLI runtime environment. * * Users are discouraged from code branching based on this information, as * assumptions about what is available in what build environment might change * over time. Developers should specifically sniff out the features they * intend to use. * * The intended use for the information is for logging and debugging purposes. * * @category Runtime */ export const version: { /** Deno CLI's version. For example: `"1.26.0"`. */ deno: string; /** The V8 version used by Deno. For example: `"10.7.100.0"`. * * V8 is the underlying JavaScript runtime platform that Deno is built on * top of. */ v8: string; /** The TypeScript version used by Deno. For example: `"4.8.3"`. * * A version of the TypeScript type checker and language server is built-in * to the Deno CLI. */ typescript: string; }; /** Returns the script arguments to the program. * * Give the following command line invocation of Deno: * * ```sh * deno eval "console.log(Deno.args)" Sushi Maguro Hamachi * ``` * * Then `Deno.args` will contain: * * ```ts * [ "Sushi", "Maguro", "Hamachi" ] * ``` * * If you are looking for a structured way to parse arguments, there is * [`parseArgs()`](https://jsr.io/@std/cli/doc/parse-args/~/parseArgs) from * the Deno Standard Library. * * @category Runtime */ export const args: string[]; /** The URL of the entrypoint module entered from the command-line. It * requires read permission to the CWD. * * Also see {@linkcode ImportMeta} for other related information. * * @tags allow-read * @category Runtime */ export const mainModule: string; /** Options that can be used with {@linkcode symlink} and * {@linkcode symlinkSync}. * * @category File System */ export interface SymlinkOptions { /** Specify the symbolic link type as file, directory or NTFS junction. This * option only applies to Windows and is ignored on other operating systems. */ type: "file" | "dir" | "junction"; } /** * Creates `newpath` as a symbolic link to `oldpath`. * * The `options.type` parameter can be set to `"file"`, `"dir"` or `"junction"`. * This argument is only available on Windows and ignored on other platforms. * * ```ts * await Deno.symlink("old/name", "new/name"); * ``` * * Requires full `allow-read` and `allow-write` permissions. * * @tags allow-read, allow-write * @category File System */ export function symlink( oldpath: string | URL, newpath: string | URL, options?: SymlinkOptions, ): Promise; /** * Creates `newpath` as a symbolic link to `oldpath`. * * The `options.type` parameter can be set to `"file"`, `"dir"` or `"junction"`. * This argument is only available on Windows and ignored on other platforms. * * ```ts * Deno.symlinkSync("old/name", "new/name"); * ``` * * Requires full `allow-read` and `allow-write` permissions. * * @tags allow-read, allow-write * @category File System */ export function symlinkSync( oldpath: string | URL, newpath: string | URL, options?: SymlinkOptions, ): void; /** * Synchronously changes the access (`atime`) and modification (`mtime`) times * of a file system object referenced by `path`. Given times are either in * seconds (UNIX epoch time) or as `Date` objects. * * ```ts * Deno.utimeSync("myfile.txt", 1556495550, new Date()); * ``` * * Requires `allow-write` permission. * * @tags allow-write * @category File System */ export function utimeSync( path: string | URL, atime: number | Date, mtime: number | Date, ): void; /** * Changes the access (`atime`) and modification (`mtime`) times of a file * system object referenced by `path`. Given times are either in seconds * (UNIX epoch time) or as `Date` objects. * * ```ts * await Deno.utime("myfile.txt", 1556495550, new Date()); * ``` * * Requires `allow-write` permission. * * @tags allow-write * @category File System */ export function utime( path: string | URL, atime: number | Date, mtime: number | Date, ): Promise; /** Retrieve the process umask. If `mask` is provided, sets the process umask. * This call always returns what the umask was before the call. * * ```ts * console.log(Deno.umask()); // e.g. 18 (0o022) * const prevUmaskValue = Deno.umask(0o077); // e.g. 18 (0o022) * console.log(Deno.umask()); // e.g. 63 (0o077) * ``` * * This API is under consideration to determine if permissions are required to * call it. * * *Note*: This API is not implemented on Windows * * @category File System */ export function umask(mask?: number): number; /** The object that is returned from a {@linkcode Deno.upgradeWebSocket} * request. * * @category WebSockets */ export interface WebSocketUpgrade { /** The response object that represents the HTTP response to the client, * which should be used to the {@linkcode RequestEvent} `.respondWith()` for * the upgrade to be successful. */ response: Response; /** The {@linkcode WebSocket} interface to communicate to the client via a * web socket. */ socket: WebSocket; } /** Options which can be set when performing a * {@linkcode Deno.upgradeWebSocket} upgrade of a {@linkcode Request} * * @category WebSockets */ export interface UpgradeWebSocketOptions { /** Sets the `.protocol` property on the client side web socket to the * value provided here, which should be one of the strings specified in the * `protocols` parameter when requesting the web socket. This is intended * for clients and servers to specify sub-protocols to use to communicate to * each other. */ protocol?: string; /** If the client does not respond to this frame with a * `pong` within the timeout specified, the connection is deemed * unhealthy and is closed. The `close` and `error` event will be emitted. * * The unit is seconds, with a default of 30. * Set to `0` to disable timeouts. */ idleTimeout?: number; } /** * Upgrade an incoming HTTP request to a WebSocket. * * Given a {@linkcode Request}, returns a pair of {@linkcode WebSocket} and * {@linkcode Response} instances. The original request must be responded to * with the returned response for the websocket upgrade to be successful. * * ```ts * Deno.serve((req) => { * if (req.headers.get("upgrade") !== "websocket") { * return new Response(null, { status: 501 }); * } * const { socket, response } = Deno.upgradeWebSocket(req); * socket.addEventListener("open", () => { * console.log("a client connected!"); * }); * socket.addEventListener("message", (event) => { * if (event.data === "ping") { * socket.send("pong"); * } * }); * return response; * }); * ``` * * If the request body is disturbed (read from) before the upgrade is * completed, upgrading fails. * * This operation does not yet consume the request or open the websocket. This * only happens once the returned response has been passed to `respondWith()`. * * @category WebSockets */ export function upgradeWebSocket( request: Request, options?: UpgradeWebSocketOptions, ): WebSocketUpgrade; /** Send a signal to process under given `pid`. The value and meaning of the * `signal` to the process is operating system and process dependant. * {@linkcode Signal} provides the most common signals. Default signal * is `"SIGTERM"`. * * The term `kill` is adopted from the UNIX-like command line command `kill` * which also signals processes. * * If `pid` is negative, the signal will be sent to the process group * identified by `pid`. An error will be thrown if a negative `pid` is used on * Windows. * * ```ts * const command = new Deno.Command("sleep", { args: ["10000"] }); * const child = command.spawn(); * * Deno.kill(child.pid, "SIGINT"); * ``` * * As a special case, a signal of 0 can be used to test for the existence of a process. * * Requires `allow-run` permission. * * @tags allow-run * @category Subprocess */ export function kill(pid: number, signo?: Signal | number): void; /** The type of the resource record to resolve via DNS using * {@linkcode Deno.resolveDns}. * * Only the listed types are supported currently. * * @category Network */ export type RecordType = | "A" | "AAAA" | "ANAME" | "CAA" | "CNAME" | "MX" | "NAPTR" | "NS" | "PTR" | "SOA" | "SRV" | "TXT"; /** * Options which can be set when using {@linkcode Deno.resolveDns}. * * @category Network */ export interface ResolveDnsOptions { /** The name server to be used for lookups. * * If not specified, defaults to the system configuration. For example * `/etc/resolv.conf` on Unix-like systems. */ nameServer?: { /** The IP address of the name server. */ ipAddr: string; /** The port number the query will be sent to. * * @default {53} */ port?: number; }; /** * An abort signal to allow cancellation of the DNS resolution operation. * If the signal becomes aborted the resolveDns operation will be stopped * and the promise returned will be rejected with an AbortError. */ signal?: AbortSignal; } /** If {@linkcode Deno.resolveDns} is called with `"CAA"` record type * specified, it will resolve with an array of objects with this interface. * * @category Network */ export interface CaaRecord { /** If `true`, indicates that the corresponding property tag **must** be * understood if the semantics of the CAA record are to be correctly * interpreted by an issuer. * * Issuers **must not** issue certificates for a domain if the relevant CAA * Resource Record set contains unknown property tags that have `critical` * set. */ critical: boolean; /** An string that represents the identifier of the property represented by * the record. */ tag: string; /** The value associated with the tag. */ value: string; } /** If {@linkcode Deno.resolveDns} is called with `"MX"` record type * specified, it will return an array of objects with this interface. * * @category Network */ export interface MxRecord { /** A priority value, which is a relative value compared to the other * preferences of MX records for the domain. */ preference: number; /** The server that mail should be delivered to. */ exchange: string; } /** If {@linkcode Deno.resolveDns} is called with `"NAPTR"` record type * specified, it will return an array of objects with this interface. * * @category Network */ export interface NaptrRecord { order: number; preference: number; flags: string; services: string; regexp: string; replacement: string; } /** If {@linkcode Deno.resolveDns} is called with `"SOA"` record type * specified, it will return an array of objects with this interface. * * @category Network */ export interface SoaRecord { mname: string; rname: string; serial: number; refresh: number; retry: number; expire: number; minimum: number; } /** If {@linkcode Deno.resolveDns} is called with `"SRV"` record type * specified, it will return an array of objects with this interface. * * @category Network */ export interface SrvRecord { priority: number; weight: number; port: number; target: string; } /** * Performs DNS resolution against the given query, returning resolved * records. * * Fails in the cases such as: * * - the query is in invalid format. * - the options have an invalid parameter. For example `nameServer.port` is * beyond the range of 16-bit unsigned integer. * - the request timed out. * * ```ts * const a = await Deno.resolveDns("example.com", "A"); * * const aaaa = await Deno.resolveDns("example.com", "AAAA", { * nameServer: { ipAddr: "8.8.8.8", port: 53 }, * }); * ``` * * Requires `allow-net` permission. * * @tags allow-net * @category Network */ export function resolveDns( query: string, recordType: "A" | "AAAA" | "ANAME" | "CNAME" | "NS" | "PTR", options?: ResolveDnsOptions, ): Promise; /** * Performs DNS resolution against the given query, returning resolved * records. * * Fails in the cases such as: * * - the query is in invalid format. * - the options have an invalid parameter. For example `nameServer.port` is * beyond the range of 16-bit unsigned integer. * - the request timed out. * * ```ts * const a = await Deno.resolveDns("example.com", "A"); * * const aaaa = await Deno.resolveDns("example.com", "AAAA", { * nameServer: { ipAddr: "8.8.8.8", port: 53 }, * }); * ``` * * Requires `allow-net` permission. * * @tags allow-net * @category Network */ export function resolveDns( query: string, recordType: "CAA", options?: ResolveDnsOptions, ): Promise; /** * Performs DNS resolution against the given query, returning resolved * records. * * Fails in the cases such as: * * - the query is in invalid format. * - the options have an invalid parameter. For example `nameServer.port` is * beyond the range of 16-bit unsigned integer. * - the request timed out. * * ```ts * const a = await Deno.resolveDns("example.com", "A"); * * const aaaa = await Deno.resolveDns("example.com", "AAAA", { * nameServer: { ipAddr: "8.8.8.8", port: 53 }, * }); * ``` * * Requires `allow-net` permission. * * @tags allow-net * @category Network */ export function resolveDns( query: string, recordType: "MX", options?: ResolveDnsOptions, ): Promise; /** * Performs DNS resolution against the given query, returning resolved * records. * * Fails in the cases such as: * * - the query is in invalid format. * - the options have an invalid parameter. For example `nameServer.port` is * beyond the range of 16-bit unsigned integer. * - the request timed out. * * ```ts * const a = await Deno.resolveDns("example.com", "A"); * * const aaaa = await Deno.resolveDns("example.com", "AAAA", { * nameServer: { ipAddr: "8.8.8.8", port: 53 }, * }); * ``` * * Requires `allow-net` permission. * * @tags allow-net * @category Network */ export function resolveDns( query: string, recordType: "NAPTR", options?: ResolveDnsOptions, ): Promise; /** * Performs DNS resolution against the given query, returning resolved * records. * * Fails in the cases such as: * * - the query is in invalid format. * - the options have an invalid parameter. For example `nameServer.port` is * beyond the range of 16-bit unsigned integer. * - the request timed out. * * ```ts * const a = await Deno.resolveDns("example.com", "A"); * * const aaaa = await Deno.resolveDns("example.com", "AAAA", { * nameServer: { ipAddr: "8.8.8.8", port: 53 }, * }); * ``` * * Requires `allow-net` permission. * * @tags allow-net * @category Network */ export function resolveDns( query: string, recordType: "SOA", options?: ResolveDnsOptions, ): Promise; /** * Performs DNS resolution against the given query, returning resolved * records. * * Fails in the cases such as: * * - the query is in invalid format. * - the options have an invalid parameter. For example `nameServer.port` is * beyond the range of 16-bit unsigned integer. * - the request timed out. * * ```ts * const a = await Deno.resolveDns("example.com", "A"); * * const aaaa = await Deno.resolveDns("example.com", "AAAA", { * nameServer: { ipAddr: "8.8.8.8", port: 53 }, * }); * ``` * * Requires `allow-net` permission. * * @tags allow-net * @category Network */ export function resolveDns( query: string, recordType: "SRV", options?: ResolveDnsOptions, ): Promise; /** * Performs DNS resolution against the given query, returning resolved * records. * * Fails in the cases such as: * * - the query is in invalid format. * - the options have an invalid parameter. For example `nameServer.port` is * beyond the range of 16-bit unsigned integer. * - the request timed out. * * ```ts * const a = await Deno.resolveDns("example.com", "A"); * * const aaaa = await Deno.resolveDns("example.com", "AAAA", { * nameServer: { ipAddr: "8.8.8.8", port: 53 }, * }); * ``` * * Requires `allow-net` permission. * * @tags allow-net * @category Network */ export function resolveDns( query: string, recordType: "TXT", options?: ResolveDnsOptions, ): Promise; /** * Performs DNS resolution against the given query, returning resolved * records. * * Fails in the cases such as: * * - the query is in invalid format. * - the options have an invalid parameter. For example `nameServer.port` is * beyond the range of 16-bit unsigned integer. * - the request timed out. * * ```ts * const a = await Deno.resolveDns("example.com", "A"); * * const aaaa = await Deno.resolveDns("example.com", "AAAA", { * nameServer: { ipAddr: "8.8.8.8", port: 53 }, * }); * ``` * * Requires `allow-net` permission. * * @tags allow-net * @category Network */ export function resolveDns( query: string, recordType: RecordType, options?: ResolveDnsOptions, ): Promise< | string[] | CaaRecord[] | MxRecord[] | NaptrRecord[] | SoaRecord[] | SrvRecord[] | string[][] >; /** * Make the timer of the given `id` block the event loop from finishing. * * @category Runtime */ export function refTimer(id: number): void; /** * Make the timer of the given `id` not block the event loop from finishing. * * @category Runtime */ export function unrefTimer(id: number): void; /** * Returns the user id of the process on POSIX platforms. Returns null on Windows. * * ```ts * console.log(Deno.uid()); * ``` * * Requires `allow-sys` permission. * * @tags allow-sys * @category Runtime */ export function uid(): number | null; /** * Returns the group id of the process on POSIX platforms. Returns null on windows. * * ```ts * console.log(Deno.gid()); * ``` * * Requires `allow-sys` permission. * * @tags allow-sys * @category Runtime */ export function gid(): number | null; /** Additional information for an HTTP request and its connection. * * @category HTTP Server */ export interface ServeHandlerInfo { /** The remote address of the connection. */ remoteAddr: Addr; /** The completion promise */ completed: Promise; } /** A handler for HTTP requests. Consumes a request and returns a response. * * If a handler throws, the server calling the handler will assume the impact * of the error is isolated to the individual request. It will catch the error * and if necessary will close the underlying connection. * * @category HTTP Server */ export type ServeHandler = ( request: Request, info: ServeHandlerInfo, ) => Response | Promise; /** Interface that module run with `deno serve` subcommand must conform to. * * To ensure your code is type-checked properly, make sure to add `satisfies Deno.ServeDefaultExport` * to the `export default { ... }` like so: * * ```ts * export default { * fetch(req) { * return new Response("Hello world"); * } * } satisfies Deno.ServeDefaultExport; * ``` * * @category HTTP Server */ export interface ServeDefaultExport { /** A handler for HTTP requests. Consumes a request and returns a response. * * If a handler throws, the server calling the handler will assume the impact * of the error is isolated to the individual request. It will catch the error * and if necessary will close the underlying connection. * * @category HTTP Server */ fetch: ServeHandler; /** * The callback which is called when the server starts listening. * * @category HTTP Server */ onListen?: (localAddr: Deno.Addr) => void; } /** Options which can be set when calling {@linkcode Deno.serve}. * * @category HTTP Server */ export interface ServeOptions { /** An {@linkcode AbortSignal} to close the server and all connections. */ signal?: AbortSignal; /** The handler to invoke when route handlers throw an error. */ onError?: (error: unknown) => Response | Promise; /** The callback which is called when the server starts listening. */ onListen?: (localAddr: Addr) => void; } /** * Options that can be passed to `Deno.serve` to create a server listening on * a TCP port. * * @category HTTP Server */ export interface ServeTcpOptions extends ServeOptions { /** The transport to use. */ transport?: "tcp"; /** The port to listen on. * * Set to `0` to listen on any available port. * * @default {8000} */ port?: number; /** A literal IP address or host name that can be resolved to an IP address. * * __Note about `0.0.0.0`__ While listening `0.0.0.0` works on all platforms, * the browsers on Windows don't work with the address `0.0.0.0`. * You should show the message like `server running on localhost:8080` instead of * `server running on 0.0.0.0:8080` if your program supports Windows. * * @default {"0.0.0.0"} */ hostname?: string; /** Sets `SO_REUSEPORT` on POSIX systems. */ reusePort?: boolean; /** Maximum number of pending connections in the listen queue. * * This parameter controls how many incoming connections can be queued by the * operating system while waiting for the application to accept them. If more * connections arrive when the queue is full, they will be refused. * * The kernel may adjust this value (e.g., rounding up to the next power of 2 * plus 1). Different operating systems have different maximum limits. * * @default {511} */ tcpBacklog?: number; } /** * Options that can be passed to `Deno.serve` to create a server listening on * a Unix domain socket. * * @category HTTP Server */ export interface ServeUnixOptions extends ServeOptions { /** The transport to use. */ transport?: "unix"; /** The unix domain socket path to listen on. */ path: string; } /** * Options that can be passed to `Deno.serve` to create a server listening on * a VSOCK socket. * * @experimental **UNSTABLE**: New API, yet to be vetted. * * @category HTTP Server */ export interface ServeVsockOptions extends ServeOptions { /** The transport to use. */ transport?: "vsock"; /** The context identifier to use. */ cid: number; /** The port to use. */ port: number; } /** * @category HTTP Server */ export interface ServeInit { /** The handler to invoke to process each incoming request. */ handler: ServeHandler; } /** An instance of the server created using `Deno.serve()` API. * * @category HTTP Server */ export interface HttpServer extends AsyncDisposable { /** A promise that resolves once server finishes - eg. when aborted using * the signal passed to {@linkcode ServeOptions.signal}. */ finished: Promise; /** The local address this server is listening on. */ addr: Addr; /** * Make the server block the event loop from finishing. * * Note: the server blocks the event loop from finishing by default. * This method is only meaningful after `.unref()` is called. */ ref(): void; /** Make the server not block the event loop from finishing. */ unref(): void; /** Gracefully close the server. No more new connections will be accepted, * while pending requests will be allowed to finish. */ shutdown(): Promise; } /** Serves HTTP requests with the given handler. * * The below example serves with the port `8000` on hostname `"127.0.0.1"`. * * ```ts * Deno.serve((_req) => new Response("Hello, world")); * ``` * * @category HTTP Server */ export function serve( handler: ServeHandler, ): HttpServer; /** Serves HTTP requests with the given option bag and handler. * * You can specify the socket path with `path` option. * * ```ts * Deno.serve( * { path: "path/to/socket" }, * (_req) => new Response("Hello, world") * ); * ``` * * You can stop the server with an {@linkcode AbortSignal}. The abort signal * needs to be passed as the `signal` option in the options bag. The server * aborts when the abort signal is aborted. To wait for the server to close, * await the promise returned from the `Deno.serve` API. * * ```ts * const ac = new AbortController(); * * const server = Deno.serve( * { signal: ac.signal, path: "path/to/socket" }, * (_req) => new Response("Hello, world") * ); * server.finished.then(() => console.log("Server closed")); * * console.log("Closing server..."); * ac.abort(); * ``` * * By default `Deno.serve` prints the message * `Listening on path/to/socket` on listening. If you like to * change this behavior, you can specify a custom `onListen` callback. * * ```ts * Deno.serve({ * onListen({ path }) { * console.log(`Server started at ${path}`); * // ... more info specific to your server .. * }, * path: "path/to/socket", * }, (_req) => new Response("Hello, world")); * ``` * * @category HTTP Server */ export function serve( options: ServeUnixOptions, handler: ServeHandler, ): HttpServer; /** Serves HTTP requests with the given option bag and handler. * * @experimental **UNSTABLE**: New API, yet to be vetted. * * You can specify an object with the cid and port options for the VSOCK interface. * * The VSOCK address family facilitates communication between virtual machines and the host they are running on: https://man7.org/linux/man-pages/man7/vsock.7.html * * ```ts * Deno.serve( * { cid: -1, port: 3000 }, * (_req) => new Response("Hello, world") * ); * ``` * * You can stop the server with an {@linkcode AbortSignal}. The abort signal * needs to be passed as the `signal` option in the options bag. The server * aborts when the abort signal is aborted. To wait for the server to close, * await the promise returned from the `Deno.serve` API. * * ```ts * const ac = new AbortController(); * * const server = Deno.serve( * { signal: ac.signal, cid: -1, port: 3000 }, * (_req) => new Response("Hello, world") * ); * server.finished.then(() => console.log("Server closed")); * * console.log("Closing server..."); * ac.abort(); * ``` * * By default `Deno.serve` prints the message `Listening on cid:port`. * If you want to change this behavior, you can specify a custom `onListen` * callback. * * ```ts * Deno.serve({ * onListen({ cid, port }) { * console.log(`Server started at ${cid}:${port}`); * // ... more info specific to your server .. * }, * cid: -1, * port: 3000, * }, (_req) => new Response("Hello, world")); * ``` * * @category HTTP Server */ export function serve( options: ServeVsockOptions, handler: ServeHandler, ): HttpServer; /** Serves HTTP requests with the given option bag and handler. * * You can specify an object with a port and hostname option, which is the * address to listen on. The default is port `8000` on hostname `"0.0.0.0"`. * * You can change the address to listen on using the `hostname` and `port` * options. The below example serves on port `3000` and hostname `"127.0.0.1"`. * * ```ts * Deno.serve( * { port: 3000, hostname: "127.0.0.1" }, * (_req) => new Response("Hello, world") * ); * ``` * * You can stop the server with an {@linkcode AbortSignal}. The abort signal * needs to be passed as the `signal` option in the options bag. The server * aborts when the abort signal is aborted. To wait for the server to close, * await the promise returned from the `Deno.serve` API. * * ```ts * const ac = new AbortController(); * * const server = Deno.serve( * { signal: ac.signal }, * (_req) => new Response("Hello, world") * ); * server.finished.then(() => console.log("Server closed")); * * console.log("Closing server..."); * ac.abort(); * ``` * * By default `Deno.serve` prints the message * `Listening on http://:/` on listening. If you like to * change this behavior, you can specify a custom `onListen` callback. * * ```ts * Deno.serve({ * onListen({ port, hostname }) { * console.log(`Server started at http://${hostname}:${port}`); * // ... more info specific to your server .. * }, * }, (_req) => new Response("Hello, world")); * ``` * * To enable TLS you must specify the `key` and `cert` options. * * ```ts * const cert = "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n"; * const key = "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n"; * Deno.serve({ cert, key }, (_req) => new Response("Hello, world")); * ``` * * @category HTTP Server */ export function serve( options: ServeTcpOptions | (ServeTcpOptions & TlsCertifiedKeyPem), handler: ServeHandler, ): HttpServer; /** Serves HTTP requests with the given option bag. * * You can specify an object with the path option, which is the * unix domain socket to listen on. * * ```ts * const ac = new AbortController(); * * const server = Deno.serve({ * path: "path/to/socket", * handler: (_req) => new Response("Hello, world"), * signal: ac.signal, * onListen({ path }) { * console.log(`Server started at ${path}`); * }, * }); * server.finished.then(() => console.log("Server closed")); * * console.log("Closing server..."); * ac.abort(); * ``` * * @category HTTP Server */ export function serve( options: ServeUnixOptions & ServeInit, ): HttpServer; /** Serves HTTP requests with the given option bag. * * The VSOCK address family facilitates communication between virtual machines and the host they are running on: https://man7.org/linux/man-pages/man7/vsock.7.html * * @experimental **UNSTABLE**: New API, yet to be vetted. * * You can specify an object with the cid and port options for the VSOCK interface. * * ```ts * const ac = new AbortController(); * * const server = Deno.serve({ * cid: -1, * port: 3000, * handler: (_req) => new Response("Hello, world"), * signal: ac.signal, * onListen({ cid, port }) { * console.log(`Server started at ${cid}:${port}`); * }, * }); * server.finished.then(() => console.log("Server closed")); * * console.log("Closing server..."); * ac.abort(); * ``` * * @category HTTP Server */ export function serve( options: ServeVsockOptions & ServeInit, ): HttpServer; /** Serves HTTP requests with the given option bag. * * You can specify an object with a port and hostname option, which is the * address to listen on. The default is port `8000` on hostname `"0.0.0.0"`. * * ```ts * const ac = new AbortController(); * * const server = Deno.serve({ * port: 3000, * hostname: "127.0.0.1", * handler: (_req) => new Response("Hello, world"), * signal: ac.signal, * onListen({ port, hostname }) { * console.log(`Server started at http://${hostname}:${port}`); * }, * }); * server.finished.then(() => console.log("Server closed")); * * console.log("Closing server..."); * ac.abort(); * ``` * * @category HTTP Server */ export function serve( options: & (ServeTcpOptions | (ServeTcpOptions & TlsCertifiedKeyPem)) & ServeInit, ): HttpServer; /** All plain number types for interfacing with foreign functions. * * @category FFI */ export type NativeNumberType = | "u8" | "i8" | "u16" | "i16" | "u32" | "i32" | "f32" | "f64"; /** All BigInt number types for interfacing with foreign functions. * * @category FFI */ export type NativeBigIntType = "u64" | "i64" | "usize" | "isize"; /** The native boolean type for interfacing to foreign functions. * * @category FFI */ export type NativeBooleanType = "bool"; /** The native pointer type for interfacing to foreign functions. * * @category FFI */ export type NativePointerType = "pointer"; /** The native buffer type for interfacing to foreign functions. * * @category FFI */ export type NativeBufferType = "buffer"; /** The native function type for interfacing with foreign functions. * * @category FFI */ export type NativeFunctionType = "function"; /** The native void type for interfacing with foreign functions. * * @category FFI */ export type NativeVoidType = "void"; /** The native struct type for interfacing with foreign functions. * * @category FFI */ export interface NativeStructType { readonly struct: readonly NativeType[]; } /** * @category FFI */ const brand: unique symbol; /** * @category FFI */ export type NativeU8Enum = "u8" & { [brand]: T }; /** * @category FFI */ export type NativeI8Enum = "i8" & { [brand]: T }; /** * @category FFI */ export type NativeU16Enum = "u16" & { [brand]: T }; /** * @category FFI */ export type NativeI16Enum = "i16" & { [brand]: T }; /** * @category FFI */ export type NativeU32Enum = "u32" & { [brand]: T }; /** * @category FFI */ export type NativeI32Enum = "i32" & { [brand]: T }; /** * @category FFI */ export type NativeTypedPointer = "pointer" & { [brand]: T; }; /** * @category FFI */ export type NativeTypedFunction = & "function" & { [brand]: T; }; /** All supported types for interfacing with foreign functions. * * @category FFI */ export type NativeType = | NativeNumberType | NativeBigIntType | NativeBooleanType | NativePointerType | NativeBufferType | NativeFunctionType | NativeStructType; /** @category FFI */ export type NativeResultType = NativeType | NativeVoidType; /** Type conversion for foreign symbol parameters and unsafe callback return * types. * * @category FFI */ export type ToNativeType = T extends NativeStructType ? BufferSource : T extends NativeNumberType ? T extends NativeU8Enum ? U : T extends NativeI8Enum ? U : T extends NativeU16Enum ? U : T extends NativeI16Enum ? U : T extends NativeU32Enum ? U : T extends NativeI32Enum ? U : number : T extends NativeBigIntType ? bigint : T extends NativeBooleanType ? boolean : T extends NativePointerType ? T extends NativeTypedPointer ? U | null : PointerValue : T extends NativeFunctionType ? T extends NativeTypedFunction ? PointerValue | null : PointerValue : T extends NativeBufferType ? BufferSource | null : never; /** Type conversion for unsafe callback return types. * * @category FFI */ export type ToNativeResultType< T extends NativeResultType = NativeResultType, > = T extends NativeStructType ? BufferSource : T extends NativeNumberType ? T extends NativeU8Enum ? U : T extends NativeI8Enum ? U : T extends NativeU16Enum ? U : T extends NativeI16Enum ? U : T extends NativeU32Enum ? U : T extends NativeI32Enum ? U : number : T extends NativeBigIntType ? bigint : T extends NativeBooleanType ? boolean : T extends NativePointerType ? T extends NativeTypedPointer ? U | null : PointerValue : T extends NativeFunctionType ? T extends NativeTypedFunction ? PointerObject | null : PointerValue : T extends NativeBufferType ? BufferSource | null : T extends NativeVoidType ? void : never; /** A utility type for conversion of parameter types of foreign functions. * * @category FFI */ export type ToNativeParameterTypes = // [T[number][]] extends [T] ? ToNativeType[] : [readonly T[number][]] extends [T] ? readonly ToNativeType[] : T extends readonly [...NativeType[]] ? { [K in keyof T]: ToNativeType; } : never; /** Type conversion for foreign symbol return types and unsafe callback * parameters. * * @category FFI */ export type FromNativeType = T extends NativeStructType ? Uint8Array : T extends NativeNumberType ? T extends NativeU8Enum ? U : T extends NativeI8Enum ? U : T extends NativeU16Enum ? U : T extends NativeI16Enum ? U : T extends NativeU32Enum ? U : T extends NativeI32Enum ? U : number : T extends NativeBigIntType ? bigint : T extends NativeBooleanType ? boolean : T extends NativePointerType ? T extends NativeTypedPointer ? U | null : PointerValue : T extends NativeBufferType ? PointerValue : T extends NativeFunctionType ? T extends NativeTypedFunction ? PointerObject | null : PointerValue : never; /** Type conversion for foreign symbol return types. * * @category FFI */ export type FromNativeResultType< T extends NativeResultType = NativeResultType, > = T extends NativeStructType ? Uint8Array : T extends NativeNumberType ? T extends NativeU8Enum ? U : T extends NativeI8Enum ? U : T extends NativeU16Enum ? U : T extends NativeI16Enum ? U : T extends NativeU32Enum ? U : T extends NativeI32Enum ? U : number : T extends NativeBigIntType ? bigint : T extends NativeBooleanType ? boolean : T extends NativePointerType ? T extends NativeTypedPointer ? U | null : PointerValue : T extends NativeBufferType ? PointerValue : T extends NativeFunctionType ? T extends NativeTypedFunction ? PointerObject | null : PointerValue : T extends NativeVoidType ? void : never; /** @category FFI */ export type FromNativeParameterTypes = // [T[number][]] extends [T] ? FromNativeType[] : [readonly T[number][]] extends [T] ? readonly FromNativeType[] : T extends readonly [...NativeType[]] ? { [K in keyof T]: FromNativeType; } : never; /** The interface for a foreign function as defined by its parameter and result * types. * * @category FFI */ export interface ForeignFunction< Parameters extends readonly NativeType[] = readonly NativeType[], Result extends NativeResultType = NativeResultType, NonBlocking extends boolean = boolean, > { /** Name of the symbol. * * Defaults to the key name in symbols object. */ name?: string; /** The parameters of the foreign function. */ parameters: Parameters; /** The result (return value) of the foreign function. */ result: Result; /** When `true`, function calls will run on a dedicated blocking thread and * will return a `Promise` resolving to the `result`. */ nonblocking?: NonBlocking; /** When `true`, dlopen will not fail if the symbol is not found. * Instead, the symbol will be set to `null`. * * @default {false} */ optional?: boolean; } /** @category FFI */ export interface ForeignStatic { /** Name of the symbol, defaults to the key name in symbols object. */ name?: string; /** The type of the foreign static value. */ type: Type; /** When `true`, dlopen will not fail if the symbol is not found. * Instead, the symbol will be set to `null`. * * @default {false} */ optional?: boolean; } /** A foreign library interface descriptor. * * @category FFI */ export interface ForeignLibraryInterface { [name: string]: ForeignFunction | ForeignStatic; } /** A utility type that infers a foreign symbol. * * @category FFI */ export type StaticForeignSymbol = T extends ForeignFunction ? FromForeignFunction : T extends ForeignStatic ? FromNativeType : never; /** @category FFI */ export type FromForeignFunction = T["parameters"] extends readonly [] ? () => StaticForeignSymbolReturnType : ( ...args: ToNativeParameterTypes ) => StaticForeignSymbolReturnType; /** @category FFI */ export type StaticForeignSymbolReturnType = ConditionalAsync< T["nonblocking"], FromNativeResultType >; /** @category FFI */ export type ConditionalAsync< IsAsync extends boolean | undefined, T, > = IsAsync extends true ? Promise : T; /** A utility type that infers a foreign library interface. * * @category FFI */ export type StaticForeignLibraryInterface = { [K in keyof T]: T[K]["optional"] extends true ? StaticForeignSymbol | null : StaticForeignSymbol; }; /** A non-null pointer, represented as an object * at runtime. The object's prototype is `null` * and cannot be changed. The object cannot be * assigned to either and is thus entirely read-only. * * To interact with memory through a pointer use the * {@linkcode UnsafePointerView} class. To create a * pointer from an address or the get the address of * a pointer use the static methods of the * {@linkcode UnsafePointer} class. * * @category FFI */ export interface PointerObject { [brand]: T; } /** Pointers are represented either with a {@linkcode PointerObject} * object or a `null` if the pointer is null. * * @category FFI */ export type PointerValue = null | PointerObject; /** A collection of static functions for interacting with pointer objects. * * @category FFI */ export class UnsafePointer { /** Create a pointer from a numeric value. This one is really dangerous! */ static create(value: bigint): PointerValue; /** Returns `true` if the two pointers point to the same address. */ static equals(a: PointerValue, b: PointerValue): boolean; /** Return the direct memory pointer to the typed array in memory. */ static of( value: Deno.UnsafeCallback | BufferSource, ): PointerValue; /** Return a new pointer offset from the original by `offset` bytes. */ static offset( value: PointerObject, offset: number, ): PointerValue; /** Get the numeric value of a pointer */ static value(value: PointerValue): bigint; } /** An unsafe pointer view to a memory location as specified by the `pointer` * value. The `UnsafePointerView` API follows the standard built in interface * {@linkcode DataView} for accessing the underlying types at an memory * location (numbers, strings and raw bytes). * * @category FFI */ export class UnsafePointerView { constructor(pointer: PointerObject); pointer: PointerObject; /** Gets a boolean at the specified byte offset from the pointer. */ getBool(offset?: number): boolean; /** Gets an unsigned 8-bit integer at the specified byte offset from the * pointer. */ getUint8(offset?: number): number; /** Gets a signed 8-bit integer at the specified byte offset from the * pointer. */ getInt8(offset?: number): number; /** Gets an unsigned 16-bit integer at the specified byte offset from the * pointer. */ getUint16(offset?: number): number; /** Gets a signed 16-bit integer at the specified byte offset from the * pointer. */ getInt16(offset?: number): number; /** Gets an unsigned 32-bit integer at the specified byte offset from the * pointer. */ getUint32(offset?: number): number; /** Gets a signed 32-bit integer at the specified byte offset from the * pointer. */ getInt32(offset?: number): number; /** Gets an unsigned 64-bit integer at the specified byte offset from the * pointer. */ getBigUint64(offset?: number): bigint; /** Gets a signed 64-bit integer at the specified byte offset from the * pointer. */ getBigInt64(offset?: number): bigint; /** Gets a signed 32-bit float at the specified byte offset from the * pointer. */ getFloat32(offset?: number): number; /** Gets a signed 64-bit float at the specified byte offset from the * pointer. */ getFloat64(offset?: number): number; /** Gets a pointer at the specified byte offset from the pointer */ getPointer(offset?: number): PointerValue; /** Gets a UTF-8 encoded string at the specified byte offset until 0 byte. * * Returned string doesn't include U+0000 character. * * Invalid UTF-8 characters are replaced with U+FFFD character in the returned string. */ getCString(offset?: number): string; /** Gets a UTF-8 encoded string at the specified byte offset from the specified pointer until 0 byte. * * Returned string doesn't include U+0000 character. * * Invalid UTF-8 characters are replaced with U+FFFD character in the returned string. */ static getCString(pointer: PointerObject, offset?: number): string; /** Gets an `ArrayBuffer` of length `byteLength` at the specified byte * offset from the pointer. */ getArrayBuffer(byteLength: number, offset?: number): ArrayBuffer; /** Gets an `ArrayBuffer` of length `byteLength` at the specified byte * offset from the specified pointer. */ static getArrayBuffer( pointer: PointerObject, byteLength: number, offset?: number, ): ArrayBuffer; /** Copies the memory of the pointer into a typed array. * * Length is determined from the typed array's `byteLength`. * * Also takes optional byte offset from the pointer. */ copyInto(destination: BufferSource, offset?: number): void; /** Copies the memory of the specified pointer into a typed array. * * Length is determined from the typed array's `byteLength`. * * Also takes optional byte offset from the pointer. */ static copyInto( pointer: PointerObject, destination: BufferSource, offset?: number, ): void; } /** An unsafe pointer to a function, for calling functions that are not present * as symbols. * * @category FFI */ export class UnsafeFnPointer { /** The pointer to the function. */ pointer: PointerObject; /** The definition of the function. */ definition: Fn; constructor( pointer: PointerObject>>, definition: Fn, ); /** Call the foreign function. */ call: FromForeignFunction; } /** Definition of a unsafe callback function. * * @category FFI */ export interface UnsafeCallbackDefinition< Parameters extends readonly NativeType[] = readonly NativeType[], Result extends NativeResultType = NativeResultType, > { /** The parameters of the callbacks. */ parameters: Parameters; /** The current result of the callback. */ result: Result; } /** An unsafe callback function. * * @category FFI */ export type UnsafeCallbackFunction< Parameters extends readonly NativeType[] = readonly NativeType[], Result extends NativeResultType = NativeResultType, > = Parameters extends readonly [] ? () => ToNativeResultType : ( ...args: FromNativeParameterTypes ) => ToNativeResultType; /** An unsafe function pointer for passing JavaScript functions as C function * pointers to foreign function calls. * * The function pointer remains valid until the `close()` method is called. * * All `UnsafeCallback` are always thread safe in that they can be called from * foreign threads without crashing. However, they do not wake up the Deno event * loop by default. * * If a callback is to be called from foreign threads, use the `threadSafe()` * static constructor or explicitly call `ref()` to have the callback wake up * the Deno event loop when called from foreign threads. This also stops * Deno's process from exiting while the callback still exists and is not * unref'ed. * * Use `deref()` to then allow Deno's process to exit. Calling `deref()` on * a ref'ed callback does not stop it from waking up the Deno event loop when * called from foreign threads. * * @category FFI */ export class UnsafeCallback< const Definition extends UnsafeCallbackDefinition = UnsafeCallbackDefinition, > { constructor( definition: Definition, callback: UnsafeCallbackFunction< Definition["parameters"], Definition["result"] >, ); /** The pointer to the unsafe callback. */ readonly pointer: PointerObject; /** The definition of the unsafe callback. */ readonly definition: Definition; /** The callback function. */ readonly callback: UnsafeCallbackFunction< Definition["parameters"], Definition["result"] >; /** * Creates an {@linkcode UnsafeCallback} and calls `ref()` once to allow it to * wake up the Deno event loop when called from foreign threads. * * This also stops Deno's process from exiting while the callback still * exists and is not unref'ed. */ static threadSafe< Definition extends UnsafeCallbackDefinition = UnsafeCallbackDefinition, >( definition: Definition, callback: UnsafeCallbackFunction< Definition["parameters"], Definition["result"] >, ): UnsafeCallback; /** * Increments the callback's reference counting and returns the new * reference count. * * After `ref()` has been called, the callback always wakes up the * Deno event loop when called from foreign threads. * * If the callback's reference count is non-zero, it keeps Deno's * process from exiting. */ ref(): number; /** * Decrements the callback's reference counting and returns the new * reference count. * * Calling `unref()` does not stop a callback from waking up the Deno * event loop when called from foreign threads. * * If the callback's reference counter is zero, it no longer keeps * Deno's process from exiting. */ unref(): number; /** * Removes the C function pointer associated with this instance. * * Continuing to use the instance or the C function pointer after closing * the `UnsafeCallback` will lead to errors and crashes. * * Calling this method sets the callback's reference counting to zero, * stops the callback from waking up the Deno event loop when called from * foreign threads and no longer keeps Deno's process from exiting. */ close(): void; } /** A dynamic library resource. Use {@linkcode Deno.dlopen} to load a dynamic * library and return this interface. * * @category FFI */ export interface DynamicLibrary { /** All of the registered library along with functions for calling them. */ symbols: StaticForeignLibraryInterface; /** Removes the pointers associated with the library symbols. * * Continuing to use symbols that are part of the library will lead to * errors and crashes. * * Calling this method will also immediately set any references to zero and * will no longer keep Deno's process from exiting. */ close(): void; } /** Opens an external dynamic library and registers symbols, making foreign * functions available to be called. * * Requires `allow-ffi` permission. Loading foreign dynamic libraries can in * theory bypass all of the sandbox permissions. While it is a separate * permission users should acknowledge in practice that is effectively the * same as running with the `allow-all` permission. * * @example Given a C library which exports a foreign function named `add()` * * ```ts * // Determine library extension based on * // your OS. * let libSuffix = ""; * switch (Deno.build.os) { * case "windows": * libSuffix = "dll"; * break; * case "darwin": * libSuffix = "dylib"; * break; * default: * libSuffix = "so"; * break; * } * * const libName = `./libadd.${libSuffix}`; * // Open library and define exported symbols * const dylib = Deno.dlopen( * libName, * { * "add": { parameters: ["isize", "isize"], result: "isize" }, * } as const, * ); * * // Call the symbol `add` * const result = dylib.symbols.add(35n, 34n); // 69n * * console.log(`Result from external addition of 35 and 34: ${result}`); * ``` * * @tags allow-ffi * @category FFI */ export function dlopen( filename: string | URL, symbols: S, ): DynamicLibrary; /** * A custom `HttpClient` for use with {@linkcode fetch} function. This is * designed to allow custom certificates or proxies to be used with `fetch()`. * * @example ```ts * const caCert = await Deno.readTextFile("./ca.pem"); * const client = Deno.createHttpClient({ caCerts: [ caCert ] }); * const req = await fetch("https://myserver.com", { client }); * ``` * * @category Fetch */ export class HttpClient implements Disposable { /** Close the HTTP client. */ close(): void; [Symbol.dispose](): void; } /** * The options used when creating a {@linkcode Deno.HttpClient}. * * @category Fetch */ export interface CreateHttpClientOptions { /** A list of root certificates that will be used in addition to the * default root certificates to verify the peer's certificate. * * Must be in PEM format. */ caCerts?: string[]; /** An alternative transport (a proxy) to use for new connections. */ proxy?: Proxy; /** Sets the maximum number of idle connections per host allowed in the pool. */ poolMaxIdlePerHost?: number; /** Set an optional timeout for idle sockets being kept-alive. * Set to false to disable the timeout. */ poolIdleTimeout?: number | false; /** * Whether HTTP/1.1 is allowed or not. * * @default {true} */ http1?: boolean; /** Whether HTTP/2 is allowed or not. * * @default {true} */ http2?: boolean; /** Whether setting the host header is allowed or not. * * @default {false} */ allowHost?: boolean; /** Sets the local address where the socket will connect from. */ localAddress?: string; } /** * The definition for alternative transports (or proxies) in * {@linkcode Deno.CreateHttpClientOptions}. * * Supported proxies: * - HTTP/HTTPS proxy: this uses passthrough to tunnel HTTP requests, or HTTP * CONNECT to tunnel HTTPS requests through a different server. * - SOCKS5 proxy: this uses the SOCKS5 protocol to tunnel TCP connections * through a different server. * - TCP socket: this sends all requests to a specified TCP socket. * - Unix domain socket: this sends all requests to a local Unix domain * socket rather than a TCP socket. *Not supported on Windows.* * - Vsock socket: this sends all requests to a local vsock socket. * *Only supported on Linux and macOS.* * * @category Fetch */ export type Proxy = { transport?: "http" | "https" | "socks5"; /** * The string URL of the proxy server to use. * * For `http` and `https` transports, the URL must start with `http://` or * `https://` respectively, or be a plain hostname. * * For `socks` transport, the URL must start with `socks5://` or * `socks5h://`. */ url: string; /** The basic auth credentials to be used against the proxy server. */ basicAuth?: BasicAuth; } | { transport: "tcp"; /** The hostname of the TCP server to connect to. */ hostname: string; /** The port of the TCP server to connect to. */ port: number; } | { transport: "unix"; /** The path to the unix domain socket to use. */ path: string; } | { transport: "vsock"; /** The CID (Context Identifier) of the vsock to connect to. */ cid: number; /** The port of the vsock to connect to. */ port: number; }; /** * Basic authentication credentials to be used with a {@linkcode Deno.Proxy} * server when specifying {@linkcode Deno.CreateHttpClientOptions}. * * @category Fetch */ export interface BasicAuth { /** The username to be used against the proxy server. */ username: string; /** The password to be used against the proxy server. */ password: string; } /** Create a custom HttpClient to use with {@linkcode fetch}. This is an * extension of the web platform Fetch API which allows Deno to use custom * TLS CA certificates and connect via a proxy while using `fetch()`. * * The `cert` and `key` options can be used to specify a client certificate * and key to use when connecting to a server that requires client * authentication (mutual TLS or mTLS). The `cert` and `key` options must be * provided in PEM format. * * @example ```ts * const caCert = await Deno.readTextFile("./ca.pem"); * const client = Deno.createHttpClient({ caCerts: [ caCert ] }); * const response = await fetch("https://myserver.com", { client }); * ``` * * @example ```ts * const client = Deno.createHttpClient({ * proxy: { url: "http://myproxy.com:8080" } * }); * const response = await fetch("https://myserver.com", { client }); * ``` * * @example ```ts * const key = "----BEGIN PRIVATE KEY----..."; * const cert = "----BEGIN CERTIFICATE----..."; * const client = Deno.createHttpClient({ key, cert }); * const response = await fetch("https://myserver.com", { client }); * ``` * * @category Fetch */ export function createHttpClient( options: | CreateHttpClientOptions | (CreateHttpClientOptions & TlsCertifiedKeyPem), ): HttpClient; /** * APIs for working with the OpenTelemetry observability framework. Deno can * export traces, metrics, and logs to OpenTelemetry compatible backends via * the OTLP protocol. * * Deno automatically instruments the runtime with OpenTelemetry traces and * metrics. This data is exported via OTLP to OpenTelemetry compatible * backends. User logs from the `console` API are exported as OpenTelemetry * logs via OTLP. * * User code can also create custom traces, metrics, and logs using the * OpenTelemetry API. This is done using the official OpenTelemetry package * for JavaScript: * [`npm:@opentelemetry/api`](https://opentelemetry.io/docs/languages/js/). * Deno integrates with this package to provide tracing, metrics, and trace * context propagation between native Deno APIs (like `Deno.serve` or `fetch`) * and custom user code. Deno automatically registers the providers with the * OpenTelemetry API, so users can start creating custom traces, metrics, and * logs without any additional setup. * * @example Using OpenTelemetry API to create custom traces * ```ts,ignore * import { trace } from "npm:@opentelemetry/api@1"; * * const tracer = trace.getTracer("example-tracer"); * * async function doWork() { * return tracer.startActiveSpan("doWork", async (span) => { * span.setAttribute("key", "value"); * await new Promise((resolve) => setTimeout(resolve, 1000)); * span.end(); * }); * } * * Deno.serve(async (req) => { * await doWork(); * const resp = await fetch("https://example.com"); * return resp; * }); * ``` * * @category Telemetry */ export namespace telemetry { /** * A TracerProvider compatible with OpenTelemetry.js * https://open-telemetry.github.io/opentelemetry-js/interfaces/_opentelemetry_api.TracerProvider.html * * This is a singleton object that implements the OpenTelemetry * TracerProvider interface. * * @category Telemetry */ // deno-lint-ignore no-explicit-any export const tracerProvider: any; /** * A ContextManager compatible with OpenTelemetry.js * https://open-telemetry.github.io/opentelemetry-js/interfaces/_opentelemetry_api.ContextManager.html * * This is a singleton object that implements the OpenTelemetry * ContextManager interface. * * @category Telemetry */ // deno-lint-ignore no-explicit-any export const contextManager: any; /** * A MeterProvider compatible with OpenTelemetry.js * https://open-telemetry.github.io/opentelemetry-js/interfaces/_opentelemetry_api.MeterProvider.html * * This is a singleton object that implements the OpenTelemetry * MeterProvider interface. * * @category Telemetry */ // deno-lint-ignore no-explicit-any export const meterProvider: any; export {}; // only export exports } export {}; // only export exports } declare namespace Deno { /** @category Network */ export interface NetAddr { transport: "tcp" | "udp"; hostname: string; port: number; } /** @category Network */ export interface UnixAddr { transport: "unix" | "unixpacket"; path: string; } /** * @experimental **UNSTABLE**: New API, yet to be vetted. * @category Network */ export interface VsockAddr { transport: "vsock"; cid: number; port: number; } /** @category Network */ export type Addr = NetAddr | UnixAddr | VsockAddr; /** A generic network listener for stream-oriented protocols. * * @category Network */ export interface Listener extends AsyncIterable, Disposable { /** Waits for and resolves to the next connection to the `Listener`. */ accept(): Promise; /** Close closes the listener. Any pending accept promises will be rejected * with errors. */ close(): void; /** Return the address of the `Listener`. */ readonly addr: A; [Symbol.asyncIterator](): AsyncIterableIterator; /** * Make the listener block the event loop from finishing. * * Note: the listener blocks the event loop from finishing by default. * This method is only meaningful after `.unref()` is called. */ ref(): void; /** Make the listener not block the event loop from finishing. */ unref(): void; } /** Specialized listener that accepts TLS connections. * * @category Network */ export type TlsListener = Listener; /** Specialized listener that accepts TCP connections. * * @category Network */ export type TcpListener = Listener; /** Specialized listener that accepts Unix connections. * * @category Network */ export type UnixListener = Listener; /** Specialized listener that accepts VSOCK connections. * * @experimental **UNSTABLE**: New API, yet to be vetted. * * @category Network */ export type VsockListener = Listener; /** @category Network */ export interface Conn extends Disposable { /** Read the incoming data from the connection into an array buffer (`p`). * * Resolves to either the number of bytes read during the operation or EOF * (`null`) if there was nothing more to read. * * It is possible for a read to successfully return with `0` bytes. This * does not indicate EOF. * * **It is not guaranteed that the full buffer will be read in a single * call.** * * ```ts * // If the text "hello world" is received by the client: * const conn = await Deno.connect({ hostname: "example.com", port: 80 }); * const buf = new Uint8Array(100); * const numberOfBytesRead = await conn.read(buf); // 11 bytes * const text = new TextDecoder().decode(buf); // "hello world" * ``` * * @category I/O */ read(p: Uint8Array): Promise; /** Write the contents of the array buffer (`p`) to the connection. * * Resolves to the number of bytes written. * * **It is not guaranteed that the full buffer will be written in a single * call.** * * ```ts * const conn = await Deno.connect({ hostname: "example.com", port: 80 }); * const encoder = new TextEncoder(); * const data = encoder.encode("Hello world"); * const bytesWritten = await conn.write(data); // 11 * ``` * * @category I/O */ write(p: Uint8Array): Promise; /** Closes the connection, freeing the resource. * * ```ts * const conn = await Deno.connect({ hostname: "example.com", port: 80 }); * * // ... * * conn.close(); * ``` */ close(): void; /** The local address of the connection. */ readonly localAddr: A; /** The remote address of the connection. */ readonly remoteAddr: A; /** Shuts down (`shutdown(2)`) the write side of the connection. Most * callers should just use `close()`. */ closeWrite(): Promise; /** Make the connection block the event loop from finishing. * * Note: the connection blocks the event loop from finishing by default. * This method is only meaningful after `.unref()` is called. */ ref(): void; /** Make the connection not block the event loop from finishing. */ unref(): void; readonly readable: ReadableStream>; readonly writable: WritableStream>; } /** @category Network */ export interface TlsHandshakeInfo { /** * Contains the ALPN protocol selected during negotiation with the server. * If no ALPN protocol selected, returns `null`. */ alpnProtocol: string | null; } /** @category Network */ export interface TlsConn extends Conn { /** Runs the client or server handshake protocol to completion if that has * not happened yet. Calling this method is optional; the TLS handshake * will be completed automatically as soon as data is sent or received. */ handshake(): Promise; } /** @category Network */ export interface ListenOptions { /** The port to listen on. * * Set to `0` to listen on any available port. */ port: number; /** A literal IP address or host name that can be resolved to an IP address. * * __Note about `0.0.0.0`__ While listening `0.0.0.0` works on all platforms, * the browsers on Windows don't work with the address `0.0.0.0`. * You should show the message like `server running on localhost:8080` instead of * `server running on 0.0.0.0:8080` if your program supports Windows. * * @default {"0.0.0.0"} */ hostname?: string; /** Maximum number of pending connections in the listen queue. * * This parameter controls how many incoming connections can be queued by the * operating system while waiting for the application to accept them. If more * connections arrive when the queue is full, they will be refused. * * The kernel may adjust this value (e.g., rounding up to the next power of 2 * plus 1). Different operating systems have different maximum limits. * * @default {511} */ tcpBacklog?: number; } /** @category Network */ export interface TcpListenOptions extends ListenOptions { } /** Listen announces on the local transport address. * * ```ts * const listener1 = Deno.listen({ port: 80 }) * const listener2 = Deno.listen({ hostname: "192.0.2.1", port: 80 }) * const listener3 = Deno.listen({ hostname: "[2001:db8::1]", port: 80 }); * const listener4 = Deno.listen({ hostname: "golang.org", port: 80, transport: "tcp" }); * ``` * * Requires `allow-net` permission. * * @tags allow-net * @category Network */ export function listen( options: TcpListenOptions & { transport?: "tcp" }, ): TcpListener; /** Options which can be set when opening a Unix listener via * {@linkcode Deno.listen} or {@linkcode Deno.listenDatagram}. * * @category Network */ export interface UnixListenOptions { /** A path to the Unix Socket. */ path: string; } /** Listen announces on the local transport address. * * ```ts * const listener = Deno.listen({ path: "/foo/bar.sock", transport: "unix" }) * ``` * * Requires `allow-read` and `allow-write` permission. * * @tags allow-read, allow-write * @category Network */ // deno-lint-ignore adjacent-overload-signatures export function listen( options: UnixListenOptions & { transport: "unix" }, ): UnixListener; /** Options which can be set when opening a VSOCK listener via * {@linkcode Deno.listen}. * * @experimental **UNSTABLE**: New API, yet to be vetted. * * @category Network */ export interface VsockListenOptions { cid: number; port: number; } /** Listen announces on the local transport address. * * @experimental **UNSTABLE**: New API, yet to be vetted. * * The VSOCK address family facilitates communication between virtual machines and the host they are running on: https://man7.org/linux/man-pages/man7/vsock.7.html * * ```ts * const listener = Deno.listen({ cid: -1, port: 80, transport: "vsock" }) * ``` * * Requires `allow-net` permission. * * @tags allow-net * @category Network */ // deno-lint-ignore adjacent-overload-signatures export function listen( options: VsockListenOptions & { transport: "vsock" }, ): VsockListener; /** * Provides certified key material from strings. The key material is provided in * `PEM`-format (Privacy Enhanced Mail, https://www.rfc-editor.org/rfc/rfc1422) which can be identified by having * `-----BEGIN-----` and `-----END-----` markers at the beginning and end of the strings. This type of key is not compatible * with `DER`-format keys which are binary. * * Deno supports RSA, EC, and PKCS8-format keys. * * ```ts * const key = { * key: "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n", * cert: "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n" } * }; * ``` * * @category Network */ export interface TlsCertifiedKeyPem { /** The format of this key material, which must be PEM. */ keyFormat?: "pem"; /** Private key in `PEM` format. RSA, EC, and PKCS8-format keys are supported. */ key: string; /** Certificate chain in `PEM` format. */ cert: string; } /** @category Network */ export interface ListenTlsOptions extends TcpListenOptions { transport?: "tcp"; /** Application-Layer Protocol Negotiation (ALPN) protocols to announce to * the client. If not specified, no ALPN extension will be included in the * TLS handshake. */ alpnProtocols?: string[]; } /** Listen announces on the local transport address over TLS (transport layer * security). * * ```ts * using listener = Deno.listenTls({ * port: 443, * cert: Deno.readTextFileSync("./server.crt"), * key: Deno.readTextFileSync("./server.key"), * }); * ``` * * Requires `allow-net` permission. * * @tags allow-net * @category Network */ export function listenTls( options: ListenTlsOptions & TlsCertifiedKeyPem, ): TlsListener; /** @category Network */ export interface ConnectOptions { /** The port to connect to. */ port: number; /** A literal IP address or host name that can be resolved to an IP address. * If not specified, * * @default {"127.0.0.1"} */ hostname?: string; /** The transport layer protocol to use. */ transport?: "tcp"; /** An {@linkcode AbortSignal} to close the tcp connection. */ signal?: AbortSignal; } /** * Connects to the hostname (default is "127.0.0.1") and port on the named * transport (default is "tcp"), and resolves to the connection (`Conn`). * * ```ts * const conn1 = await Deno.connect({ port: 80 }); * const conn2 = await Deno.connect({ hostname: "192.0.2.1", port: 80 }); * const conn3 = await Deno.connect({ hostname: "[2001:db8::1]", port: 80 }); * const conn4 = await Deno.connect({ hostname: "golang.org", port: 80, transport: "tcp" }); * ``` * * Requires `allow-net` permission for "tcp". * * @tags allow-net * @category Network */ export function connect(options: ConnectOptions): Promise; /** @category Network */ export interface TcpConn extends Conn { /** * Enable/disable the use of Nagle's algorithm. * * @param [noDelay=true] */ setNoDelay(noDelay?: boolean): void; /** Enable/disable keep-alive functionality. */ setKeepAlive(keepAlive?: boolean): void; } /** @category Network */ export interface UnixConnectOptions { transport: "unix"; path: string; } /** @category Network */ export interface UnixConn extends Conn {} /** Connects to the hostname (default is "127.0.0.1") and port on the named * transport (default is "tcp"), and resolves to the connection (`Conn`). * * ```ts * const conn1 = await Deno.connect({ port: 80 }); * const conn2 = await Deno.connect({ hostname: "192.0.2.1", port: 80 }); * const conn3 = await Deno.connect({ hostname: "[2001:db8::1]", port: 80 }); * const conn4 = await Deno.connect({ hostname: "golang.org", port: 80, transport: "tcp" }); * const conn5 = await Deno.connect({ path: "/foo/bar.sock", transport: "unix" }); * ``` * * Requires `allow-net` permission for "tcp" and `allow-read` for "unix". * * @tags allow-net, allow-read * @category Network */ // deno-lint-ignore adjacent-overload-signatures export function connect(options: UnixConnectOptions): Promise; /** * @experimental **UNSTABLE**: New API, yet to be vetted. * @category Network */ export interface VsockConnectOptions { transport: "vsock"; cid: number; port: number; } /** @category Network */ export interface VsockConn extends Conn {} /** Connects to the hostname (default is "127.0.0.1") and port on the named * transport (default is "tcp"), and resolves to the connection (`Conn`). * * @experimental **UNSTABLE**: New API, yet to be vetted. * * ```ts * const conn1 = await Deno.connect({ port: 80 }); * const conn2 = await Deno.connect({ hostname: "192.0.2.1", port: 80 }); * const conn3 = await Deno.connect({ hostname: "[2001:db8::1]", port: 80 }); * const conn4 = await Deno.connect({ hostname: "golang.org", port: 80, transport: "tcp" }); * const conn5 = await Deno.connect({ path: "/foo/bar.sock", transport: "unix" }); * const conn6 = await Deno.connect({ cid: -1, port: 80, transport: "vsock" }); * ``` * * Requires `allow-net` permission for "tcp" and "vsock", and `allow-read` for "unix". * * @tags allow-net, allow-read * @category Network */ // deno-lint-ignore adjacent-overload-signatures export function connect(options: VsockConnectOptions): Promise; /** @category Network */ export interface ConnectTlsOptions { /** The port to connect to. */ port: number; /** A literal IP address or host name that can be resolved to an IP address. * * @default {"127.0.0.1"} */ hostname?: string; /** A list of root certificates that will be used in addition to the * default root certificates to verify the peer's certificate. * * Must be in PEM format. */ caCerts?: string[]; /** Application-Layer Protocol Negotiation (ALPN) protocols supported by * the client. If not specified, no ALPN extension will be included in the * TLS handshake. */ alpnProtocols?: string[]; /** If true, the certificate's common name or subject alternative names will not be * checked against the hostname provided in the options. * * This disables hostname verification but still validates the certificate chain. * Use with caution and only when connecting to known servers. * * @default {false} */ unsafelyDisableHostnameVerification?: boolean; } /** Establishes a secure connection over TLS (transport layer security) using * an optional list of CA certs, hostname (default is "127.0.0.1") and port. * * The CA cert list is optional and if not included Mozilla's root * certificates will be used (see also https://github.com/ctz/webpki-roots for * specifics). * * Mutual TLS (mTLS or client certificates) are supported by providing a * `key` and `cert` in the options as PEM-encoded strings. * * ```ts * const caCert = await Deno.readTextFile("./certs/my_custom_root_CA.pem"); * const conn1 = await Deno.connectTls({ port: 80 }); * const conn2 = await Deno.connectTls({ caCerts: [caCert], hostname: "192.0.2.1", port: 80 }); * const conn3 = await Deno.connectTls({ hostname: "[2001:db8::1]", port: 80 }); * const conn4 = await Deno.connectTls({ caCerts: [caCert], hostname: "golang.org", port: 80}); * * const key = "----BEGIN PRIVATE KEY----..."; * const cert = "----BEGIN CERTIFICATE----..."; * const conn5 = await Deno.connectTls({ port: 80, key, cert }); * ``` * * Requires `allow-net` permission. * * @tags allow-net * @category Network */ export function connectTls( options: ConnectTlsOptions | (ConnectTlsOptions & TlsCertifiedKeyPem), ): Promise; /** @category Network */ export interface StartTlsOptions { /** A literal IP address or host name that can be resolved to an IP address. * * @default {"127.0.0.1"} */ hostname?: string; /** A list of root certificates that will be used in addition to the * default root certificates to verify the peer's certificate. * * Must be in PEM format. */ caCerts?: string[]; /** Application-Layer Protocol Negotiation (ALPN) protocols to announce to * the client. If not specified, no ALPN extension will be included in the * TLS handshake. */ alpnProtocols?: string[]; /** If true, the certificate's common name or subject alternative names will not be * checked against the hostname provided in the options. * * This disables hostname verification but still validates the certificate chain. * Use with caution and only when connecting to known servers. * * @default {false} */ unsafelyDisableHostnameVerification?: boolean; } /** Start TLS handshake from an existing connection using an optional list of * CA certificates, and hostname (default is "127.0.0.1"). Specifying CA certs * is optional. By default the configured root certificates are used. Using * this function requires that the other end of the connection is prepared for * a TLS handshake. * * Note that this function *consumes* the TCP connection passed to it, thus the * original TCP connection will be unusable after calling this. Additionally, * you need to ensure that the TCP connection is not being used elsewhere when * calling this function in order for the TCP connection to be consumed properly. * For instance, if there is a `Promise` that is waiting for read operation on * the TCP connection to complete, it is considered that the TCP connection is * being used elsewhere. In such a case, this function will fail. * * ```ts * const conn = await Deno.connect({ port: 80, hostname: "127.0.0.1" }); * const caCert = await Deno.readTextFile("./certs/my_custom_root_CA.pem"); * // `conn` becomes unusable after calling `Deno.startTls` * const tlsConn = await Deno.startTls(conn, { caCerts: [caCert], hostname: "localhost" }); * ``` * * Requires `allow-net` permission. * * @tags allow-net * @category Network */ export function startTls( conn: TcpConn, options?: StartTlsOptions, ): Promise; /** * **UNSTABLE**: New API, yet to be vetted. * @experimental * @category Network */ export interface QuicEndpointOptions { /** * A literal IP address or host name that can be resolved to an IP address. * @default {"::"} */ hostname?: string; /** * The port to bind to. * @default {0} */ port?: number; } /** * **UNSTABLE**: New API, yet to be vetted. * @experimental * @category Network */ export interface QuicTransportOptions { /** Period of inactivity before sending a keep-alive packet. Keep-alive * packets prevent an inactive but otherwise healthy connection from timing * out. Only one side of any given connection needs keep-alive enabled for * the connection to be preserved. * @default {undefined} */ keepAliveInterval?: number; /** Maximum duration of inactivity to accept before timing out the * connection. The true idle timeout is the minimum of this and the peer’s * own max idle timeout. * @default {undefined} */ maxIdleTimeout?: number; /** Maximum number of incoming bidirectional streams that may be open * concurrently. * @default {100} */ maxConcurrentBidirectionalStreams?: number; /** Maximum number of incoming unidirectional streams that may be open * concurrently. * @default {100} */ maxConcurrentUnidirectionalStreams?: number; /** * The congestion control algorithm used when sending data over this connection. * @default {"default"} */ congestionControl?: "throughput" | "low-latency" | "default"; } /** * **UNSTABLE**: New API, yet to be vetted. * @experimental * @category Network */ export interface ConnectQuicOptions extends QuicTransportOptions { /** The port to connect to. */ port: number; /** A literal IP address or host name that can be resolved to an IP address. */ hostname: string; /** The name used for validating the certificate provided by the server. If * not provided, defaults to `hostname`. */ serverName?: string | undefined; /** Application-Layer Protocol Negotiation (ALPN) protocols supported by * the client. QUIC requires the use of ALPN. */ alpnProtocols: string[]; /** A list of root certificates that will be used in addition to the * default root certificates to verify the peer's certificate. * * Must be in PEM format. */ caCerts?: string[]; /** * If no endpoint is provided, a new one is bound on an ephemeral port. */ endpoint?: QuicEndpoint; /** * Attempt to convert the connection into 0-RTT. Any data sent before * the TLS handshake completes is vulnerable to replay attacks. * @default {false} */ zeroRtt?: ZRTT; } /** * **UNSTABLE**: New API, yet to be vetted. * @experimental * @category Network */ export interface QuicServerTransportOptions extends QuicTransportOptions { /** * Preferred IPv4 address to be communicated to the client during * handshaking. If the client is able to reach this address it will switch * to it. * @default {undefined} */ preferredAddressV4?: string; /** * Preferred IPv6 address to be communicated to the client during * handshaking. If the client is able to reach this address it will switch * to it. * @default {undefined} */ preferredAddressV6?: string; } /** * **UNSTABLE**: New API, yet to be vetted. * @experimental * @category Network */ export interface QuicListenOptions extends QuicServerTransportOptions { /** Application-Layer Protocol Negotiation (ALPN) protocols to announce to * the client. QUIC requires the use of ALPN. */ alpnProtocols: string[]; /** Server private key in PEM format */ key: string; /** Cert chain in PEM format */ cert: string; } /** * **UNSTABLE**: New API, yet to be vetted. * @experimental * @category Network */ export interface QuicAcceptOptions extends QuicServerTransportOptions { /** Application-Layer Protocol Negotiation (ALPN) protocols to announce to * the client. QUIC requires the use of ALPN. */ alpnProtocols?: string[]; /** * Convert this connection into 0.5-RTT at the cost of weakened security, as * 0.5-RTT data may be sent before TLS client authentication has occurred. * @default {false} */ zeroRtt?: ZRTT; } /** * **UNSTABLE**: New API, yet to be vetted. * @experimental * @category Network */ export interface QuicCloseInfo { /** A number representing the error code for the error. */ closeCode: number; /** A string representing the reason for closing the connection. */ reason: string; } /** * **UNSTABLE**: New API, yet to be vetted. * * @experimental * @category Network */ export interface QuicSendStreamOptions { /** Indicates the send priority of this stream relative to other streams for * which the value has been set. * @default {0} */ sendOrder?: number; /** Wait until there is sufficient flow credit to create the stream. * @default {false} */ waitUntilAvailable?: boolean; } /** * **UNSTABLE**: New API, yet to be vetted. * @experimental * @category Network */ export class QuicEndpoint { /** * Create a QUIC endpoint which may be used for client or server connections. * * Requires `allow-net` permission. * * @experimental * @tags allow-net * @category Network */ constructor(options?: QuicEndpointOptions); /** Return the address of the `QuicListener`. */ readonly addr: NetAddr; /** * **UNSTABLE**: New API, yet to be vetted. * Listen announces on the local transport address over QUIC. * * @experimental * @category Network */ listen(options: QuicListenOptions): QuicListener; /** * Closes the endpoint. All associated connections will be closed and incoming * connections will be rejected. */ close(info?: QuicCloseInfo): void; } /** * **UNSTABLE**: New API, yet to be vetted. * Specialized listener that accepts QUIC connections. * * @experimental * @category Network */ export interface QuicListener extends AsyncIterable { /** Waits for and resolves to the next incoming connection. */ incoming(): Promise; /** Wait for the next incoming connection and accepts it. */ accept(): Promise; /** Stops the listener. This does not close the endpoint. */ stop(): void; [Symbol.asyncIterator](): AsyncIterableIterator; /** The endpoint for this listener. */ readonly endpoint: QuicEndpoint; } /** * **UNSTABLE**: New API, yet to be vetted. * An incoming connection for which the server has not yet begun its part of * the handshake. * * @experimental * @category Network */ export interface QuicIncoming { /** * The local IP address which was used when the peer established the * connection. */ readonly localIp: string; /** * The peer’s UDP address. */ readonly remoteAddr: NetAddr; /** * Whether the socket address that is initiating this connection has proven * that they can receive traffic. */ readonly remoteAddressValidated: boolean; /** * Accept this incoming connection. */ accept( options?: QuicAcceptOptions, ): ZRTT extends true ? QuicConn : Promise; /** * Refuse this incoming connection. */ refuse(): void; /** * Ignore this incoming connection attempt, not sending any packet in response. */ ignore(): void; } /** * **UNSTABLE**: New API, yet to be vetted. * * @experimental * @category Network */ export interface QuicConn { /** Close closes the listener. Any pending accept promises will be rejected * with errors. */ close(info?: QuicCloseInfo): void; /** Opens and returns a bidirectional stream. */ createBidirectionalStream( options?: QuicSendStreamOptions, ): Promise; /** Opens and returns a unidirectional stream. */ createUnidirectionalStream( options?: QuicSendStreamOptions, ): Promise; /** Send a datagram. The provided data cannot be larger than * `maxDatagramSize`. */ sendDatagram(data: Uint8Array): Promise; /** Receive a datagram. */ readDatagram(): Promise>; /** The endpoint for this connection. */ readonly endpoint: QuicEndpoint; /** Returns a promise that resolves when the TLS handshake is complete. */ readonly handshake: Promise; /** Return the remote address for the connection. Clients may change * addresses at will, for example when switching to a cellular internet * connection. */ readonly remoteAddr: NetAddr; /** * The negotiated ALPN protocol, if provided. Only available after the * handshake is complete. */ readonly protocol: string | undefined; /** The negotiated server name. Only available on the server after the * handshake is complete. */ readonly serverName: string | undefined; /** Returns a promise that resolves when the connection is closed. */ readonly closed: Promise; /** A stream of bidirectional streams opened by the peer. */ readonly incomingBidirectionalStreams: ReadableStream< QuicBidirectionalStream >; /** A stream of unidirectional streams opened by the peer. */ readonly incomingUnidirectionalStreams: ReadableStream; /** Returns the datagram stream for sending and receiving datagrams. */ readonly maxDatagramSize: number; } /** * **UNSTABLE**: New API, yet to be vetted. * * @experimental * @category Network */ export interface QuicBidirectionalStream { /** Returns a QuicReceiveStream instance that can be used to read incoming data. */ readonly readable: QuicReceiveStream; /** Returns a QuicSendStream instance that can be used to write outgoing data. */ readonly writable: QuicSendStream; } /** * **UNSTABLE**: New API, yet to be vetted. * * @experimental * @category Network */ export interface QuicSendStream extends WritableStream> { /** Indicates the send priority of this stream relative to other streams for * which the value has been set. */ sendOrder: number; /** * 62-bit stream ID, unique within this connection. */ readonly id: bigint; } /** * **UNSTABLE**: New API, yet to be vetted. * * @experimental * @category Network */ export interface QuicReceiveStream extends ReadableStream> { /** * 62-bit stream ID, unique within this connection. */ readonly id: bigint; } /** * **UNSTABLE**: New API, yet to be vetted. * Establishes a secure connection over QUIC using a hostname and port. The * cert file is optional and if not included Mozilla's root certificates will * be used. See also https://github.com/ctz/webpki-roots for specifics. * * ```ts * const caCert = await Deno.readTextFile("./certs/my_custom_root_CA.pem"); * const conn1 = await Deno.connectQuic({ hostname: "example.com", port: 443, alpnProtocols: ["h3"] }); * const conn2 = await Deno.connectQuic({ caCerts: [caCert], hostname: "example.com", port: 443, alpnProtocols: ["h3"] }); * ``` * * If an endpoint is shared among many connections, 0-RTT can be enabled. * When 0-RTT is successful, a QuicConn will be synchronously returned * and data can be sent immediately with it. **Any data sent before the * TLS handshake completes is vulnerable to replay attacks.** * * Requires `allow-net` permission. * * @experimental * @tags allow-net * @category Network */ export function connectQuic( options: ConnectQuicOptions, ): ZRTT extends true ? (QuicConn | Promise) : Promise; /** * **UNSTABLE**: New API, yet to be vetted. * * Upgrade a QUIC connection into a WebTransport instance. * * @category Network * @experimental */ export function upgradeWebTransport( conn: QuicConn, ): Promise; export {}; // only export exports } declare namespace Deno { export {}; // stop default export type behavior /** * @category Bundler * @experimental */ export namespace bundle { /** * The target platform of the bundle. * @category Bundler * @experimental */ export type Platform = "browser" | "deno"; /** * The output format of the bundle. * @category Bundler * @experimental */ export type Format = "esm" | "cjs" | "iife"; /** * The source map type of the bundle. * @category Bundler * @experimental */ export type SourceMapType = "linked" | "inline" | "external"; /** * How to handle packages. * * - `bundle`: packages are inlined into the bundle. * - `external`: packages are excluded from the bundle, and treated as external dependencies. * @category Bundler * @experimental */ export type PackageHandling = "bundle" | "external"; /** * Options for the bundle. * @category Bundler * @experimental */ export interface Options { /** * The entrypoints of the bundle. */ entrypoints: string[]; /** * Output file path. */ outputPath?: string; /** * Output directory path. */ outputDir?: string; /** * External modules to exclude from bundling. */ external?: string[]; /** * Bundle format. */ format?: Format; /** * Whether to minify the output. */ minify?: boolean; /** * Whether to keep function and class names. */ keepNames?: boolean; /** * Whether to enable code splitting. */ codeSplitting?: boolean; /** * Whether to inline imports. */ inlineImports?: boolean; /** * How to handle packages. */ packages?: PackageHandling; /** * Source map configuration. */ sourcemap?: SourceMapType; /** * Target platform. */ platform?: Platform; /** * Whether to write the output to the filesystem. * * @default true if outputDir or outputPath is set, false otherwise */ write?: boolean; } /** * The location of a message. * @category Bundler * @experimental */ export interface MessageLocation { file: string; namespace?: string; line: number; column: number; length: number; suggestion?: string; } /** * A note about a message. * @category Bundler * @experimental */ export interface MessageNote { text: string; location?: MessageLocation; } /** * A message emitted from the bundler. * @category Bundler * @experimental */ export interface Message { text: string; location?: MessageLocation; notes?: MessageNote[]; } /** * An output file in the bundle. * @category Bundler * @experimental */ export interface OutputFile { path: string; contents?: Uint8Array; hash: string; text(): string; } /** * The result of bundling. * @category Bundler * @experimental */ export interface Result { errors: Message[]; warnings: Message[]; success: boolean; outputFiles?: OutputFile[]; } export {}; // only export exports } /** **UNSTABLE**: New API, yet to be vetted. * * Bundle Typescript/Javascript code * @category Bundle * @experimental */ export function bundle( options: Deno.bundle.Options, ): Promise; /** **UNSTABLE**: New API, yet to be vetted. * * Creates a presentable WebGPU surface from given window and * display handles. * * The parameters correspond to the table below: * * | system | winHandle | displayHandle | * | ----------------- | ------------- | --------------- | * | "cocoa" (macOS) | - | `NSView*` | * | "win32" (Windows) | `HWND` | `HINSTANCE` | * | "x11" (Linux) | Xlib `Window` | Xlib `Display*` | * | "wayland" (Linux) | `wl_surface*` | `wl_display*` | * * @category GPU * @experimental */ export class UnsafeWindowSurface { constructor( options: { system: "cocoa" | "win32" | "x11" | "wayland"; windowHandle: Deno.PointerValue; displayHandle: Deno.PointerValue; width: number; height: number; }, ); getContext(context: "webgpu"): GPUCanvasContext; present(): void; /** * This method should be invoked when the size of the window changes. */ resize(width: number, height: number): void; } /** **UNSTABLE**: New API, yet to be vetted. * * Represents membership of a IPv4 multicast group. * * @category Network * @experimental */ export interface MulticastV4Membership { /** Leaves the multicast group. */ leave: () => Promise; /** Sets the multicast loopback option. If enabled, multicast packets will be looped back to the local socket. */ setLoopback: (loopback: boolean) => Promise; /** Sets the time-to-live of outgoing multicast packets for this socket. */ setTTL: (ttl: number) => Promise; } /** **UNSTABLE**: New API, yet to be vetted. * * Represents membership of a IPv6 multicast group. * * @category Network * @experimental */ export interface MulticastV6Membership { /** Leaves the multicast group. */ leave: () => Promise; /** Sets the multicast loopback option. If enabled, multicast packets will be looped back to the local socket. */ setLoopback: (loopback: boolean) => Promise; } /** **UNSTABLE**: New API, yet to be vetted. * * A generic transport listener for message-oriented protocols. * * @category Network * @experimental */ export interface DatagramConn extends AsyncIterable<[Uint8Array, Addr]> { /** Joins an IPv4 multicast group. */ joinMulticastV4( address: string, networkInterface: string, ): Promise; /** Joins an IPv6 multicast group. */ joinMulticastV6( address: string, networkInterface: number, ): Promise; /** Waits for and resolves to the next message to the instance. * * Messages are received in the format of a tuple containing the data array * and the address information. */ receive(p?: Uint8Array): Promise<[Uint8Array, Addr]>; /** Sends a message to the target via the connection. The method resolves * with the number of bytes sent. */ send(p: Uint8Array, addr: Addr): Promise; /** Close closes the socket. Any pending message promises will be rejected * with errors. */ close(): void; /** Return the address of the instance. */ readonly addr: Addr; [Symbol.asyncIterator](): AsyncIterableIterator< [Uint8Array, Addr] >; } /** * @category Network * @experimental */ export interface TcpListenOptions extends ListenOptions { /** When `true` the SO_REUSEPORT flag will be set on the listener. This * allows multiple processes to listen on the same address and port. * * On Linux this will cause the kernel to distribute incoming connections * across the different processes that are listening on the same address and * port. * * This flag is only supported on Linux. It is silently ignored on other * platforms. * * @default {false} */ reusePort?: boolean; } /** **UNSTABLE**: New API, yet to be vetted. * * Unstable options which can be set when opening a datagram listener via * {@linkcode Deno.listenDatagram}. * * @category Network * @experimental */ export interface UdpListenOptions extends ListenOptions { /** When `true` the specified address will be reused, even if another * process has already bound a socket on it. This effectively steals the * socket from the listener. * * @default {false} */ reuseAddress?: boolean; /** When `true`, sent multicast packets will be looped back to the local socket. * * @default {false} */ loopback?: boolean; } /** **UNSTABLE**: New API, yet to be vetted. * * Listen announces on the local transport address. * * ```ts * const listener1 = Deno.listenDatagram({ * port: 80, * transport: "udp" * }); * const listener2 = Deno.listenDatagram({ * hostname: "golang.org", * port: 80, * transport: "udp" * }); * ``` * * Requires `allow-net` permission. * * @tags allow-net * @category Network * @experimental */ export function listenDatagram( options: UdpListenOptions & { transport: "udp" }, ): DatagramConn; /** **UNSTABLE**: New API, yet to be vetted. * * Listen announces on the local transport address. * * ```ts * const listener = Deno.listenDatagram({ * path: "/foo/bar.sock", * transport: "unixpacket" * }); * ``` * * Requires `allow-read` and `allow-write` permission. * * @tags allow-read, allow-write * @category Network * @experimental */ export function listenDatagram( options: UnixListenOptions & { transport: "unixpacket" }, ): DatagramConn; /** **UNSTABLE**: New API, yet to be vetted. * * Open a new {@linkcode Deno.Kv} connection to persist data. * * When a path is provided, the database will be persisted to disk at that * path. Read and write access to the file is required. * * When no path is provided, the database will be opened in a default path for * the current script. This location is persistent across script runs and is * keyed on the origin storage key (the same key that is used to determine * `localStorage` persistence). More information about the origin storage key * can be found in the Deno Manual. * * @tags allow-read, allow-write * @category Cloud * @experimental */ export function openKv(path?: string): Promise; /** **UNSTABLE**: New API, yet to be vetted. * * CronScheduleExpression is used as the type of `minute`, `hour`, * `dayOfMonth`, `month`, and `dayOfWeek` in {@linkcode CronSchedule}. * @category Cloud * @experimental */ export type CronScheduleExpression = number | { exact: number | number[] } | { start?: number; end?: number; every?: number; }; /** **UNSTABLE**: New API, yet to be vetted. * * CronSchedule is the interface used for JSON format * cron `schedule`. * @category Cloud * @experimental */ export interface CronSchedule { minute?: CronScheduleExpression; hour?: CronScheduleExpression; dayOfMonth?: CronScheduleExpression; month?: CronScheduleExpression; dayOfWeek?: CronScheduleExpression; } /** **UNSTABLE**: New API, yet to be vetted. * * Create a cron job that will periodically execute the provided handler * callback based on the specified schedule. * * ```ts * Deno.cron("sample cron", "20 * * * *", () => { * console.log("cron job executed"); * }); * ``` * * ```ts * Deno.cron("sample cron", { hour: { every: 6 } }, () => { * console.log("cron job executed"); * }); * ``` * * `schedule` can be a string in the Unix cron format or in JSON format * as specified by interface {@linkcode CronSchedule}, where time is specified * using UTC time zone. * * @category Cloud * @experimental */ export function cron( name: string, schedule: string | CronSchedule, handler: () => Promise | void, ): Promise; /** **UNSTABLE**: New API, yet to be vetted. * * Create a cron job that will periodically execute the provided handler * callback based on the specified schedule. * * ```ts * Deno.cron("sample cron", "20 * * * *", { * backoffSchedule: [10, 20] * }, () => { * console.log("cron job executed"); * }); * ``` * * `schedule` can be a string in the Unix cron format or in JSON format * as specified by interface {@linkcode CronSchedule}, where time is specified * using UTC time zone. * * `backoffSchedule` option can be used to specify the retry policy for failed * executions. Each element in the array represents the number of milliseconds * to wait before retrying the execution. For example, `[1000, 5000, 10000]` * means that a failed execution will be retried at most 3 times, with 1 * second, 5 seconds, and 10 seconds delay between each retry. There is a * limit of 5 retries and a maximum interval of 1 hour (3600000 milliseconds). * * @category Cloud * @experimental */ export function cron( name: string, schedule: string | CronSchedule, options: { backoffSchedule?: number[]; signal?: AbortSignal }, handler: () => Promise | void, ): Promise; /** **UNSTABLE**: New API, yet to be vetted. * * A key to be persisted in a {@linkcode Deno.Kv}. A key is a sequence * of {@linkcode Deno.KvKeyPart}s. * * Keys are ordered lexicographically by their parts. The first part is the * most significant, and the last part is the least significant. The order of * the parts is determined by both the type and the value of the part. The * relative significance of the types can be found in documentation for the * {@linkcode Deno.KvKeyPart} type. * * Keys have a maximum size of 2048 bytes serialized. If the size of the key * exceeds this limit, an error will be thrown on the operation that this key * was passed to. * * @category Cloud * @experimental */ export type KvKey = readonly KvKeyPart[]; /** **UNSTABLE**: New API, yet to be vetted. * * A single part of a {@linkcode Deno.KvKey}. Parts are ordered * lexicographically, first by their type, and within a given type by their * value. * * The ordering of types is as follows: * * 1. `Uint8Array` * 2. `string` * 3. `number` * 4. `bigint` * 5. `boolean` * * Within a given type, the ordering is as follows: * * - `Uint8Array` is ordered by the byte ordering of the array * - `string` is ordered by the byte ordering of the UTF-8 encoding of the * string * - `number` is ordered following this pattern: `-NaN` * < `-Infinity` < `-100.0` < `-1.0` < -`0.5` < `-0.0` < `0.0` < `0.5` * < `1.0` < `100.0` < `Infinity` < `NaN` * - `bigint` is ordered by mathematical ordering, with the largest negative * number being the least first value, and the largest positive number * being the last value * - `boolean` is ordered by `false` < `true` * * This means that the part `1.0` (a number) is ordered before the part `2.0` * (also a number), but is greater than the part `0n` (a bigint), because * `1.0` is a number and `0n` is a bigint, and type ordering has precedence * over the ordering of values within a type. * * @category Cloud * @experimental */ export type KvKeyPart = | Uint8Array | string | number | bigint | boolean | symbol; /** **UNSTABLE**: New API, yet to be vetted. * * Consistency level of a KV operation. * * - `strong` - This operation must be strongly-consistent. * - `eventual` - Eventually-consistent behavior is allowed. * * @category Cloud * @experimental */ export type KvConsistencyLevel = "strong" | "eventual"; /** **UNSTABLE**: New API, yet to be vetted. * * A selector that selects the range of data returned by a list operation on a * {@linkcode Deno.Kv}. * * The selector can either be a prefix selector or a range selector. A prefix * selector selects all keys that start with the given prefix (optionally * starting at a given key). A range selector selects all keys that are * lexicographically between the given start and end keys. * * @category Cloud * @experimental */ export type KvListSelector = | { prefix: KvKey } | { prefix: KvKey; start: KvKey } | { prefix: KvKey; end: KvKey } | { start: KvKey; end: KvKey }; /** **UNSTABLE**: New API, yet to be vetted. * * A mutation to a key in a {@linkcode Deno.Kv}. A mutation is a * combination of a key, a value, and a type. The type determines how the * mutation is applied to the key. * * - `set` - Sets the value of the key to the given value, overwriting any * existing value. Optionally an `expireIn` option can be specified to * set a time-to-live (TTL) for the key. The TTL is specified in * milliseconds, and the key will be deleted from the database at earliest * after the specified number of milliseconds have elapsed. Once the * specified duration has passed, the key may still be visible for some * additional time. If the `expireIn` option is not specified, the key will * not expire. * - `delete` - Deletes the key from the database. The mutation is a no-op if * the key does not exist. * - `sum` - Adds the given value to the existing value of the key. Both the * value specified in the mutation, and any existing value must be of type * `Deno.KvU64`. If the key does not exist, the value is set to the given * value (summed with 0). If the result of the sum overflows an unsigned * 64-bit integer, the result is wrapped around. * - `max` - Sets the value of the key to the maximum of the existing value * and the given value. Both the value specified in the mutation, and any * existing value must be of type `Deno.KvU64`. If the key does not exist, * the value is set to the given value. * - `min` - Sets the value of the key to the minimum of the existing value * and the given value. Both the value specified in the mutation, and any * existing value must be of type `Deno.KvU64`. If the key does not exist, * the value is set to the given value. * * @category Cloud * @experimental */ export type KvMutation = & { key: KvKey } & ( | { type: "set"; value: unknown; expireIn?: number } | { type: "delete" } | { type: "sum"; value: KvU64 } | { type: "max"; value: KvU64 } | { type: "min"; value: KvU64 } ); /** **UNSTABLE**: New API, yet to be vetted. * * An iterator over a range of data entries in a {@linkcode Deno.Kv}. * * The cursor getter returns the cursor that can be used to resume the * iteration from the current position in the future. * * @category Cloud * @experimental */ export class KvListIterator implements AsyncIterableIterator> { /** * Returns the cursor of the current position in the iteration. This cursor * can be used to resume the iteration from the current position in the * future by passing it to the `cursor` option of the `list` method. */ get cursor(): string; next(): Promise, undefined>>; [Symbol.asyncIterator](): AsyncIterableIterator>; } /** **UNSTABLE**: New API, yet to be vetted. * * A versioned pair of key and value in a {@linkcode Deno.Kv}. * * The `versionstamp` is a string that represents the current version of the * key-value pair. It can be used to perform atomic operations on the KV store * by passing it to the `check` method of a {@linkcode Deno.AtomicOperation}. * * @category Cloud * @experimental */ export interface KvEntry { key: KvKey; value: T; versionstamp: string; } /** * **UNSTABLE**: New API, yet to be vetted. * * An optional versioned pair of key and value in a {@linkcode Deno.Kv}. * * This is the same as a {@linkcode KvEntry}, but the `value` and `versionstamp` * fields may be `null` if no value exists for the given key in the KV store. * * @category Cloud * @experimental */ export type KvEntryMaybe = KvEntry | { key: KvKey; value: null; versionstamp: null; }; /** **UNSTABLE**: New API, yet to be vetted. * * Options for listing key-value pairs in a {@linkcode Deno.Kv}. * * @category Cloud * @experimental */ export interface KvListOptions { /** * The maximum number of key-value pairs to return. If not specified, all * matching key-value pairs will be returned. */ limit?: number; /** * The cursor to resume the iteration from. If not specified, the iteration * will start from the beginning. */ cursor?: string; /** * Whether to reverse the order of the returned key-value pairs. If not * specified, the order will be ascending from the start of the range as per * the lexicographical ordering of the keys. If `true`, the order will be * descending from the end of the range. * * The default value is `false`. */ reverse?: boolean; /** * The consistency level of the list operation. The default consistency * level is "strong". Some use cases can benefit from using a weaker * consistency level. For more information on consistency levels, see the * documentation for {@linkcode Deno.KvConsistencyLevel}. * * List operations are performed in batches (in sizes specified by the * `batchSize` option). The consistency level of the list operation is * applied to each batch individually. This means that while each batch is * guaranteed to be consistent within itself, the entire list operation may * not be consistent across batches because a mutation may be applied to a * key-value pair between batches, in a batch that has already been returned * by the list operation. */ consistency?: KvConsistencyLevel; /** * The size of the batches in which the list operation is performed. Larger * or smaller batch sizes may positively or negatively affect the * performance of a list operation depending on the specific use case and * iteration behavior. Slow iterating queries may benefit from using a * smaller batch size for increased overall consistency, while fast * iterating queries may benefit from using a larger batch size for better * performance. * * The default batch size is equal to the `limit` option, or 100 if this is * unset. The maximum value for this option is 500. Larger values will be * clamped. */ batchSize?: number; } /** * @category Cloud * @experimental */ export interface KvCommitResult { ok: true; /** The versionstamp of the value committed to KV. */ versionstamp: string; } /** * @category Cloud * @experimental */ export interface KvCommitError { ok: false; } /** **UNSTABLE**: New API, yet to be vetted. * * A check to perform as part of a {@linkcode Deno.AtomicOperation}. The check * will fail if the versionstamp for the key-value pair in the KV store does * not match the given versionstamp. A check with a `null` versionstamp checks * that the key-value pair does not currently exist in the KV store. * * @category Cloud * @experimental */ export interface AtomicCheck { key: KvKey; versionstamp: string | null; } /** **UNSTABLE**: New API, yet to be vetted. * * An operation on a {@linkcode Deno.Kv} that can be performed * atomically. Atomic operations do not auto-commit, and must be committed * explicitly by calling the `commit` method. * * Atomic operations can be used to perform multiple mutations on the KV store * in a single atomic transaction. They can also be used to perform * conditional mutations by specifying one or more * {@linkcode Deno.AtomicCheck}s that ensure that a mutation is only performed * if the key-value pair in the KV has a specific versionstamp. If any of the * checks fail, the entire operation will fail and no mutations will be made. * * The ordering of mutations is guaranteed to be the same as the ordering of * the mutations specified in the operation. Checks are performed before any * mutations are performed. The ordering of checks is unobservable. * * Atomic operations can be used to implement optimistic locking, where a * mutation is only performed if the key-value pair in the KV store has not * been modified since the last read. This can be done by specifying a check * that ensures that the versionstamp of the key-value pair matches the * versionstamp that was read. If the check fails, the mutation will not be * performed and the operation will fail. One can then retry the read-modify- * write operation in a loop until it succeeds. * * The `commit` method of an atomic operation returns a value indicating * whether checks passed and mutations were performed. If the operation failed * because of a failed check, the return value will be a * {@linkcode Deno.KvCommitError} with an `ok: false` property. If the * operation failed for any other reason (storage error, invalid value, etc.), * an exception will be thrown. If the operation succeeded, the return value * will be a {@linkcode Deno.KvCommitResult} object with a `ok: true` property * and the versionstamp of the value committed to KV. * * @category Cloud * @experimental */ export class AtomicOperation { /** * Add to the operation a check that ensures that the versionstamp of the * key-value pair in the KV store matches the given versionstamp. If the * check fails, the entire operation will fail and no mutations will be * performed during the commit. */ check(...checks: AtomicCheck[]): this; /** * Add to the operation a mutation that performs the specified mutation on * the specified key if all checks pass during the commit. The types and * semantics of all available mutations are described in the documentation * for {@linkcode Deno.KvMutation}. */ mutate(...mutations: KvMutation[]): this; /** * Shortcut for creating a `sum` mutation. This method wraps `n` in a * {@linkcode Deno.KvU64}, so the value of `n` must be in the range * `[0, 2^64-1]`. */ sum(key: KvKey, n: bigint): this; /** * Shortcut for creating a `min` mutation. This method wraps `n` in a * {@linkcode Deno.KvU64}, so the value of `n` must be in the range * `[0, 2^64-1]`. */ min(key: KvKey, n: bigint): this; /** * Shortcut for creating a `max` mutation. This method wraps `n` in a * {@linkcode Deno.KvU64}, so the value of `n` must be in the range * `[0, 2^64-1]`. */ max(key: KvKey, n: bigint): this; /** * Add to the operation a mutation that sets the value of the specified key * to the specified value if all checks pass during the commit. * * Optionally an `expireIn` option can be specified to set a time-to-live * (TTL) for the key. The TTL is specified in milliseconds, and the key will * be deleted from the database at earliest after the specified number of * milliseconds have elapsed. Once the specified duration has passed, the * key may still be visible for some additional time. If the `expireIn` * option is not specified, the key will not expire. */ set(key: KvKey, value: unknown, options?: { expireIn?: number }): this; /** * Add to the operation a mutation that deletes the specified key if all * checks pass during the commit. */ delete(key: KvKey): this; /** * Add to the operation a mutation that enqueues a value into the queue * if all checks pass during the commit. */ enqueue( value: unknown, options?: { delay?: number; keysIfUndelivered?: KvKey[]; backoffSchedule?: number[]; }, ): this; /** * Commit the operation to the KV store. Returns a value indicating whether * checks passed and mutations were performed. If the operation failed * because of a failed check, the return value will be a {@linkcode * Deno.KvCommitError} with an `ok: false` property. If the operation failed * for any other reason (storage error, invalid value, etc.), an exception * will be thrown. If the operation succeeded, the return value will be a * {@linkcode Deno.KvCommitResult} object with a `ok: true` property and the * versionstamp of the value committed to KV. * * If the commit returns `ok: false`, one may create a new atomic operation * with updated checks and mutations and attempt to commit it again. See the * note on optimistic locking in the documentation for * {@linkcode Deno.AtomicOperation}. */ commit(): Promise; } /** **UNSTABLE**: New API, yet to be vetted. * * A key-value database that can be used to store and retrieve data. * * Data is stored as key-value pairs, where the key is a {@linkcode Deno.KvKey} * and the value is an arbitrary structured-serializable JavaScript value. * Keys are ordered lexicographically as described in the documentation for * {@linkcode Deno.KvKey}. Keys are unique within a database, and the last * value set for a given key is the one that is returned when reading the * key. Keys can be deleted from the database, in which case they will no * longer be returned when reading keys. * * Values can be any structured-serializable JavaScript value (objects, * arrays, strings, numbers, etc.). The special value {@linkcode Deno.KvU64} * can be used to store 64-bit unsigned integers in the database. This special * value can not be nested within other objects or arrays. In addition to the * regular database mutation operations, the unsigned 64-bit integer value * also supports `sum`, `max`, and `min` mutations. * * Keys are versioned on write by assigning the key an ever-increasing * "versionstamp". The versionstamp represents the version of a key-value pair * in the database at some point in time, and can be used to perform * transactional operations on the database without requiring any locking. * This is enabled by atomic operations, which can have conditions that ensure * that the operation only succeeds if the versionstamp of the key-value pair * matches an expected versionstamp. * * Keys have a maximum length of 2048 bytes after serialization. Values have a * maximum length of 64 KiB after serialization. Serialization of both keys * and values is somewhat opaque, but one can usually assume that the * serialization of any value is about the same length as the resulting string * of a JSON serialization of that same value. If theses limits are exceeded, * an exception will be thrown. * * @category Cloud * @experimental */ export class Kv implements Disposable { /** * Retrieve the value and versionstamp for the given key from the database * in the form of a {@linkcode Deno.KvEntryMaybe}. If no value exists for * the key, the returned entry will have a `null` value and versionstamp. * * ```ts * const db = await Deno.openKv(); * const result = await db.get(["foo"]); * result.key; // ["foo"] * result.value; // "bar" * result.versionstamp; // "00000000000000010000" * ``` * * The `consistency` option can be used to specify the consistency level * for the read operation. The default consistency level is "strong". Some * use cases can benefit from using a weaker consistency level. For more * information on consistency levels, see the documentation for * {@linkcode Deno.KvConsistencyLevel}. */ get( key: KvKey, options?: { consistency?: KvConsistencyLevel }, ): Promise>; /** * Retrieve multiple values and versionstamps from the database in the form * of an array of {@linkcode Deno.KvEntryMaybe} objects. The returned array * will have the same length as the `keys` array, and the entries will be in * the same order as the keys. If no value exists for a given key, the * returned entry will have a `null` value and versionstamp. * * ```ts * const db = await Deno.openKv(); * const result = await db.getMany([["foo"], ["baz"]]); * result[0].key; // ["foo"] * result[0].value; // "bar" * result[0].versionstamp; // "00000000000000010000" * result[1].key; // ["baz"] * result[1].value; // null * result[1].versionstamp; // null * ``` * * The `consistency` option can be used to specify the consistency level * for the read operation. The default consistency level is "strong". Some * use cases can benefit from using a weaker consistency level. For more * information on consistency levels, see the documentation for * {@linkcode Deno.KvConsistencyLevel}. */ getMany( keys: readonly [...{ [K in keyof T]: KvKey }], options?: { consistency?: KvConsistencyLevel }, ): Promise<{ [K in keyof T]: KvEntryMaybe }>; /** * Set the value for the given key in the database. If a value already * exists for the key, it will be overwritten. * * ```ts * const db = await Deno.openKv(); * await db.set(["foo"], "bar"); * ``` * * Optionally an `expireIn` option can be specified to set a time-to-live * (TTL) for the key. The TTL is specified in milliseconds, and the key will * be deleted from the database at earliest after the specified number of * milliseconds have elapsed. Once the specified duration has passed, the * key may still be visible for some additional time. If the `expireIn` * option is not specified, the key will not expire. */ set( key: KvKey, value: unknown, options?: { expireIn?: number }, ): Promise; /** * Delete the value for the given key from the database. If no value exists * for the key, this operation is a no-op. * * ```ts * const db = await Deno.openKv(); * await db.delete(["foo"]); * ``` */ delete(key: KvKey): Promise; /** * Retrieve a list of keys in the database. The returned list is an * {@linkcode Deno.KvListIterator} which can be used to iterate over the * entries in the database. * * Each list operation must specify a selector which is used to specify the * range of keys to return. The selector can either be a prefix selector, or * a range selector: * * - A prefix selector selects all keys that start with the given prefix of * key parts. For example, the selector `["users"]` will select all keys * that start with the prefix `["users"]`, such as `["users", "alice"]` * and `["users", "bob"]`. Note that you can not partially match a key * part, so the selector `["users", "a"]` will not match the key * `["users", "alice"]`. A prefix selector may specify a `start` key that * is used to skip over keys that are lexicographically less than the * start key. * - A range selector selects all keys that are lexicographically between * the given start and end keys (including the start, and excluding the * end). For example, the selector `["users", "a"], ["users", "n"]` will * select all keys that start with the prefix `["users"]` and have a * second key part that is lexicographically between `a` and `n`, such as * `["users", "alice"]`, `["users", "bob"]`, and `["users", "mike"]`, but * not `["users", "noa"]` or `["users", "zoe"]`. * * ```ts * const db = await Deno.openKv(); * const entries = db.list({ prefix: ["users"] }); * for await (const entry of entries) { * entry.key; // ["users", "alice"] * entry.value; // { name: "Alice" } * entry.versionstamp; // "00000000000000010000" * } * ``` * * The `options` argument can be used to specify additional options for the * list operation. See the documentation for {@linkcode Deno.KvListOptions} * for more information. */ list( selector: KvListSelector, options?: KvListOptions, ): KvListIterator; /** * Add a value into the database queue to be delivered to the queue * listener via {@linkcode Deno.Kv.listenQueue}. * * ```ts * const db = await Deno.openKv(); * await db.enqueue("bar"); * ``` * * The `delay` option can be used to specify the delay (in milliseconds) * of the value delivery. The default delay is 0, which means immediate * delivery. * * ```ts * const db = await Deno.openKv(); * await db.enqueue("bar", { delay: 60000 }); * ``` * * The `keysIfUndelivered` option can be used to specify the keys to * be set if the value is not successfully delivered to the queue * listener after several attempts. The values are set to the value of * the queued message. * * The `backoffSchedule` option can be used to specify the retry policy for * failed message delivery. Each element in the array represents the number of * milliseconds to wait before retrying the delivery. For example, * `[1000, 5000, 10000]` means that a failed delivery will be retried * at most 3 times, with 1 second, 5 seconds, and 10 seconds delay * between each retry. * * ```ts * const db = await Deno.openKv(); * await db.enqueue("bar", { * keysIfUndelivered: [["foo", "bar"]], * backoffSchedule: [1000, 5000, 10000], * }); * ``` */ enqueue( value: unknown, options?: { delay?: number; keysIfUndelivered?: KvKey[]; backoffSchedule?: number[]; }, ): Promise; /** * Listen for queue values to be delivered from the database queue, which * were enqueued with {@linkcode Deno.Kv.enqueue}. The provided handler * callback is invoked on every dequeued value. A failed callback * invocation is automatically retried multiple times until it succeeds * or until the maximum number of retries is reached. * * ```ts * const db = await Deno.openKv(); * db.listenQueue(async (msg: unknown) => { * await db.set(["foo"], msg); * }); * ``` */ // deno-lint-ignore no-explicit-any listenQueue(handler: (value: any) => Promise | void): Promise; /** * Create a new {@linkcode Deno.AtomicOperation} object which can be used to * perform an atomic transaction on the database. This does not perform any * operations on the database - the atomic transaction must be committed * explicitly using the {@linkcode Deno.AtomicOperation.commit} method once * all checks and mutations have been added to the operation. */ atomic(): AtomicOperation; /** * Watch for changes to the given keys in the database. The returned stream * is a {@linkcode ReadableStream} that emits a new value whenever any of * the watched keys change their versionstamp. The emitted value is an array * of {@linkcode Deno.KvEntryMaybe} objects, with the same length and order * as the `keys` array. If no value exists for a given key, the returned * entry will have a `null` value and versionstamp. * * The returned stream does not return every single intermediate state of * the watched keys, but rather only keeps you up to date with the latest * state of the keys. This means that if a key is modified multiple times * quickly, you may not receive a notification for every single change, but * rather only the latest state of the key. * * ```ts * const db = await Deno.openKv(); * * const stream = db.watch([["foo"], ["bar"]]); * for await (const entries of stream) { * entries[0].key; // ["foo"] * entries[0].value; // "bar" * entries[0].versionstamp; // "00000000000000010000" * entries[1].key; // ["bar"] * entries[1].value; // null * entries[1].versionstamp; // null * } * ``` * * The `options` argument can be used to specify additional options for the * watch operation. The `raw` option can be used to specify whether a new * value should be emitted whenever a mutation occurs on any of the watched * keys (even if the value of the key does not change, such as deleting a * deleted key), or only when entries have observably changed in some way. * When `raw: true` is used, it is possible for the stream to occasionally * emit values even if no mutations have occurred on any of the watched * keys. The default value for this option is `false`. */ watch( keys: readonly [...{ [K in keyof T]: KvKey }], options?: { raw?: boolean }, ): ReadableStream<{ [K in keyof T]: KvEntryMaybe }>; /** * Close the database connection. This will prevent any further operations * from being performed on the database, and interrupt any in-flight * operations immediately. */ close(): void; /** * Get a symbol that represents the versionstamp of the current atomic * operation. This symbol can be used as the last part of a key in * `.set()`, both directly on the `Kv` object and on an `AtomicOperation` * object created from this `Kv` instance. */ commitVersionstamp(): symbol; [Symbol.dispose](): void; } /** **UNSTABLE**: New API, yet to be vetted. * * Wrapper type for 64-bit unsigned integers for use as values in a * {@linkcode Deno.Kv}. * * @category Cloud * @experimental */ export class KvU64 { /** Create a new `KvU64` instance from the given bigint value. If the value * is signed or greater than 64-bits, an error will be thrown. */ constructor(value: bigint); /** The value of this unsigned 64-bit integer, represented as a bigint. */ readonly value: bigint; } /** * A namespace containing runtime APIs available in Jupyter notebooks. * * When accessed outside of Jupyter notebook context an error will be thrown. * * @category Jupyter * @experimental */ export namespace jupyter { /** * @category Jupyter * @experimental */ export interface DisplayOptions { raw?: boolean; update?: boolean; display_id?: string; } /** * @category Jupyter * @experimental */ export interface VegaObject { $schema: string; [key: string]: unknown; } /** * A collection of supported media types and data for Jupyter frontends. * * @category Jupyter * @experimental */ export interface MediaBundle { "text/plain"?: string; "text/html"?: string; "image/svg+xml"?: string; "text/markdown"?: string; "application/javascript"?: string; // Images (per Jupyter spec) must be base64 encoded. We could _allow_ // accepting Uint8Array or ArrayBuffer within `display` calls, however we still // must encode them for jupyter. "image/png"?: string; // WISH: Uint8Array | ArrayBuffer "image/jpeg"?: string; // WISH: Uint8Array | ArrayBuffer "image/gif"?: string; // WISH: Uint8Array | ArrayBuffer "application/pdf"?: string; // WISH: Uint8Array | ArrayBuffer // NOTE: all JSON types must be objects at the top level (no arrays, strings, or other primitives) "application/json"?: object; "application/geo+json"?: object; "application/vdom.v1+json"?: object; "application/vnd.plotly.v1+json"?: object; "application/vnd.vega.v5+json"?: VegaObject; "application/vnd.vegalite.v4+json"?: VegaObject; "application/vnd.vegalite.v5+json"?: VegaObject; // Must support a catch all for custom media types / mimetypes [key: string]: string | object | undefined; } /** * @category Jupyter * @experimental */ export const $display: unique symbol; /** * @category Jupyter * @experimental */ export interface Displayable { [$display]: () => MediaBundle | Promise; } /** * Display function for Jupyter Deno Kernel. * Mimics the behavior of IPython's `display(obj, raw=True)` function to allow * asynchronous displaying of objects in Jupyter. * * @param obj - The object to be displayed * @param options - Display options with a default { raw: true } * @category Jupyter * @experimental */ export function display( obj: unknown, options?: DisplayOptions, ): Promise; /** * Show Markdown in Jupyter frontends with a tagged template function. * * Takes a template string and returns a displayable object for Jupyter frontends. * * @example * Create a Markdown view. * * ```typescript * const { md } = Deno.jupyter; * md`# Notebooks in TypeScript via Deno ![Deno logo](https://github.com/denoland.png?size=32) * * * TypeScript ${Deno.version.typescript} * * V8 ${Deno.version.v8} * * Deno ${Deno.version.deno} * * Interactive compute with Jupyter _built into Deno_! * ` * ``` * * @category Jupyter * @experimental */ export function md( strings: TemplateStringsArray, ...values: unknown[] ): Displayable; /** * Show HTML in Jupyter frontends with a tagged template function. * * Takes a template string and returns a displayable object for Jupyter frontends. * * @example * Create an HTML view. * ```typescript * const { html } = Deno.jupyter; * html`

Hello, world!

` * ``` * * @category Jupyter * @experimental */ export function html( strings: TemplateStringsArray, ...values: unknown[] ): Displayable; /** * SVG Tagged Template Function. * * Takes a template string and returns a displayable object for Jupyter frontends. * * Example usage: * * svg` * * ` * * @category Jupyter * @experimental */ export function svg( strings: TemplateStringsArray, ...values: unknown[] ): Displayable; /** * Display a JPG or PNG image. * * ``` * Deno.jupyter.image("./cat.jpg"); * Deno.jupyter.image("./dog.png"); * ``` * * @category Jupyter * @experimental */ export function image(path: string): Displayable; /** * Display a JPG or PNG image. * * ``` * const img = Deno.readFileSync("./cat.jpg"); * Deno.jupyter.image(img); * ``` * * @category Jupyter * @experimental */ export function image(data: Uint8Array): Displayable; /** * Format an object for displaying in Deno * * @param obj - The object to be displayed * @returns Promise * * @category Jupyter * @experimental */ export function format(obj: unknown): Promise; /** * Broadcast a message on IO pub channel. * * ``` * await Deno.jupyter.broadcast("display_data", { * data: { "text/html": "Processing." }, * metadata: {}, * transient: { display_id: "progress" } * }); * * await new Promise((resolve) => setTimeout(resolve, 500)); * * await Deno.jupyter.broadcast("update_display_data", { * data: { "text/html": "Processing.." }, * metadata: {}, * transient: { display_id: "progress" } * }); * ``` * * @category Jupyter * @experimental */ export function broadcast( msgType: string, content: Record, extra?: { metadata?: Record; buffers?: Uint8Array[]; }, ): Promise; export {}; // only export exports } /** * @category Linter * @experimental */ export namespace lint { /** * @category Linter * @experimental */ export type Range = [number, number]; /** * @category Linter * @experimental */ export interface Fix { range: Range; text?: string; } /** * @category Linter * @experimental */ export interface Fixer { insertTextAfter(node: Node, text: string): Fix; insertTextAfterRange(range: Range, text: string): Fix; insertTextBefore(node: Node, text: string): Fix; insertTextBeforeRange(range: Range, text: string): Fix; remove(node: Node): Fix; removeRange(range: Range): Fix; replaceText(node: Node, text: string): Fix; replaceTextRange(range: Range, text: string): Fix; } /** * @category Linter * @experimental */ export interface ReportData { node?: Node; range?: Range; message: string; hint?: string; fix?(fixer: Fixer): Fix | Iterable; } /** * @category Linter * @experimental */ export interface SourceCode { /** * Get the source test of a node. Omit `node` to get the * full source code. */ getText(node?: Node): string; /** * Returns array of ancestors of the current node, excluding the * current node. */ getAncestors(node: Node): Node[]; /** * Get all comments inside the source. */ getAllComments(): Array; /** * Get leading comments before a node. */ getCommentsBefore(node: Node): Array; /** * Get trailing comments after a node. */ getCommentsAfter(node: Node): Array; /** * Get comments inside a node. */ getCommentsInside(node: Node): Array; /** * Get the full source code. */ text: string; /** * Get the root node of the file. It's always the `Program` node. */ ast: Program; } /** * @category Linter * @experimental */ export interface RuleContext { /** * The running rule id: `/` */ id: string; /** * Name of the file that's currently being linted. */ filename: string; /** * Helper methods for working with the raw source code. */ sourceCode: SourceCode; /** * Report a lint error. */ report(data: ReportData): void; /** * @deprecated Use `ctx.filename` instead. */ getFilename(): string; /** * @deprecated Use `ctx.sourceCode` instead. */ getSourceCode(): SourceCode; } /** * @category Linter * @experimental */ export type LintVisitor = & { [P in Node["type"]]?: (node: Extract) => void; } & { [P in Node["type"] as `${P}:exit`]?: ( node: Extract, ) => void; } & // Custom selectors which cannot be typed by us // deno-lint-ignore no-explicit-any Partial<{ [key: string]: (node: any) => void }>; /** * @category Linter * @experimental */ export interface Rule { create(ctx: RuleContext): LintVisitor; destroy?(ctx: RuleContext): void; } /** * In your plugins file do something like * * ```ts * export default { * name: "my-plugin", * rules: { * "no-foo": { * create(ctx) { * return { * VariableDeclaration(node) {} * } * } * } * } * } satisfies Deno.lint.Plugin * ``` * @category Linter * @experimental */ export interface Plugin { name: string; rules: Record; } /** * @category Linter * @experimental */ export interface Diagnostic { id: string; message: string; hint?: string; range: Range; fix?: Fix[]; } /** * This API is useful for testing lint plugins. * * It throws an error if it's not used in `deno test` subcommand. * @category Linter * @experimental */ export function runPlugin( plugin: Plugin, fileName: string, source: string, ): Diagnostic[]; /** * @category Linter * @experimental */ export interface Program { type: "Program"; range: Range; sourceType: "module" | "script"; body: Statement[]; comments: Array; } /** * @category Linter * @experimental */ export interface ImportSpecifier { type: "ImportSpecifier"; range: Range; imported: Identifier | StringLiteral; local: Identifier; importKind: "type" | "value"; parent: ExportAllDeclaration | ExportNamedDeclaration | ImportDeclaration; } /** * @category Linter * @experimental */ export interface ImportDefaultSpecifier { type: "ImportDefaultSpecifier"; range: Range; local: Identifier; parent: ImportDeclaration; } /** * @category Linter * @experimental */ export interface ImportNamespaceSpecifier { type: "ImportNamespaceSpecifier"; range: Range; local: Identifier; parent: ImportDeclaration; } /** * @category Linter * @experimental */ export interface ImportAttribute { type: "ImportAttribute"; range: Range; key: Identifier | Literal; value: Literal; parent: | ExportAllDeclaration | ExportNamedDeclaration | ImportDeclaration | TSImportType; } /** * An import declaration, examples: * @category Linter * @experimental */ export interface ImportDeclaration { type: "ImportDeclaration"; range: Range; importKind: "type" | "value"; source: StringLiteral; specifiers: Array< | ImportDefaultSpecifier | ImportNamespaceSpecifier | ImportSpecifier >; attributes: ImportAttribute[]; parent: Node; } /** * @category Linter * @experimental */ export interface ExportDefaultDeclaration { type: "ExportDefaultDeclaration"; range: Range; declaration: | ClassDeclaration | Expression | FunctionDeclaration | TSDeclareFunction | TSEnumDeclaration | TSInterfaceDeclaration | TSModuleDeclaration | TSTypeAliasDeclaration | VariableDeclaration; exportKind: "type" | "value"; parent: BlockStatement | Program | TSModuleBlock; } /** * @category Linter * @experimental */ export interface ExportNamedDeclaration { type: "ExportNamedDeclaration"; range: Range; exportKind: "type" | "value"; specifiers: ExportSpecifier[]; declaration: | ClassDeclaration | FunctionDeclaration | TSDeclareFunction | TSEnumDeclaration | TSImportEqualsDeclaration | TSInterfaceDeclaration | TSModuleDeclaration | TSTypeAliasDeclaration | VariableDeclaration | null; source: StringLiteral | null; attributes: ImportAttribute[]; parent: BlockStatement | Program | TSModuleBlock; } /** * @category Linter * @experimental */ export interface ExportAllDeclaration { type: "ExportAllDeclaration"; range: Range; exportKind: "type" | "value"; exported: Identifier | null; source: StringLiteral; attributes: ImportAttribute[]; parent: Node; } /** * @category Linter * @experimental */ export interface TSNamespaceExportDeclaration { type: "TSNamespaceExportDeclaration"; range: Range; id: Identifier; parent: Node; } /** * @category Linter * @experimental */ export interface TSImportEqualsDeclaration { type: "TSImportEqualsDeclaration"; range: Range; importKind: "type" | "value"; id: Identifier; moduleReference: Identifier | TSExternalModuleReference | TSQualifiedName; parent: Node; } /** * @category Linter * @experimental */ export interface TSExternalModuleReference { type: "TSExternalModuleReference"; range: Range; expression: StringLiteral; parent: Node; } /** * @category Linter * @experimental */ export interface ExportSpecifier { type: "ExportSpecifier"; range: Range; exportKind: "type" | "value"; exported: Identifier | StringLiteral; local: Identifier | StringLiteral; parent: ExportNamedDeclaration; } /** * Variable declaration. * @category Linter * @experimental */ export interface VariableDeclaration { type: "VariableDeclaration"; range: Range; declare: boolean; kind: "let" | "var" | "const" | "await using" | "using"; declarations: VariableDeclarator[]; parent: Node; } /** * A VariableDeclaration can declare multiple variables. This node * represents a single declaration out of that. * @category Linter * @experimental */ export interface VariableDeclarator { type: "VariableDeclarator"; range: Range; id: ArrayPattern | ObjectPattern | Identifier; init: Expression | null; definite: boolean; parent: VariableDeclaration; } /** * Function/Method parameter * @category Linter * @experimental */ export type Parameter = | ArrayPattern | AssignmentPattern | Identifier | ObjectPattern | RestElement | TSParameterProperty; /** * TypeScript accessibility modifiers used in classes * @category Linter * @experimental */ export type Accessibility = "private" | "protected" | "public"; /** * Declares a function in the current scope * @category Linter * @experimental */ export interface FunctionDeclaration { type: "FunctionDeclaration"; range: Range; declare: boolean; async: boolean; generator: boolean; id: Identifier | null; typeParameters: TSTypeParameterDeclaration | undefined; returnType: TSTypeAnnotation | undefined; body: BlockStatement | null; params: Parameter[]; parent: | BlockStatement | ExportDefaultDeclaration | ExportNamedDeclaration | Program; } /** * Experimental: Decorators * @category Linter * @experimental */ export interface Decorator { type: "Decorator"; range: Range; expression: | ArrayExpression | ArrayPattern | ArrowFunctionExpression | CallExpression | ClassExpression | FunctionExpression | Identifier | JSXElement | JSXFragment | Literal | TemplateLiteral | MemberExpression | MetaProperty | ObjectExpression | ObjectPattern | SequenceExpression | Super | TaggedTemplateExpression | ThisExpression | TSAsExpression | TSNonNullExpression | TSTypeAssertion; parent: Node; } /** * Declares a class in the current scope * @category Linter * @experimental */ export interface ClassDeclaration { type: "ClassDeclaration"; range: Range; declare: boolean; abstract: boolean; id: Identifier | null; superClass: | ArrayExpression | ArrayPattern | ArrowFunctionExpression | CallExpression | ClassExpression | FunctionExpression | Identifier | JSXElement | JSXFragment | Literal | TemplateLiteral | MemberExpression | MetaProperty | ObjectExpression | ObjectPattern | SequenceExpression | Super | TaggedTemplateExpression | ThisExpression | TSAsExpression | TSNonNullExpression | TSTypeAssertion | null; implements: TSClassImplements[]; body: ClassBody; parent: Node; } /** * Similar to ClassDeclaration but for declaring a class as an * expression. The main difference is that the class name(=id) can * be omitted. * @category Linter * @experimental */ export interface ClassExpression { type: "ClassExpression"; range: Range; declare: boolean; abstract: boolean; id: Identifier | null; superClass: | ArrayExpression | ArrayPattern | ArrowFunctionExpression | CallExpression | ClassExpression | FunctionExpression | Identifier | JSXElement | JSXFragment | Literal | TemplateLiteral | MemberExpression | MetaProperty | ObjectExpression | ObjectPattern | SequenceExpression | Super | TaggedTemplateExpression | ThisExpression | TSAsExpression | TSNonNullExpression | TSTypeAssertion | null; superTypeArguments: TSTypeParameterInstantiation | undefined; typeParameters: TSTypeParameterDeclaration | undefined; implements: TSClassImplements[]; body: ClassBody; parent: Node; } /** * Represents the body of a class and contains all members * @category Linter * @experimental */ export interface ClassBody { type: "ClassBody"; range: Range; body: Array< | AccessorProperty | MethodDefinition | PropertyDefinition | StaticBlock // Stage 1 Proposal: // https://github.com/tc39/proposal-grouped-and-auto-accessors // | TSAbstractAccessorProperty | TSAbstractMethodDefinition | TSAbstractPropertyDefinition | TSIndexSignature >; parent: ClassDeclaration | ClassExpression; } /** * Static class initializiation block. * @category Linter * @experimental */ export interface StaticBlock { type: "StaticBlock"; range: Range; body: Statement[]; parent: ClassBody; } // Stage 1 Proposal: // https://github.com/tc39/proposal-grouped-and-auto-accessors // | TSAbstractAccessorProperty /** * @category Linter * @experimental */ export interface AccessorProperty { type: "AccessorProperty"; range: Range; declare: boolean; computed: boolean; optional: boolean; override: boolean; readonly: boolean; static: boolean; accessibility: Accessibility | undefined; decorators: Decorator[]; key: Expression | Identifier | NumberLiteral | StringLiteral; value: Expression | null; parent: ClassBody; } /** * @category Linter * @experimental */ export interface PropertyDefinition { type: "PropertyDefinition"; range: Range; declare: boolean; computed: boolean; optional: boolean; override: boolean; readonly: boolean; static: boolean; accessibility: Accessibility | undefined; decorators: Decorator[]; key: | Expression | Identifier | NumberLiteral | StringLiteral | PrivateIdentifier; value: Expression | null; typeAnnotation: TSTypeAnnotation | undefined; parent: ClassBody; } /** * @category Linter * @experimental */ export interface MethodDefinition { type: "MethodDefinition"; range: Range; declare: boolean; computed: boolean; optional: boolean; override: boolean; readonly: boolean; static: boolean; kind: "constructor" | "get" | "method" | "set"; accessibility: Accessibility | undefined; decorators: Decorator[]; key: | PrivateIdentifier | Identifier | NumberLiteral | StringLiteral | Expression; value: FunctionExpression | TSEmptyBodyFunctionExpression; parent: ClassBody; } /** * @category Linter * @experimental */ export interface BlockStatement { type: "BlockStatement"; range: Range; body: Statement[]; parent: | Program | StaticBlock | BlockStatement | WithStatement | LabeledStatement | IfStatement | SwitchCase | WhileStatement | DoWhileStatement | ForStatement | ForInStatement | ForOfStatement | TSModuleBlock; } /** * The `debugger;` statement. * @category Linter * @experimental */ export interface DebuggerStatement { type: "DebuggerStatement"; range: Range; parent: | Program | StaticBlock | BlockStatement | WithStatement | LabeledStatement | IfStatement | SwitchCase | WhileStatement | DoWhileStatement | ForStatement | ForInStatement | ForOfStatement | TSModuleBlock; } /** * Legacy JavaScript feature, that's discouraged from being used today. * @deprecated * @category Linter * @experimental */ export interface WithStatement { type: "WithStatement"; range: Range; object: Expression; body: Statement; parent: | Program | StaticBlock | BlockStatement | WithStatement | LabeledStatement | IfStatement | SwitchCase | WhileStatement | DoWhileStatement | ForStatement | ForInStatement | ForOfStatement | TSModuleBlock; } /** * Returns a value from a function. * @category Linter * @experimental */ export interface ReturnStatement { type: "ReturnStatement"; range: Range; argument: Expression | null; parent: | Program | StaticBlock | BlockStatement | WithStatement | LabeledStatement | IfStatement | SwitchCase | WhileStatement | DoWhileStatement | ForStatement | ForInStatement | ForOfStatement | TSModuleBlock; } /** * Custom control flow based on labels. * @category Linter * @experimental */ export interface LabeledStatement { type: "LabeledStatement"; range: Range; label: Identifier; body: Statement; parent: | Program | StaticBlock | BlockStatement | WithStatement | LabeledStatement | IfStatement | SwitchCase | WhileStatement | DoWhileStatement | ForStatement | ForInStatement | ForOfStatement | TSModuleBlock; } /** * Break any loop or labeled statement, example: * * ```ts * while (true) { * break; * } * * for (let i = 0; i < 10; i++) { * if (i > 5) break; * } * ``` * @category Linter * @experimental */ export interface BreakStatement { type: "BreakStatement"; range: Range; label: Identifier | null; parent: | Program | StaticBlock | BlockStatement | WithStatement | LabeledStatement | IfStatement | SwitchCase | WhileStatement | DoWhileStatement | ForStatement | ForInStatement | ForOfStatement | TSModuleBlock; } /** * Terminates the current loop and continues with the next iteration. * @category Linter * @experimental */ export interface ContinueStatement { type: "ContinueStatement"; range: Range; label: Identifier | null; parent: | Program | StaticBlock | BlockStatement | WithStatement | LabeledStatement | IfStatement | SwitchCase | WhileStatement | DoWhileStatement | ForStatement | ForInStatement | ForOfStatement | TSModuleBlock; } /** * Execute a statement the test passes, otherwise the alternate * statement, if it was defined. * @category Linter * @experimental */ export interface IfStatement { type: "IfStatement"; range: Range; test: Expression; consequent: Statement; alternate: Statement | null; parent: | Program | StaticBlock | BlockStatement | WithStatement | LabeledStatement | IfStatement | SwitchCase | WhileStatement | DoWhileStatement | ForStatement | ForInStatement | ForOfStatement | TSModuleBlock; } /** * Match an expression against a series of cases. * @category Linter * @experimental */ export interface SwitchStatement { type: "SwitchStatement"; range: Range; discriminant: Expression; cases: SwitchCase[]; parent: | Program | StaticBlock | BlockStatement | WithStatement | LabeledStatement | IfStatement | SwitchCase | WhileStatement | DoWhileStatement | ForStatement | ForInStatement | ForOfStatement | TSModuleBlock; } /** * A single case of a SwitchStatement. * @category Linter * @experimental */ export interface SwitchCase { type: "SwitchCase"; range: Range; test: Expression | null; consequent: Statement[]; parent: SwitchStatement; } /** * Throw a user defined exception. Stops execution * of the current function. * @category Linter * @experimental */ export interface ThrowStatement { type: "ThrowStatement"; range: Range; argument: Expression; parent: | Program | StaticBlock | BlockStatement | WithStatement | LabeledStatement | IfStatement | SwitchCase | WhileStatement | DoWhileStatement | ForStatement | ForInStatement | ForOfStatement | TSModuleBlock; } /** * Run a loop while the test expression is truthy. * @category Linter * @experimental */ export interface WhileStatement { type: "WhileStatement"; range: Range; test: Expression; body: Statement; parent: | Program | StaticBlock | BlockStatement | WithStatement | LabeledStatement | IfStatement | SwitchCase | WhileStatement | DoWhileStatement | ForStatement | ForInStatement | ForOfStatement | TSModuleBlock; } /** * Re-run loop for as long as test expression is truthy. * @category Linter * @experimental */ export interface DoWhileStatement { type: "DoWhileStatement"; range: Range; test: Expression; body: Statement; parent: | Program | StaticBlock | BlockStatement | WithStatement | LabeledStatement | IfStatement | SwitchCase | WhileStatement | DoWhileStatement | ForStatement | ForInStatement | ForOfStatement | TSModuleBlock; } /** * Classic for-loop. * @category Linter * @experimental */ export interface ForStatement { type: "ForStatement"; range: Range; init: Expression | VariableDeclaration | null; test: Expression | null; update: Expression | null; body: Statement; parent: | Program | StaticBlock | BlockStatement | WithStatement | LabeledStatement | IfStatement | SwitchCase | WhileStatement | DoWhileStatement | ForStatement | ForInStatement | ForOfStatement | TSModuleBlock; } /** * Enumerate over all enumerable string properties of an object. * @category Linter * @experimental */ export interface ForInStatement { type: "ForInStatement"; range: Range; left: Expression | VariableDeclaration; right: Expression; body: Statement; parent: | Program | StaticBlock | BlockStatement | WithStatement | LabeledStatement | IfStatement | SwitchCase | WhileStatement | DoWhileStatement | ForStatement | ForInStatement | ForOfStatement | TSModuleBlock; } /** * Iterate over sequence of values from an iterator. * @category Linter * @experimental */ export interface ForOfStatement { type: "ForOfStatement"; range: Range; await: boolean; left: Expression | VariableDeclaration; right: Expression; body: Statement; parent: | Program | StaticBlock | BlockStatement | WithStatement | LabeledStatement | IfStatement | SwitchCase | WhileStatement | DoWhileStatement | ForStatement | ForInStatement | ForOfStatement | TSModuleBlock; } /** * Statement that holds an expression. * @category Linter * @experimental */ export interface ExpressionStatement { type: "ExpressionStatement"; range: Range; expression: Expression; parent: | Program | StaticBlock | BlockStatement | WithStatement | LabeledStatement | IfStatement | SwitchCase | WhileStatement | DoWhileStatement | ForStatement | ForInStatement | ForOfStatement | TSModuleBlock; } /** * Try/catch statement * @category Linter * @experimental */ export interface TryStatement { type: "TryStatement"; range: Range; block: BlockStatement; handler: CatchClause | null; finalizer: BlockStatement | null; parent: | Program | StaticBlock | BlockStatement | WithStatement | LabeledStatement | IfStatement | SwitchCase | WhileStatement | DoWhileStatement | ForStatement | ForInStatement | ForOfStatement | TSModuleBlock; } /** * The catch clause of a try/catch statement * @category Linter * @experimental */ export interface CatchClause { type: "CatchClause"; range: Range; param: ArrayPattern | ObjectPattern | Identifier | null; body: BlockStatement; parent: TryStatement; } /** * An array literal * @category Linter * @experimental */ export interface ArrayExpression { type: "ArrayExpression"; range: Range; elements: Array; parent: Node; } /** * An object literal. * @category Linter * @experimental */ export interface ObjectExpression { type: "ObjectExpression"; range: Range; properties: Array; parent: Node; } /** * Compare left and right value with the specifier operator. * @category Linter * @experimental */ export interface BinaryExpression { type: "BinaryExpression"; range: Range; operator: | "&" | "**" | "*" | "||" | "|" | "^" | "===" | "==" | "!==" | "!=" | ">=" | ">>>" | ">>" | ">" | "in" | "instanceof" | "<=" | "<<" | "<" | "-" | "%" | "+" | "/"; left: Expression | PrivateIdentifier; right: Expression; parent: Node; } /** * Chain expressions based on the operator specified * @category Linter * @experimental */ export interface LogicalExpression { type: "LogicalExpression"; range: Range; operator: "&&" | "??" | "||"; left: Expression; right: Expression; parent: Node; } /** * Declare a function as an expression. Similar to `FunctionDeclaration`, * with an optional name (=id). * @category Linter * @experimental */ export interface FunctionExpression { type: "FunctionExpression"; range: Range; async: boolean; generator: boolean; id: Identifier | null; typeParameters: TSTypeParameterDeclaration | undefined; params: Parameter[]; returnType: TSTypeAnnotation | undefined; body: BlockStatement; parent: Node; } /** * Arrow function expression * @category Linter * @experimental */ export interface ArrowFunctionExpression { type: "ArrowFunctionExpression"; range: Range; async: boolean; generator: boolean; id: null; typeParameters: TSTypeParameterDeclaration | undefined; params: Parameter[]; returnType: TSTypeAnnotation | undefined; body: BlockStatement | Expression; parent: Node; } /** * The `this` keyword used in classes. * @category Linter * @experimental */ export interface ThisExpression { type: "ThisExpression"; range: Range; parent: Node; } /** * The `super` keyword used in classes. * @category Linter * @experimental */ export interface Super { type: "Super"; range: Range; parent: Node; } /** * Apply operand on value based on the specified operator. * @category Linter * @experimental */ export interface UnaryExpression { type: "UnaryExpression"; range: Range; operator: "!" | "+" | "~" | "-" | "delete" | "typeof" | "void"; argument: Expression; parent: Node; } /** * Create a new instance of a class. * @category Linter * @experimental */ export interface NewExpression { type: "NewExpression"; range: Range; callee: Expression; typeArguments: TSTypeParameterInstantiation | undefined; arguments: Array; parent: Node; } /** * Dynamically import a module. * @category Linter * @experimental */ export interface ImportExpression { type: "ImportExpression"; range: Range; source: Expression; options: Expression | null; parent: Node; } /** * A function call. * @category Linter * @experimental */ export interface CallExpression { type: "CallExpression"; range: Range; optional: boolean; callee: Expression; typeArguments: TSTypeParameterInstantiation | null; arguments: Array; parent: Node; } /** * Syntactic sugar to increment or decrement a value. * @category Linter * @experimental */ export interface UpdateExpression { type: "UpdateExpression"; range: Range; prefix: boolean; operator: "++" | "--"; argument: Expression; parent: Node; } /** * Updaate a variable or property. * @category Linter * @experimental */ export interface AssignmentExpression { type: "AssignmentExpression"; range: Range; operator: | "&&=" | "&=" | "**=" | "*=" | "||=" | "|=" | "^=" | "=" | ">>=" | ">>>=" | "<<=" | "-=" | "%=" | "+=" | "??=" | "/="; left: Expression; right: Expression; parent: Node; } /** * Inline if-statement. * @category Linter * @experimental */ export interface ConditionalExpression { type: "ConditionalExpression"; range: Range; test: Expression; consequent: Expression; alternate: Expression; parent: Node; } /** * MemberExpression * @category Linter * @experimental */ export interface MemberExpression { type: "MemberExpression"; range: Range; optional: boolean; computed: boolean; object: Expression; property: Expression | Identifier | PrivateIdentifier; parent: Node; } /** * ChainExpression * @category Linter * @experimental */ export interface ChainExpression { type: "ChainExpression"; range: Range; expression: | CallExpression | MemberExpression | TSNonNullExpression; parent: Node; } /** * Execute multiple expressions in sequence. * @category Linter * @experimental */ export interface SequenceExpression { type: "SequenceExpression"; range: Range; expressions: Expression[]; parent: Node; } /** * A template literal string. * @category Linter * @experimental */ export interface TemplateLiteral { type: "TemplateLiteral"; range: Range; quasis: TemplateElement[]; expressions: Expression[]; parent: Node; } /** * The static portion of a template literal. * @category Linter * @experimental */ export interface TemplateElement { type: "TemplateElement"; range: Range; tail: boolean; raw: string; cooked: string; parent: TemplateLiteral | TSTemplateLiteralType; } /** * Tagged template expression. * @category Linter * @experimental */ export interface TaggedTemplateExpression { type: "TaggedTemplateExpression"; range: Range; tag: Expression; typeArguments: TSTypeParameterInstantiation | undefined; quasi: TemplateLiteral; parent: Node; } /** * Pause or resume a generator function. * @category Linter * @experimental */ export interface YieldExpression { type: "YieldExpression"; range: Range; delegate: boolean; argument: Expression | null; parent: Node; } /** * Await a `Promise` and get its fulfilled value. * @category Linter * @experimental */ export interface AwaitExpression { type: "AwaitExpression"; range: Range; argument: Expression; parent: Node; } /** * Can either be `import.meta` or `new.target`. * @category Linter * @experimental */ export interface MetaProperty { type: "MetaProperty"; range: Range; meta: Identifier; property: Identifier; parent: Node; } /** * Custom named node by the developer. Can be a variable name, * a function name, parameter, etc. * @category Linter * @experimental */ export interface Identifier { type: "Identifier"; range: Range; name: string; optional: boolean; typeAnnotation: TSTypeAnnotation | undefined; parent: Node; } /** * Private members inside of classes, must start with `#`. * @category Linter * @experimental */ export interface PrivateIdentifier { type: "PrivateIdentifier"; range: Range; name: string; parent: | TSAbstractPropertyDefinition | TSPropertySignature | PropertyDefinition | MethodDefinition | BinaryExpression | MemberExpression; } /** * Assign default values in parameters. * @category Linter * @experimental */ export interface AssignmentPattern { type: "AssignmentPattern"; range: Range; left: ArrayPattern | ObjectPattern | Identifier; right: Expression; parent: Node; } /** * Destructure an array. * @category Linter * @experimental */ export interface ArrayPattern { type: "ArrayPattern"; range: Range; optional: boolean; typeAnnotation: TSTypeAnnotation | undefined; elements: Array< | ArrayPattern | AssignmentPattern | Identifier | MemberExpression | ObjectPattern | RestElement | null >; parent: Node; } /** * Destructure an object. * @category Linter * @experimental */ export interface ObjectPattern { type: "ObjectPattern"; range: Range; optional: boolean; typeAnnotation: TSTypeAnnotation | undefined; properties: Array; parent: Node; } /** * The rest of function parameters. * @category Linter * @experimental */ export interface RestElement { type: "RestElement"; range: Range; typeAnnotation: TSTypeAnnotation | undefined; argument: | ArrayPattern | AssignmentPattern | Identifier | MemberExpression | ObjectPattern | RestElement; parent: Node; } /** * @category Linter * @experimental */ export interface SpreadElement { type: "SpreadElement"; range: Range; argument: Expression; parent: | ArrayExpression | CallExpression | NewExpression | ObjectExpression; } /** * @category Linter * @experimental */ export interface Property { type: "Property"; range: Range; shorthand: boolean; computed: boolean; method: boolean; kind: "get" | "init" | "set"; key: Expression | Identifier | NumberLiteral | StringLiteral; value: | AssignmentPattern | ArrayPattern | ObjectPattern | Identifier | Expression | TSEmptyBodyFunctionExpression; parent: ObjectExpression | ObjectPattern; } /** * Represents numbers that are too high or too low to be represented * by the `number` type. * * ```ts * const a = 9007199254740991n; * ``` * @category Linter * @experimental */ export interface BigIntLiteral { type: "Literal"; range: Range; raw: string; bigint: string; value: bigint; parent: Node; } /** * Either `true` or `false` * @category Linter * @experimental */ export interface BooleanLiteral { type: "Literal"; range: Range; raw: "false" | "true"; value: boolean; parent: Node; } /** * A number literal * * ```ts * 1; * 1.2; * ``` * @category Linter * @experimental */ export interface NumberLiteral { type: "Literal"; range: Range; raw: string; value: number; parent: Node; } /** * The `null` literal * @category Linter * @experimental */ export interface NullLiteral { type: "Literal"; range: Range; raw: "null"; value: null; parent: Node; } /** * A string literal * * ```ts * "foo"; * 'foo "bar"'; * ``` * @category Linter * @experimental */ export interface StringLiteral { type: "Literal"; range: Range; raw: string; value: string; parent: Node; } /** * A regex literal: * * ```ts * /foo(bar|baz)$/g * ``` * @category Linter * @experimental */ export interface RegExpLiteral { type: "Literal"; range: Range; raw: string; regex: { flags: string; pattern: string; }; value: RegExp | null; parent: Node; } /** * Union type of all Literals * @category Linter * @experimental */ export type Literal = | BigIntLiteral | BooleanLiteral | NullLiteral | NumberLiteral | RegExpLiteral | StringLiteral; /** * User named identifier inside JSX. * @category Linter * @experimental */ export interface JSXIdentifier { type: "JSXIdentifier"; range: Range; name: string; parent: | JSXNamespacedName | JSXOpeningElement | JSXAttribute | JSXClosingElement | JSXMemberExpression; } /** * Namespaced name in JSX * @category Linter * @experimental */ export interface JSXNamespacedName { type: "JSXNamespacedName"; range: Range; namespace: JSXIdentifier; name: JSXIdentifier; parent: | JSXOpeningElement | JSXAttribute | JSXClosingElement | JSXMemberExpression; } /** * Empty JSX expression. * @category Linter * @experimental */ export interface JSXEmptyExpression { type: "JSXEmptyExpression"; range: Range; parent: JSXAttribute | JSXElement | JSXFragment; } /** * A JSX element. * @category Linter * @experimental */ export interface JSXElement { type: "JSXElement"; range: Range; openingElement: JSXOpeningElement; closingElement: JSXClosingElement | null; children: JSXChild[]; parent: Node; } /** * The opening tag of a JSXElement * @category Linter * @experimental */ export interface JSXOpeningElement { type: "JSXOpeningElement"; range: Range; selfClosing: boolean; name: | JSXIdentifier | JSXMemberExpression | JSXNamespacedName; attributes: Array; typeArguments: TSTypeParameterInstantiation | undefined; parent: JSXElement; } /** * A JSX attribute * @category Linter * @experimental */ export interface JSXAttribute { type: "JSXAttribute"; range: Range; name: JSXIdentifier | JSXNamespacedName; value: | JSXElement | JSXExpressionContainer | Literal | null; parent: JSXOpeningElement; } /** * Spreads an object as JSX attributes. * @category Linter * @experimental */ export interface JSXSpreadAttribute { type: "JSXSpreadAttribute"; range: Range; argument: Expression; parent: JSXOpeningElement; } /** * The closing tag of a JSXElement. Only used when the element * is not self-closing. * @category Linter * @experimental */ export interface JSXClosingElement { type: "JSXClosingElement"; range: Range; name: | JSXIdentifier | JSXMemberExpression | JSXNamespacedName; parent: JSXElement; } /** * Usually a passthrough node to pass multiple sibling elements as * the JSX syntax requires one root element. * @category Linter * @experimental */ export interface JSXFragment { type: "JSXFragment"; range: Range; openingFragment: JSXOpeningFragment; closingFragment: JSXClosingFragment; children: JSXChild[]; parent: Node; } /** * The opening tag of a JSXFragment. * @category Linter * @experimental */ export interface JSXOpeningFragment { type: "JSXOpeningFragment"; range: Range; parent: JSXFragment; } /** * The closing tag of a JSXFragment. * @category Linter * @experimental */ export interface JSXClosingFragment { type: "JSXClosingFragment"; range: Range; parent: JSXFragment; } /** * Inserts a normal JS expression into JSX. * @category Linter * @experimental */ export interface JSXExpressionContainer { type: "JSXExpressionContainer"; range: Range; expression: Expression | JSXEmptyExpression; parent: JSXAttribute | JSXElement | JSXFragment; } /** * Plain text in JSX. * @category Linter * @experimental */ export interface JSXText { type: "JSXText"; range: Range; raw: string; value: string; parent: JSXElement | JSXFragment; } /** * JSX member expression. * @category Linter * @experimental */ export interface JSXMemberExpression { type: "JSXMemberExpression"; range: Range; object: | JSXIdentifier | JSXMemberExpression | JSXNamespacedName; property: JSXIdentifier; parent: JSXOpeningElement | JSXClosingElement; } /** * Union type of all possible child nodes in JSX * @category Linter * @experimental */ export type JSXChild = | JSXElement | JSXExpressionContainer | JSXFragment | JSXText; /** * @category Linter * @experimental */ export interface TSModuleDeclaration { type: "TSModuleDeclaration"; range: Range; declare: boolean; kind: "global" | "module" | "namespace"; id: Identifier | Literal | TSQualifiedName; body: TSModuleBlock | undefined; parent: | ExportDefaultDeclaration | ExportNamedDeclaration | Program | StaticBlock | BlockStatement | WithStatement | LabeledStatement | IfStatement | SwitchCase | WhileStatement | DoWhileStatement | ForStatement | ForInStatement | ForOfStatement | TSModuleBlock; } /** * Body of a `TSModuleDeclaration` * @category Linter * @experimental */ export interface TSModuleBlock { type: "TSModuleBlock"; range: Range; body: Array< | ExportAllDeclaration | ExportDefaultDeclaration | ExportNamedDeclaration | ImportDeclaration | Statement | TSImportEqualsDeclaration | TSNamespaceExportDeclaration >; parent: TSModuleDeclaration; } /** * @category Linter * @experimental */ export interface TSClassImplements { type: "TSClassImplements"; range: Range; expression: Expression; typeArguments: TSTypeParameterInstantiation | undefined; parent: ClassDeclaration | ClassExpression; } /** * @category Linter * @experimental */ export interface TSAbstractMethodDefinition { type: "TSAbstractMethodDefinition"; range: Range; computed: boolean; optional: boolean; override: boolean; static: boolean; accessibility: Accessibility | undefined; kind: "method"; key: Expression | Identifier | NumberLiteral | StringLiteral; value: FunctionExpression | TSEmptyBodyFunctionExpression; parent: Node; } /** * @category Linter * @experimental */ export interface TSAbstractPropertyDefinition { type: "TSAbstractPropertyDefinition"; range: Range; computed: boolean; optional: boolean; override: boolean; static: boolean; definite: boolean; declare: boolean; readonly: boolean; accessibility: Accessibility | undefined; decorators: Decorator[]; key: | Expression | PrivateIdentifier | Identifier | NumberLiteral | StringLiteral; typeAnnotation: TSTypeAnnotation | undefined; value: Expression | null; parent: ClassBody; } /** * @category Linter * @experimental */ export interface TSEmptyBodyFunctionExpression { type: "TSEmptyBodyFunctionExpression"; range: Range; declare: boolean; expression: boolean; async: boolean; generator: boolean; id: null; body: null; typeParameters: TSTypeParameterDeclaration | undefined; params: Parameter[]; returnType: TSTypeAnnotation | undefined; parent: | MethodDefinition | Property | TSAbstractMethodDefinition | TSParameterProperty; } /** * @category Linter * @experimental */ export interface TSParameterProperty { type: "TSParameterProperty"; range: Range; override: boolean; readonly: boolean; static: boolean; accessibility: Accessibility | undefined; decorators: Decorator[]; parameter: | AssignmentPattern | ArrayPattern | ObjectPattern | Identifier | RestElement; parent: | ArrowFunctionExpression | FunctionDeclaration | FunctionExpression | TSDeclareFunction | TSEmptyBodyFunctionExpression; } /** * @category Linter * @experimental */ export interface TSCallSignatureDeclaration { type: "TSCallSignatureDeclaration"; range: Range; typeParameters: TSTypeParameterDeclaration | undefined; params: Parameter[]; returnType: TSTypeAnnotation | undefined; parent: TSInterfaceBody | TSTypeLiteral; } /** * @category Linter * @experimental */ export interface TSPropertySignature { type: "TSPropertySignature"; range: Range; computed: boolean; optional: boolean; readonly: boolean; static: boolean; key: | PrivateIdentifier | Expression | Identifier | NumberLiteral | StringLiteral; typeAnnotation: TSTypeAnnotation | undefined; parent: TSInterfaceBody | TSTypeLiteral; } /** * @category Linter * @experimental */ export interface TSDeclareFunction { type: "TSDeclareFunction"; range: Range; async: boolean; declare: boolean; generator: boolean; body: undefined; id: Identifier | null; params: Parameter[]; returnType: TSTypeAnnotation | undefined; typeParameters: TSTypeParameterDeclaration | undefined; parent: Node; } /** * ```ts * enum Foo { A, B }; * ``` * @category Linter * @experimental */ export interface TSEnumDeclaration { type: "TSEnumDeclaration"; range: Range; declare: boolean; const: boolean; id: Identifier; body: TSEnumBody; parent: Node; } /** * The body of a `TSEnumDeclaration` * @category Linter * @experimental */ export interface TSEnumBody { type: "TSEnumBody"; range: Range; members: TSEnumMember[]; parent: TSEnumDeclaration; } /** * A member of a `TSEnumDeclaration` * @category Linter * @experimental */ export interface TSEnumMember { type: "TSEnumMember"; range: Range; id: | Identifier | NumberLiteral | StringLiteral; initializer: Expression | undefined; parent: TSEnumBody; } /** * @category Linter * @experimental */ export interface TSTypeAssertion { type: "TSTypeAssertion"; range: Range; expression: Expression; typeAnnotation: TypeNode; parent: Node; } /** * @category Linter * @experimental */ export interface TSTypeParameterInstantiation { type: "TSTypeParameterInstantiation"; range: Range; params: TypeNode[]; parent: | ClassExpression | NewExpression | CallExpression | TaggedTemplateExpression | JSXOpeningElement | TSClassImplements | TSInstantiationExpression | TSInterfaceHeritage | TSTypeQuery | TSTypeReference | TSImportType; } /** * @category Linter * @experimental */ export interface TSTypeAliasDeclaration { type: "TSTypeAliasDeclaration"; range: Range; declare: boolean; id: Identifier; typeParameters: TSTypeParameterDeclaration | undefined; typeAnnotation: TypeNode; parent: Node; } /** * @category Linter * @experimental */ export interface TSSatisfiesExpression { type: "TSSatisfiesExpression"; range: Range; expression: Expression; typeAnnotation: TypeNode; parent: Node; } /** * @category Linter * @experimental */ export interface TSAsExpression { type: "TSAsExpression"; range: Range; expression: Expression; typeAnnotation: TypeNode; parent: Node; } /** * @category Linter * @experimental */ export interface TSInstantiationExpression { type: "TSInstantiationExpression"; range: Range; expression: Expression; typeArguments: TSTypeParameterInstantiation; parent: Node; } /** * @category Linter * @experimental */ export interface TSNonNullExpression { type: "TSNonNullExpression"; range: Range; expression: Expression; parent: Node; } /** * @category Linter * @experimental */ export interface TSThisType { type: "TSThisType"; range: Range; parent: Node; } /** * @category Linter * @experimental */ export interface TSInterfaceDeclaration { type: "TSInterfaceDeclaration"; range: Range; declare: boolean; id: Identifier; extends: TSInterfaceHeritage[]; typeParameters: TSTypeParameterDeclaration | undefined; body: TSInterfaceBody; parent: Node; } /** * @category Linter * @experimental */ export interface TSInterfaceBody { type: "TSInterfaceBody"; range: Range; body: Array< | TSCallSignatureDeclaration | TSConstructSignatureDeclaration | TSIndexSignature | TSMethodSignature | TSPropertySignature >; parent: TSInterfaceDeclaration; } /** * @category Linter * @experimental */ export interface TSConstructSignatureDeclaration { type: "TSConstructSignatureDeclaration"; range: Range; typeParameters: TSTypeParameterDeclaration | undefined; params: Parameter[]; returnType: TSTypeAnnotation; parent: TSInterfaceBody | TSTypeLiteral; } /** * @category Linter * @experimental */ export interface TSMethodSignature { type: "TSMethodSignature"; range: Range; computed: boolean; optional: boolean; readonly: boolean; static: boolean; kind: "get" | "set" | "method"; key: Expression | Identifier | NumberLiteral | StringLiteral; returnType: TSTypeAnnotation | undefined; params: Parameter[]; typeParameters: TSTypeParameterDeclaration | undefined; parent: TSInterfaceBody | TSTypeLiteral; } /** * @category Linter * @experimental */ export interface TSInterfaceHeritage { type: "TSInterfaceHeritage"; range: Range; expression: Expression; typeArguments: TSTypeParameterInstantiation | undefined; parent: TSInterfaceBody; } /** * @category Linter * @experimental */ export interface TSIndexSignature { type: "TSIndexSignature"; range: Range; readonly: boolean; static: boolean; parameters: Parameter[]; typeAnnotation: TSTypeAnnotation | undefined; parent: ClassBody | TSInterfaceBody | TSTypeLiteral; } /** * @category Linter * @experimental */ export interface TSUnionType { type: "TSUnionType"; range: Range; types: TypeNode[]; parent: Node; } /** * @category Linter * @experimental */ export interface TSIntersectionType { type: "TSIntersectionType"; range: Range; types: TypeNode[]; parent: Node; } /** * @category Linter * @experimental */ export interface TSInferType { type: "TSInferType"; range: Range; typeParameter: TSTypeParameter; parent: Node; } /** * @category Linter * @experimental */ export interface TSTypeOperator { type: "TSTypeOperator"; range: Range; operator: "keyof" | "readonly" | "unique"; typeAnnotation: TypeNode; parent: Node; } /** * @category Linter * @experimental */ export interface TSIndexedAccessType { type: "TSIndexedAccessType"; range: Range; indexType: TypeNode; objectType: TypeNode; parent: Node; } /** * ```ts * const a: any = null; * ``` * @category Linter * @experimental */ export interface TSAnyKeyword { type: "TSAnyKeyword"; range: Range; parent: Node; } /** * @category Linter * @experimental */ export interface TSUnknownKeyword { type: "TSUnknownKeyword"; range: Range; parent: Node; } /** * @category Linter * @experimental */ export interface TSNumberKeyword { type: "TSNumberKeyword"; range: Range; parent: Node; } /** * @category Linter * @experimental */ export interface TSObjectKeyword { type: "TSObjectKeyword"; range: Range; parent: Node; } /** * @category Linter * @experimental */ export interface TSBooleanKeyword { type: "TSBooleanKeyword"; range: Range; parent: Node; } /** * @category Linter * @experimental */ export interface TSBigIntKeyword { type: "TSBigIntKeyword"; range: Range; parent: Node; } /** * @category Linter * @experimental */ export interface TSStringKeyword { type: "TSStringKeyword"; range: Range; parent: Node; } /** * @category Linter * @experimental */ export interface TSSymbolKeyword { type: "TSSymbolKeyword"; range: Range; parent: Node; } /** * @category Linter * @experimental */ export interface TSVoidKeyword { type: "TSVoidKeyword"; range: Range; parent: Node; } /** * @category Linter * @experimental */ export interface TSUndefinedKeyword { type: "TSUndefinedKeyword"; range: Range; parent: Node; } /** * @category Linter * @experimental */ export interface TSNullKeyword { type: "TSNullKeyword"; range: Range; parent: Node; } /** * @category Linter * @experimental */ export interface TSNeverKeyword { type: "TSNeverKeyword"; range: Range; parent: Node; } /** * @category Linter * @experimental */ export interface TSIntrinsicKeyword { type: "TSIntrinsicKeyword"; range: Range; parent: Node; } /** * @category Linter * @experimental */ export interface TSRestType { type: "TSRestType"; range: Range; typeAnnotation: TypeNode; parent: Node; } /** * @category Linter * @experimental */ export interface TSConditionalType { type: "TSConditionalType"; range: Range; checkType: TypeNode; extendsType: TypeNode; trueType: TypeNode; falseType: TypeNode; parent: Node; } /** * @category Linter * @experimental */ export interface TSMappedType { type: "TSMappedType"; range: Range; readonly: boolean; optional: boolean; nameType: TypeNode | null; typeAnnotation: TypeNode | undefined; constraint: TypeNode; key: Identifier; parent: Node; } /** * @category Linter * @experimental */ export interface TSLiteralType { type: "TSLiteralType"; range: Range; literal: Literal | TemplateLiteral | UnaryExpression | UpdateExpression; parent: Node; } /** * @category Linter * @experimental */ export interface TSTemplateLiteralType { type: "TSTemplateLiteralType"; range: Range; quasis: TemplateElement[]; types: TypeNode[]; parent: Node; } /** * @category Linter * @experimental */ export interface TSTypeLiteral { type: "TSTypeLiteral"; range: Range; members: Array< | TSCallSignatureDeclaration | TSConstructSignatureDeclaration | TSIndexSignature | TSMethodSignature | TSPropertySignature >; parent: Node; } /** * @category Linter * @experimental */ export interface TSOptionalType { type: "TSOptionalType"; range: Range; typeAnnotation: TypeNode; parent: Node; } /** * @category Linter * @experimental */ export interface TSTypeAnnotation { type: "TSTypeAnnotation"; range: Range; typeAnnotation: TypeNode; parent: Node; } /** * @category Linter * @experimental */ export interface TSArrayType { type: "TSArrayType"; range: Range; elementType: TypeNode; parent: Node; } /** * @category Linter * @experimental */ export interface TSTypeQuery { type: "TSTypeQuery"; range: Range; exprName: Identifier | ThisExpression | TSQualifiedName | TSImportType; typeArguments: TSTypeParameterInstantiation | undefined; parent: Node; } /** * @category Linter * @experimental */ export interface TSTypeReference { type: "TSTypeReference"; range: Range; typeName: Identifier | ThisExpression | TSQualifiedName; typeArguments: TSTypeParameterInstantiation | undefined; parent: Node; } /** * @category Linter * @experimental */ export interface TSTypePredicate { type: "TSTypePredicate"; range: Range; asserts: boolean; parameterName: Identifier | TSThisType; typeAnnotation: TSTypeAnnotation | undefined; parent: Node; } /** * @category Linter * @experimental */ export interface TSTupleType { type: "TSTupleType"; range: Range; elementTypes: TypeNode[]; parent: Node; } /** * @category Linter * @experimental */ export interface TSNamedTupleMember { type: "TSNamedTupleMember"; range: Range; label: Identifier; elementType: TypeNode; optional: boolean; parent: Node; } /** * @category Linter * @experimental */ export interface TSTypeParameterDeclaration { type: "TSTypeParameterDeclaration"; range: Range; params: TSTypeParameter[]; parent: Node; } /** * @category Linter * @experimental */ export interface TSTypeParameter { type: "TSTypeParameter"; range: Range; in: boolean; out: boolean; const: boolean; name: Identifier; constraint: TypeNode | null; default: TypeNode | null; parent: TSInferType | TSMappedType | TSTypeParameterDeclaration; } /** * @category Linter * @experimental */ export interface TSImportType { type: "TSImportType"; range: Range; argument: TypeNode; qualifier: Identifier | ThisExpression | TSQualifiedName | null; typeArguments: TSTypeParameterInstantiation | null; parent: Node; } /** * @category Linter * @experimental */ export interface TSExportAssignment { type: "TSExportAssignment"; range: Range; expression: Expression; parent: Node; } /** * @category Linter * @experimental */ export interface TSFunctionType { type: "TSFunctionType"; range: Range; params: Parameter[]; returnType: TSTypeAnnotation | undefined; typeParameters: TSTypeParameterDeclaration | undefined; parent: Node; } /** * @category Linter * @experimental */ export interface TSQualifiedName { type: "TSQualifiedName"; range: Range; left: Identifier | ThisExpression | TSQualifiedName; right: Identifier; parent: Node; } /** * Union type of all possible statement nodes * @category Linter * @experimental */ export type Statement = | BlockStatement | BreakStatement | ClassDeclaration | ContinueStatement | DebuggerStatement | DoWhileStatement | ExportAllDeclaration | ExportDefaultDeclaration | ExportNamedDeclaration | ExpressionStatement | ForInStatement | ForOfStatement | ForStatement | FunctionDeclaration | IfStatement | ImportDeclaration | LabeledStatement | ReturnStatement | SwitchStatement | ThrowStatement | TryStatement | TSDeclareFunction | TSEnumDeclaration | TSExportAssignment | TSImportEqualsDeclaration | TSInterfaceDeclaration | TSModuleDeclaration | TSNamespaceExportDeclaration | TSTypeAliasDeclaration | VariableDeclaration | WhileStatement | WithStatement; /** * Union type of all possible expression nodes * @category Linter * @experimental */ export type Expression = | ArrayExpression | ArrayPattern | ArrowFunctionExpression | AssignmentExpression | AwaitExpression | BinaryExpression | CallExpression | ChainExpression | ClassExpression | ConditionalExpression | FunctionExpression | Identifier | ImportExpression | JSXElement | JSXFragment | Literal | TemplateLiteral | LogicalExpression | MemberExpression | MetaProperty | NewExpression | ObjectExpression | ObjectPattern | SequenceExpression | Super | TaggedTemplateExpression | TemplateLiteral | ThisExpression | TSAsExpression | TSInstantiationExpression | TSNonNullExpression | TSSatisfiesExpression | TSTypeAssertion | UnaryExpression | UpdateExpression | YieldExpression; /** * Union type of all possible type nodes in TypeScript * @category Linter * @experimental */ export type TypeNode = | TSAnyKeyword | TSArrayType | TSBigIntKeyword | TSBooleanKeyword | TSConditionalType | TSFunctionType | TSImportType | TSIndexedAccessType | TSInferType | TSIntersectionType | TSIntrinsicKeyword | TSLiteralType | TSMappedType | TSNamedTupleMember | TSNeverKeyword | TSNullKeyword | TSNumberKeyword | TSObjectKeyword | TSOptionalType | TSQualifiedName | TSRestType | TSStringKeyword | TSSymbolKeyword | TSTemplateLiteralType | TSThisType | TSTupleType | TSTypeLiteral | TSTypeOperator | TSTypePredicate | TSTypeQuery | TSTypeReference | TSUndefinedKeyword | TSUnionType | TSUnknownKeyword | TSVoidKeyword; /** * A single line comment * @category Linter * @experimental */ export interface LineComment { type: "Line"; range: Range; value: string; } /** * A potentially multi-line block comment * @category Linter * @experimental */ export interface BlockComment { type: "Block"; range: Range; value: string; } /** * Union type of all possible AST nodes * @category Linter * @experimental */ export type Node = | Program | Expression | Statement | TypeNode | ImportSpecifier | ImportDefaultSpecifier | ImportNamespaceSpecifier | ImportAttribute | TSExternalModuleReference | ExportSpecifier | VariableDeclarator | Decorator | ClassBody | StaticBlock | PropertyDefinition | MethodDefinition | SwitchCase | CatchClause | TemplateElement | PrivateIdentifier | AssignmentPattern | RestElement | SpreadElement | Property | JSXIdentifier | JSXNamespacedName | JSXEmptyExpression | JSXOpeningElement | JSXAttribute | JSXSpreadAttribute | JSXClosingElement | JSXOpeningFragment | JSXClosingFragment | JSXExpressionContainer | JSXText | JSXMemberExpression | TSModuleBlock | TSClassImplements | TSAbstractMethodDefinition | TSAbstractPropertyDefinition | TSEmptyBodyFunctionExpression | TSCallSignatureDeclaration | TSPropertySignature | TSEnumBody | TSEnumMember | TSTypeParameterInstantiation | TSInterfaceBody | TSConstructSignatureDeclaration | TSMethodSignature | TSInterfaceHeritage | TSIndexSignature | TSTypeAnnotation | TSTypeParameterDeclaration | TSTypeParameter | LineComment | BlockComment; export {}; // only export exports } /** * The webgpu namespace provides additional APIs that the WebGPU specification * does not specify. * * @category GPU * @experimental */ export namespace webgpu { /** * Starts a frame capture. * * This API is useful for debugging issues related to graphics, and makes * the captured data available to RenderDoc or XCode * (or other software for debugging frames) * * @category GPU * @experimental */ export function deviceStartCapture(device: GPUDevice): void; /** * Stops a frame capture. * * This API is useful for debugging issues related to graphics, and makes * the captured data available to RenderDoc or XCode * (or other software for debugging frames) * * @category GPU * @experimental */ export function deviceStopCapture(device: GPUDevice): void; export {}; // only export exports } export {}; // only export exports }