foster/denoland-deno
0
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-10-30 09:08:00 -04:00
Code Issues Wiki Activity
denoland-deno/cli/js/lib.deno.ns.d.ts

2918 lines
112 KiB
TypeScript
Raw Normal View History

Happy new year! (#3578)
2020-01-02 15:13:47 -05:00
// Copyright 2018-2020 the Deno authors. All rights reserved. MIT license.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
/// <reference no-default-lib="true" />
/// <reference lib="esnext" />
declare namespace Deno {
/** The current process id of the runtime. */
export let pid: number;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
docs: highlight NO_COLOR (#4723)
2020-04-11 23:12:42 -04:00
/** Reflects the `NO_COLOR` environment variable.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
* See: https://no-color.org/ */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export let noColor: boolean;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
refactor: rewrite deno test, add Deno.test() (#3865) * rewrite test runner in Rust * migrate "test" and "runTests" functions from std to "Deno" namespace * use "Deno.test()" to run internal JS unit tests * remove std downloads for Deno subcommands
2020-02-11 06:01:56 -05:00
export interface TestDefinition {
refactor(cli/js/testing): Reduce testing interfaces (#4451) * Reduce "testing" interfaces * Use a callback instead of a generator for Deno.runTests() * Default RunTestsOptions::reportToConsole to true * Compose TestMessage into a single interface
2020-04-01 04:47:23 -04:00
fn: () => void | Promise<void>;
refactor: rewrite deno test, add Deno.test() (#3865) * rewrite test runner in Rust * migrate "test" and "runTests" functions from std to "Deno" namespace * use "Deno.test()" to run internal JS unit tests * remove std downloads for Deno subcommands
2020-02-11 06:01:56 -05:00
name: string;
refactor: rename Deno.TestDefinition.skip to ignore (#4400)
2020-03-19 05:58:12 -04:00
ignore?: boolean;
refactor(cli/js/testing): Rename disableOpSanitizer to sanitizeOps (#4854) * rename disableOpSanitizer to sanitizeOps * rename disableResourceSanitizer to sanitizeResources
2020-04-23 08:40:16 -04:00
sanitizeOps?: boolean;
sanitizeResources?: boolean;
refactor: rewrite deno test, add Deno.test() (#3865) * rewrite test runner in Rust * migrate "test" and "runTests" functions from std to "Deno" namespace * use "Deno.test()" to run internal JS unit tests * remove std downloads for Deno subcommands
2020-02-11 06:01:56 -05:00
}
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** 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, or explicitly
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* when `Deno.runTests` is used. `fn` can be async if required.
*
* import {assert, fail, assertEquals} from "https://deno.land/std/testing/asserts.ts";
*
* Deno.test({
* name: "example test",
* fn(): void {
* assertEquals("world", "world");
* },
* });
*
* Deno.test({
* name: "example ignored test",
* ignore: Deno.build.os === "win"
* fn(): void {
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* // This test is ignored only on Windows machines
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* },
* });
*
* 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")
* }
* });
*/
refactor: rewrite deno test, add Deno.test() (#3865) * rewrite test runner in Rust * migrate "test" and "runTests" functions from std to "Deno" namespace * use "Deno.test()" to run internal JS unit tests * remove std downloads for Deno subcommands
2020-02-11 06:01:56 -05:00
export function test(t: TestDefinition): void;
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** 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, or explicitly
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* when `Deno.runTests` is used
*
* import {assert, fail, assertEquals} from "https://deno.land/std/testing/asserts.ts";
*
* Deno.test(function myTestFunction():void {
* assertEquals("hello", "hello");
* });
*
* Deno.test(async function myAsyncTestFunction():Promise<void> {
* const decoder = new TextDecoder("utf-8");
* const data = await Deno.readFile("hello_world.txt");
* assertEquals(decoder.decode(data), "Hello world")
* });
**/
refactor(cli/js/testing): Reduce testing interfaces (#4451) * Reduce "testing" interfaces * Use a callback instead of a generator for Deno.runTests() * Default RunTestsOptions::reportToConsole to true * Compose TestMessage into a single interface
2020-04-01 04:47:23 -04:00
export function test(fn: () => void | Promise<void>): void;
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** 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, or explicitly
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* when `Deno.runTests` is used
*
* import {assert, fail, assertEquals} from "https://deno.land/std/testing/asserts.ts";
*
* Deno.test("My test description", ():void => {
* assertEquals("hello", "hello");
* });
*
* Deno.test("My async test description", async ():Promise<void> => {
* const decoder = new TextDecoder("utf-8");
* const data = await Deno.readFile("hello_world.txt");
* assertEquals(decoder.decode(data), "Hello world")
* });
* */
refactor(cli/js/testing): Reduce testing interfaces (#4451) * Reduce "testing" interfaces * Use a callback instead of a generator for Deno.runTests() * Default RunTestsOptions::reportToConsole to true * Compose TestMessage into a single interface
2020-04-01 04:47:23 -04:00
export function test(name: string, fn: () => void | Promise<void>): void;
export interface TestMessage {
start?: {
tests: TestDefinition[];
};
testStart?: {
[P in keyof TestDefinition]: TestDefinition[P];
};
testEnd?: {
name: string;
status: "passed" | "failed" | "ignored";
duration: number;
error?: Error;
};
end?: {
filtered: number;
ignored: number;
measured: number;
passed: number;
failed: number;
duration: number;
results: Array<TestMessage["testEnd"] & {}>;
};
refactor: unit test runner communicates using TCP socket (#4336) Rewrites "cli/js/unit_test_runner.ts" to communicate with spawned subprocesses using TCP socket. * Rewrite "Deno.runTests()" by factoring out testing logic to private "TestApi" class. "TestApi" implements "AsyncIterator" that yields "TestEvent"s, which is an interface for different types of event occuring during running tests. * Add "reporter" argument to "Deno.runTests()" to allow users to provide custom reporting mechanism for tests. It's represented by "TestReporter" interface, that implements hook functions for each type of "TestEvent". If "reporter" is not provided then default console reporting is used (via "ConsoleReporter"). * Change how "unit_test_runner" communicates with spawned suprocesses. Instead of parsing text data from child's stdout, a TCP socket is created and used for communication. "unit_test_runner" can run in either "master" or "worker" mode. Former is responsible for test discovery and establishing needed permission combinations; while latter (that is spawned by "master") executes tests that match given permission set. * Use "SocketReporter" that implements "TestReporter" interface to send output of tests to "master" process. Data is sent as stringified JSON and then parsed by "master" as structured data. "master" applies it's own reporting logic to output tests to console (by reusing default "ConsoleReporter").
2020-03-13 10:57:32 -04:00
}
refactor: rewrite deno test, add Deno.test() (#3865) * rewrite test runner in Rust * migrate "test" and "runTests" functions from std to "Deno" namespace * use "Deno.test()" to run internal JS unit tests * remove std downloads for Deno subcommands
2020-02-11 06:01:56 -05:00
export interface RunTestsOptions {
refactor: preliminary cleanup of Deno.runTests() (#4237) * refactor: preliminary cleanup of Deno.runTests() * Change time measurement to use new Date() instead of performance.now(). Because there is no guarantee that tests are run with "--allow-hr" using new Date() guarantees higher precision of 1ms instead of 2ms. * Support String type filter in "skip" and "only". * Split "exitOnFail" into "exitOnFail" and "failFast". Former tells if "runTests()" should exit with code 1 on test failure, while latter tells if "runTests()" should stop running tests on first failure. * Use "defer" to wait for unhandled promise rejection - this bit is funky and doesn't seem right, but for now it's just a rewrite from using "setTimeout". Intended to be fixed in later commits. * Remove global "__DENO_TEST_REGISTRY", don't expose list of registered tests (to be addressed in follow up commits) * Remove arbitrary slow test threshold; use uniform coloring instead
2020-03-05 05:52:18 -05:00
/** If `true`, Deno will exit with status code 1 if there was
* test failure. Defaults to `true`. */
refactor: rewrite deno test, add Deno.test() (#3865) * rewrite test runner in Rust * migrate "test" and "runTests" functions from std to "Deno" namespace * use "Deno.test()" to run internal JS unit tests * remove std downloads for Deno subcommands
2020-02-11 06:01:56 -05:00
exitOnFail?: boolean;
refactor(cli/js/testing): Reduce testing interfaces (#4451) * Reduce "testing" interfaces * Use a callback instead of a generator for Deno.runTests() * Default RunTestsOptions::reportToConsole to true * Compose TestMessage into a single interface
2020-04-01 04:47:23 -04:00
/** If `true`, Deno will exit upon first test failure. Defaults to `false`. */
refactor: preliminary cleanup of Deno.runTests() (#4237) * refactor: preliminary cleanup of Deno.runTests() * Change time measurement to use new Date() instead of performance.now(). Because there is no guarantee that tests are run with "--allow-hr" using new Date() guarantees higher precision of 1ms instead of 2ms. * Support String type filter in "skip" and "only". * Split "exitOnFail" into "exitOnFail" and "failFast". Former tells if "runTests()" should exit with code 1 on test failure, while latter tells if "runTests()" should stop running tests on first failure. * Use "defer" to wait for unhandled promise rejection - this bit is funky and doesn't seem right, but for now it's just a rewrite from using "setTimeout". Intended to be fixed in later commits. * Remove global "__DENO_TEST_REGISTRY", don't expose list of registered tests (to be addressed in follow up commits) * Remove arbitrary slow test threshold; use uniform coloring instead
2020-03-05 05:52:18 -05:00
failFast?: boolean;
/** String or RegExp used to filter test to run. Only test with names
* matching provided `String` or `RegExp` will be run. */
feat: deno test --filter (#4570)
2020-04-02 09:26:40 -04:00
filter?: string | RegExp;
refactor: preliminary cleanup of Deno.runTests() (#4237) * refactor: preliminary cleanup of Deno.runTests() * Change time measurement to use new Date() instead of performance.now(). Because there is no guarantee that tests are run with "--allow-hr" using new Date() guarantees higher precision of 1ms instead of 2ms. * Support String type filter in "skip" and "only". * Split "exitOnFail" into "exitOnFail" and "failFast". Former tells if "runTests()" should exit with code 1 on test failure, while latter tells if "runTests()" should stop running tests on first failure. * Use "defer" to wait for unhandled promise rejection - this bit is funky and doesn't seem right, but for now it's just a rewrite from using "setTimeout". Intended to be fixed in later commits. * Remove global "__DENO_TEST_REGISTRY", don't expose list of registered tests (to be addressed in follow up commits) * Remove arbitrary slow test threshold; use uniform coloring instead
2020-03-05 05:52:18 -05:00
/** String or RegExp used to skip tests to run. Tests with names
* matching provided `String` or `RegExp` will not be run. */
skip?: string | RegExp;
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** Disable logging of the results. Defaults to `false`. */
refactor: rewrite deno test, add Deno.test() (#3865) * rewrite test runner in Rust * migrate "test" and "runTests" functions from std to "Deno" namespace * use "Deno.test()" to run internal JS unit tests * remove std downloads for Deno subcommands
2020-02-11 06:01:56 -05:00
disableLog?: boolean;
refactor(cli/js/testing): Reduce testing interfaces (#4451) * Reduce "testing" interfaces * Use a callback instead of a generator for Deno.runTests() * Default RunTestsOptions::reportToConsole to true * Compose TestMessage into a single interface
2020-04-01 04:47:23 -04:00
/** If true, report results to the console as is done for `deno test`. Defaults to `true`. */
reportToConsole?: boolean;
/** Called for each message received from the test run. */
onMessage?: (message: TestMessage) => void | Promise<void>;
refactor: rewrite deno test, add Deno.test() (#3865) * rewrite test runner in Rust * migrate "test" and "runTests" functions from std to "Deno" namespace * use "Deno.test()" to run internal JS unit tests * remove std downloads for Deno subcommands
2020-02-11 06:01:56 -05:00
}
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
/** Run any tests which have been registered via `Deno.test()`. Always resolves
* asynchronously.
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* // Register test
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* Deno.test({
* name: "example test",
* fn(): void {
* assertEquals("world", "world");
* assertEquals({ hello: "world" }, { hello: "world" });
* },
* });
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* // Run tests
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* const runInfo = await Deno.runTests();
* console.log(runInfo.duration); // all tests duration, e.g. "5" (in ms)
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* console.log(runInfo.stats.passed); // e.g. 1
* console.log(runInfo.results[0].name); // e.g. "example test"
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
*/
refactor: unit test runner communicates using TCP socket (#4336) Rewrites "cli/js/unit_test_runner.ts" to communicate with spawned subprocesses using TCP socket. * Rewrite "Deno.runTests()" by factoring out testing logic to private "TestApi" class. "TestApi" implements "AsyncIterator" that yields "TestEvent"s, which is an interface for different types of event occuring during running tests. * Add "reporter" argument to "Deno.runTests()" to allow users to provide custom reporting mechanism for tests. It's represented by "TestReporter" interface, that implements hook functions for each type of "TestEvent". If "reporter" is not provided then default console reporting is used (via "ConsoleReporter"). * Change how "unit_test_runner" communicates with spawned suprocesses. Instead of parsing text data from child's stdout, a TCP socket is created and used for communication. "unit_test_runner" can run in either "master" or "worker" mode. Former is responsible for test discovery and establishing needed permission combinations; while latter (that is spawned by "master") executes tests that match given permission set. * Use "SocketReporter" that implements "TestReporter" interface to send output of tests to "master" process. Data is sent as stringified JSON and then parsed by "master" as structured data. "master" applies it's own reporting logic to output tests to console (by reusing default "ConsoleReporter").
2020-03-13 10:57:32 -04:00
export function runTests(
opts?: RunTestsOptions
refactor(cli/js/testing): Reduce testing interfaces (#4451) * Reduce "testing" interfaces * Use a callback instead of a generator for Deno.runTests() * Default RunTestsOptions::reportToConsole to true * Compose TestMessage into a single interface
2020-04-01 04:47:23 -04:00
): Promise<TestMessage["end"]> & {};
refactor: rewrite deno test, add Deno.test() (#3865) * rewrite test runner in Rust * migrate "test" and "runTests" functions from std to "Deno" namespace * use "Deno.test()" to run internal JS unit tests * remove std downloads for Deno subcommands
2020-02-11 06:01:56 -05:00
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
/** 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.
feat(std/node): add os.loadavg() (#4075)
2020-02-22 18:46:52 -05:00
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* console.log(Deno.loadavg()); // e.g. [ 0.71, 0.44, 0.44 ]
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
*
* Requires `allow-env` permission.
feat(std/node): add os.loadavg() (#4075)
2020-02-22 18:46:52 -05:00
*/
export function loadavg(): number[];
refactor: rename ConsoleOptions to InspectOptions (#4493)
2020-03-25 20:48:47 -04:00
/** Get the `hostname` of the machine the Deno process is running on.
Add Deno.hostname() (#3032)
2019-09-27 19:09:42 -04:00
*
* console.log(Deno.hostname());
refactor: rename ConsoleOptions to InspectOptions (#4493)
2020-03-25 20:48:47 -04:00
*
* Requires `allow-env` permission.
Add Deno.hostname() (#3032)
2019-09-27 19:09:42 -04:00
*/
export function hostname(): string;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
/** Returns the release version of the Operating System.
Add missing node os.release() implementation (#4065)
2020-02-24 08:35:45 -05:00
*
* console.log(Deno.osRelease());
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
*
* Requires `allow-env` permission.
Add missing node os.release() implementation (#4065)
2020-02-24 08:35:45 -05:00
*/
export function osRelease(): string;
doc: improve various API docs and include examples (#4486)
2020-03-24 23:54:41 -04:00
/** Exit the Deno process with optional exit code. If no exit code is supplied
* then Deno will exit with return code of 0.
*
* Deno.exit(5);
*/
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export function exit(code?: number): never;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
/** Returns a snapshot of the environment variables at invocation. Changing a
* property in the object will set that variable in the environment for the
* process. The environment object will only accept `string`s as values.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* const myEnv = Deno.env();
* console.log(myEnv.SHELL);
* myEnv.TEST_VAR = "HELLO";
* const newEnv = Deno.env();
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* console.log(myEnv.TEST_VAR === newEnv.TEST_VAR); // outputs "true"
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* Requires `allow-env` permission. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export function env(): {
[index: string]: string;
};
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
/** Retrieve the value of an environment variable. Returns undefined if that
* key doesn't exist.
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* console.log(Deno.env("HOME")); // e.g. outputs "/home/alice"
* console.log(Deno.env("MADE_UP_VAR")); // outputs "Undefined"
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
*
* Requires `allow-env` permission. */
feat: Add support for passing a key to Deno.env() (#2952) This adds a new op to get a single env var.
2019-10-02 11:55:28 -04:00
export function env(key: string): string | undefined;
Reduce all directory functions to Deno.dir() (#3518)
2019-12-18 09:29:00 -05:00
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE** */
Reduce all directory functions to Deno.dir() (#3518)
2019-12-18 09:29:00 -05:00
export type DirKind =
| "home"
| "cache"
| "config"
feat: Add Deno.dir("executable") (#3526)
2019-12-21 06:30:13 -05:00
| "executable"
Reduce all directory functions to Deno.dir() (#3518)
2019-12-18 09:29:00 -05:00
| "data"
| "data_local"
| "audio"
| "desktop"
| "document"
| "download"
| "font"
| "picture"
| "public"
| "template"
feat(std/node): add os.tmpdir() implementation (#4213)
2020-03-01 19:05:04 -05:00
| "tmp"
Reduce all directory functions to Deno.dir() (#3518)
2019-12-18 09:29:00 -05:00
| "video";
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
/**
doc: improve various API docs and include examples (#4486)
2020-03-24 23:54:41 -04:00
* **UNSTABLE**: Currently under evaluation to decide if method name `dir` and
* parameter type alias name `DirKind` should be renamed.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Reduce all directory functions to Deno.dir() (#3518)
2019-12-18 09:29:00 -05:00
* Returns the user and platform specific directories.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
doc: improve various API docs and include examples (#4486)
2020-03-24 23:54:41 -04:00
* const homeDirectory = Deno.dir("home");
*
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* Requires `allow-env` permission.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
* Returns `null` if there is no applicable directory or if any other error
feat: Return null on error in Deno.dir() (#3531)
2019-12-20 19:06:07 -05:00
* occurs.
Reduce all directory functions to Deno.dir() (#3518)
2019-12-18 09:29:00 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Argument values: `"home"`, `"cache"`, `"config"`, `"executable"`, `"data"`,
* `"data_local"`, `"audio"`, `"desktop"`, `"document"`, `"download"`,
feat(std/node): add os.tmpdir() implementation (#4213)
2020-03-01 19:05:04 -05:00
* `"font"`, `"picture"`, `"public"`, `"template"`, `"tmp"`, `"video"`
Reduce all directory functions to Deno.dir() (#3518)
2019-12-18 09:29:00 -05:00
*
doc: improve various API docs and include examples (#4486)
2020-03-24 23:54:41 -04:00
* `"home"`
*
* |Platform | Value | Example |
* | ------- | -----------------------------------------| -----------------------|
* | Linux | `$HOME` | /home/alice |
* | macOS | `$HOME` | /Users/alice |
* | Windows | `{FOLDERID_Profile}` | C:\Users\Alice |
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* `"cache"`
Fix: jsDoc for Deno.dir() (#3888)
2020-02-05 15:41:55 -05:00
*
Feat: Add more dir APIs for Deno (#3491)
2019-12-15 00:14:20 -05:00
* |Platform | Value | Example |
* | ------- | ----------------------------------- | ---------------------------- |
* | Linux | `$XDG_CACHE_HOME` or `$HOME`/.cache | /home/alice/.cache |
* | macOS | `$HOME`/Library/Caches | /Users/Alice/Library/Caches |
* | Windows | `{FOLDERID_LocalAppData}` | C:\Users\Alice\AppData\Local |
Reduce all directory functions to Deno.dir() (#3518)
2019-12-18 09:29:00 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* `"config"`
Fix: jsDoc for Deno.dir() (#3888)
2020-02-05 15:41:55 -05:00
*
Feat: Add more dir APIs for Deno (#3491)
2019-12-15 00:14:20 -05:00
* |Platform | Value | Example |
* | ------- | ------------------------------------- | -------------------------------- |
* | Linux | `$XDG_CONFIG_HOME` or `$HOME`/.config | /home/alice/.config |
* | macOS | `$HOME`/Library/Preferences | /Users/Alice/Library/Preferences |
* | Windows | `{FOLDERID_RoamingAppData}` | C:\Users\Alice\AppData\Roaming |
Reduce all directory functions to Deno.dir() (#3518)
2019-12-18 09:29:00 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* `"executable"`
Fix: jsDoc for Deno.dir() (#3888)
2020-02-05 15:41:55 -05:00
*
feat: Add Deno.dir("executable") (#3526)
2019-12-21 06:30:13 -05:00
* |Platform | Value | Example |
* | ------- | --------------------------------------------------------------- | -----------------------|
* | Linux | `XDG_BIN_HOME` or `$XDG_DATA_HOME`/../bin or `$HOME`/.local/bin | /home/alice/.local/bin |
* | macOS | - | - |
* | Windows | - | - |
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* `"data"`
Fix: jsDoc for Deno.dir() (#3888)
2020-02-05 15:41:55 -05:00
*
Feat: Add more dir APIs for Deno (#3491)
2019-12-15 00:14:20 -05:00
* |Platform | Value | Example |
* | ------- | ---------------------------------------- | ---------------------------------------- |
* | Linux | `$XDG_DATA_HOME` or `$HOME`/.local/share | /home/alice/.local/share |
* | macOS | `$HOME`/Library/Application Support | /Users/Alice/Library/Application Support |
* | Windows | `{FOLDERID_RoamingAppData}` | C:\Users\Alice\AppData\Roaming |
Reduce all directory functions to Deno.dir() (#3518)
2019-12-18 09:29:00 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* `"data_local"`
Fix: jsDoc for Deno.dir() (#3888)
2020-02-05 15:41:55 -05:00
*
Feat: Add more dir APIs for Deno (#3491)
2019-12-15 00:14:20 -05:00
* |Platform | Value | Example |
* | ------- | ---------------------------------------- | ---------------------------------------- |
* | Linux | `$XDG_DATA_HOME` or `$HOME`/.local/share | /home/alice/.local/share |
* | macOS | `$HOME`/Library/Application Support | /Users/Alice/Library/Application Support |
* | Windows | `{FOLDERID_LocalAppData}` | C:\Users\Alice\AppData\Local |
Reduce all directory functions to Deno.dir() (#3518)
2019-12-18 09:29:00 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* `"audio"`
Fix: jsDoc for Deno.dir() (#3888)
2020-02-05 15:41:55 -05:00
*
Feat: Add more dir APIs for Deno (#3491)
2019-12-15 00:14:20 -05:00
* |Platform | Value | Example |
* | ------- | ------------------ | -------------------- |
* | Linux | `XDG_MUSIC_DIR` | /home/alice/Music |
* | macOS | `$HOME`/Music | /Users/Alice/Music |
* | Windows | `{FOLDERID_Music}` | C:\Users\Alice\Music |
Reduce all directory functions to Deno.dir() (#3518)
2019-12-18 09:29:00 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* `"desktop"`
Fix: jsDoc for Deno.dir() (#3888)
2020-02-05 15:41:55 -05:00
*
Feat: Add more dir APIs for Deno (#3491)
2019-12-15 00:14:20 -05:00
* |Platform | Value | Example |
* | ------- | -------------------- | ---------------------- |
* | Linux | `XDG_DESKTOP_DIR` | /home/alice/Desktop |
* | macOS | `$HOME`/Desktop | /Users/Alice/Desktop |
* | Windows | `{FOLDERID_Desktop}` | C:\Users\Alice\Desktop |
Reduce all directory functions to Deno.dir() (#3518)
2019-12-18 09:29:00 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* `"document"`
Fix: jsDoc for Deno.dir() (#3888)
2020-02-05 15:41:55 -05:00
*
Feat: Add more dir APIs for Deno (#3491)
2019-12-15 00:14:20 -05:00
* |Platform | Value | Example |
* | ------- | ---------------------- | ------------------------ |
* | Linux | `XDG_DOCUMENTS_DIR` | /home/alice/Documents |
* | macOS | `$HOME`/Documents | /Users/Alice/Documents |
* | Windows | `{FOLDERID_Documents}` | C:\Users\Alice\Documents |
Reduce all directory functions to Deno.dir() (#3518)
2019-12-18 09:29:00 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* `"download"`
Fix: jsDoc for Deno.dir() (#3888)
2020-02-05 15:41:55 -05:00
*
Feat: Add more dir APIs for Deno (#3491)
2019-12-15 00:14:20 -05:00
* |Platform | Value | Example |
* | ------- | ---------------------- | ------------------------ |
* | Linux | `XDG_DOWNLOAD_DIR` | /home/alice/Downloads |
* | macOS | `$HOME`/Downloads | /Users/Alice/Downloads |
* | Windows | `{FOLDERID_Downloads}` | C:\Users\Alice\Downloads |
Reduce all directory functions to Deno.dir() (#3518)
2019-12-18 09:29:00 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* `"font"`
Fix: jsDoc for Deno.dir() (#3888)
2020-02-05 15:41:55 -05:00
*
Feat: Add more dir APIs for Deno (#3491)
2019-12-15 00:14:20 -05:00
* |Platform | Value | Example |
* | ------- | ---------------------------------------------------- | ------------------------------ |
* | Linux | `$XDG_DATA_HOME`/fonts or `$HOME`/.local/share/fonts | /home/alice/.local/share/fonts |
* | macOS | `$HOME/Library/Fonts` | /Users/Alice/Library/Fonts |
* | Windows | – | – |
Reduce all directory functions to Deno.dir() (#3518)
2019-12-18 09:29:00 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* `"picture"`
Fix: jsDoc for Deno.dir() (#3888)
2020-02-05 15:41:55 -05:00
*
Feat: Add more dir APIs for Deno (#3491)
2019-12-15 00:14:20 -05:00
* |Platform | Value | Example |
* | ------- | --------------------- | ----------------------- |
* | Linux | `XDG_PICTURES_DIR` | /home/alice/Pictures |
* | macOS | `$HOME`/Pictures | /Users/Alice/Pictures |
* | Windows | `{FOLDERID_Pictures}` | C:\Users\Alice\Pictures |
Reduce all directory functions to Deno.dir() (#3518)
2019-12-18 09:29:00 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* `"public"`
Fix: jsDoc for Deno.dir() (#3888)
2020-02-05 15:41:55 -05:00
*
Feat: Add more dir APIs for Deno (#3491)
2019-12-15 00:14:20 -05:00
* |Platform | Value | Example |
* | ------- | --------------------- | ------------------- |
* | Linux | `XDG_PUBLICSHARE_DIR` | /home/alice/Public |
* | macOS | `$HOME`/Public | /Users/Alice/Public |
* | Windows | `{FOLDERID_Public}` | C:\Users\Public |
Reduce all directory functions to Deno.dir() (#3518)
2019-12-18 09:29:00 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* `"template"`
Fix: jsDoc for Deno.dir() (#3888)
2020-02-05 15:41:55 -05:00
*
Feat: Add more dir APIs for Deno (#3491)
2019-12-15 00:14:20 -05:00
* |Platform | Value | Example |
* | ------- | ---------------------- | ---------------------------------------------------------- |
* | Linux | `XDG_TEMPLATES_DIR` | /home/alice/Templates |
* | macOS | – | – |
* | Windows | `{FOLDERID_Templates}` | C:\Users\Alice\AppData\Roaming\Microsoft\Windows\Templates |
Reduce all directory functions to Deno.dir() (#3518)
2019-12-18 09:29:00 -05:00
*
feat(std/node): add os.tmpdir() implementation (#4213)
2020-03-01 19:05:04 -05:00
* `"tmp"`
*
* |Platform | Value | Example |
* | ------- | ---------------------- | ---------------------------------------------------------- |
* | Linux | `TMPDIR` | /tmp |
* | macOS | `TMPDIR` | /tmp |
* | Windows | `{TMP}` | C:\Users\Alice\AppData\Local\Temp |
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* `"video"`
Fix: jsDoc for Deno.dir() (#3888)
2020-02-05 15:41:55 -05:00
*
Feat: Add more dir APIs for Deno (#3491)
2019-12-15 00:14:20 -05:00
* |Platform | Value | Example |
* | ------- | ------------------- | --------------------- |
* | Linux | `XDG_VIDEOS_DIR` | /home/alice/Videos |
* | macOS | `$HOME`/Movies | /Users/Alice/Movies |
* | Windows | `{FOLDERID_Videos}` | C:\Users\Alice\Videos |
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
Feat: Add more dir APIs for Deno (#3491)
2019-12-15 00:14:20 -05:00
*/
feat: Return null on error in Deno.dir() (#3531)
2019-12-20 19:06:07 -05:00
export function dir(kind: DirKind): string | null;
Reduce all directory functions to Deno.dir() (#3518)
2019-12-18 09:29:00 -05:00
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
/**
* Returns the path to the current deno executable.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* console.log(Deno.execPath()); // e.g. "/home/alice/.local/bin/deno"
doc: improve various API docs and include examples (#4486)
2020-03-24 23:54:41 -04:00
*
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* Requires `allow-env` permission.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*/
export function execPath(): string;
/**
doc: improve various API docs and include examples (#4486)
2020-03-24 23:54:41 -04:00
* **UNSTABLE**: Currently under evaluation to decide if explicit permission is
* required to get the value of the current working directory.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
* 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.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
doc: improve various API docs and include examples (#4486)
2020-03-24 23:54:41 -04:00
* const currentWorkingDirectory = Deno.cwd();
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Throws `Deno.errors.NotFound` if directory not available.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*/
export function cwd(): string;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
/**
Improve API docs for Deno.bundle and Deno.chdir (#4426)
2020-03-18 19:40:06 -04:00
* **UNSTABLE**: Currently under evaluation to decide if explicit permission is
* required to change the current working directory.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* Change the current working directory to the specified path.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
Improve API docs for Deno.bundle and Deno.chdir (#4426)
2020-03-18 19:40:06 -04:00
* Deno.chdir("/home/userA");
* Deno.chdir("../userB");
* Deno.chdir("C:\\Program Files (x86)\\Java");
*
* Throws `Deno.errors.NotFound` if directory not found.
* Throws `Deno.errors.PermissionDenied` if the user does not have access
* rights
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*/
export function chdir(directory: string): void;
Add Deno.umask (#4290)
2020-03-10 15:11:27 -04:00
/**
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* **UNSTABLE**: New API, yet to be vetted. This API is under consideration to
* determine if permissions are required to call it.
Add Deno.umask (#4290)
2020-03-10 15:11:27 -04:00
*
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* Retrieve the process umask. If `mask` is provided, sets the process umask.
* This call always returns what the umask was before the call.
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* 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)
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
*
* NOTE: This API is not implemented on Windows
Add Deno.umask (#4290)
2020-03-10 15:11:27 -04:00
*/
export function umask(mask?: number): number;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE**: might move to `Deno.symbols`. */
Make EOF unique symbol (#3244)
2019-10-31 10:57:09 -04:00
export const EOF: unique symbol;
export type EOF = typeof EOF;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE**: might remove `"SEEK_"` prefix. Might not use all-caps. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export enum SeekMode {
SEEK_START = 0,
SEEK_CURRENT = 1,
Update to Prettier 2 and use ES Private Fields (#4498)
2020-03-28 13:03:49 -04:00
SEEK_END = 2,
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
}
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export interface Reader {
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** Reads up to `p.byteLength` bytes into `p`. It resolves to the number of
* bytes read (`0` < `n` <= `p.byteLength`) and rejects if any error
* encountered. Even if `read()` resolves to `n` < `p.byteLength`, it may
* use all of `p` as scratch space during the call. If some data is
* available but not `p.byteLength` bytes, `read()` conventionally resolves
* to what is available instead of waiting for more.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* When `read()` encounters end-of-file condition, it resolves to
* `Deno.EOF` symbol.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* When `read()` encounters an error, it rejects with an error.
*
* Callers should always process the `n` > `0` bytes returned before
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* considering the `EOF`. Doing so correctly handles I/O errors that happen
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
* after reading some bytes and also both of the allowed EOF behaviors.
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Implementations should not retain a reference to `p`.
Add comments in Reader/SyncReader about iter/iterSync (#4852)
2020-04-22 16:00:48 -04:00
*
* Use Deno.iter() to turn a Reader into an AsyncIterator.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*/
read(p: Uint8Array): Promise<number | EOF>;
}
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export interface SyncReader {
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Reads up to `p.byteLength` bytes into `p`. It resolves to the number
* of bytes read (`0` < `n` <= `p.byteLength`) and rejects if any error
* encountered. Even if `read()` returns `n` < `p.byteLength`, it may use
* all of `p` as scratch space during the call. If some data is available
* but not `p.byteLength` bytes, `read()` conventionally returns what is
* available instead of waiting for more.
*
* When `readSync()` encounters end-of-file condition, it returns `Deno.EOF`
* symbol.
*
* When `readSync()` encounters an error, it throws with an error.
*
* Callers should always process the `n` > `0` bytes returned before
* considering the `EOF`. Doing so correctly handles I/O errors that happen
* after reading some bytes and also both of the allowed EOF behaviors.
*
* Implementations should not retain a reference to `p`.
Add comments in Reader/SyncReader about iter/iterSync (#4852)
2020-04-22 16:00:48 -04:00
*
* Use Deno.iterSync() to turn a SyncReader into an Iterator.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*/
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
readSync(p: Uint8Array): number | EOF;
}
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export interface Writer {
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** Writes `p.byteLength` bytes from `p` to the underlying data stream. It
* resolves to the number of bytes written from `p` (`0` <= `n` <=
* `p.byteLength`) or reject with the error encountered that caused the
* write to stop early. `write()` must reject with a non-null error if
* would resolve to `n` < `p.byteLength`. `write()` must not modify the
* slice data, even temporarily.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Implementations should not retain a reference to `p`.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*/
write(p: Uint8Array): Promise<number>;
}
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export interface SyncWriter {
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Writes `p.byteLength` bytes from `p` to the underlying data
* stream. It returns the number of bytes written from `p` (`0` <= `n`
* <= `p.byteLength`) and any error encountered that caused the write to
* stop early. `writeSync()` must throw a non-null error if it returns `n` <
* `p.byteLength`. `writeSync()` must not modify the slice data, even
* temporarily.
*
* Implementations should not retain a reference to `p`.
*/
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
writeSync(p: Uint8Array): number;
}
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export interface Closer {
close(): void;
}
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export interface Seeker {
/** Seek sets the offset for the next `read()` or `write()` to offset,
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* interpreted according to `whence`: `SEEK_START` means relative to the
* start of the file, `SEEK_CURRENT` means relative to the current offset,
* and `SEEK_END` means relative to the end. Seek resolves to the new offset
* relative to the start of the file.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* Seeking to an offset before the start of the file is an error. Seeking to
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* any positive offset is legal, but the behavior of subsequent I/O
* operations on the underlying object is implementation-dependent.
seek should return cursor position (#4211)
2020-03-02 11:44:46 -05:00
* It returns the number of cursor position.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*/
seek should return cursor position (#4211)
2020-03-02 11:44:46 -05:00
seek(offset: number, whence: SeekMode): Promise<number>;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
}
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export interface SyncSeeker {
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Seek sets the offset for the next `readSync()` or `writeSync()` to
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* offset, interpreted according to `whence`: `SEEK_START` means relative
* to the start of the file, `SEEK_CURRENT` means relative to the current
* offset, and `SEEK_END` means relative to the end.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
* Seeking to an offset before the start of the file is an error. Seeking to
* any positive offset is legal, but the behavior of subsequent I/O
* operations on the underlying object is implementation-dependent.
*/
seek should return cursor position (#4211)
2020-03-02 11:44:46 -05:00
seekSync(offset: number, whence: SeekMode): number;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
}
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export interface ReadCloser extends Reader, Closer {}
export interface WriteCloser extends Writer, Closer {}
export interface ReadSeeker extends Reader, Seeker {}
export interface WriteSeeker extends Writer, Seeker {}
export interface ReadWriteCloser extends Reader, Writer, Closer {}
export interface ReadWriteSeeker extends Reader, Writer, Seeker {}
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Copies from `src` to `dst` until either `EOF` is reached on `src` or an
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* error occurs. It resolves to the number of bytes copied or rejects with
* the first error encountered while copying.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
doc: improve various API docs and include examples (#4486)
2020-03-24 23:54:41 -04:00
* const source = await Deno.open("my_file.txt");
* const buffer = new Deno.Buffer()
BREAKING CHANGE: change order of args in Deno.copy() (#4885)
2020-04-24 18:09:14 -04:00
* const bytesCopied1 = await Deno.copy(source, Deno.stdout);
* const bytesCopied2 = await Deno.copy(source, buffer);
doc: improve various API docs and include examples (#4486)
2020-03-24 23:54:41 -04:00
*
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
* Because `copy()` is defined to read from `src` until `EOF`, it does not
* treat an `EOF` from `read()` as an error to be reported.
doc: improve various API docs and include examples (#4486)
2020-03-24 23:54:41 -04:00
*
* @param src The source to copy from
BREAKING CHANGE: change order of args in Deno.copy() (#4885)
2020-04-24 18:09:14 -04:00
* @param dst The destination to copy to
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*/
BREAKING CHANGE: change order of args in Deno.copy() (#4885)
2020-04-24 18:09:14 -04:00
export function copy(src: Reader, dst: Writer): Promise<number>;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
stabilize Deno.iter() and Deno.iterSync() (#4890)
2020-04-24 18:05:48 -04:00
/** Turns a Reader, `r`, into an async iterator.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
stabilize Deno.iter() and Deno.iterSync() (#4890)
2020-04-24 18:05:48 -04:00
* let f = await Deno.open("/etc/passwd");
* for await (const chunk of Deno.iter(f)) {
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* console.log(chunk);
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
* }
BREAKING CHANGE: rename Deno.toAsyncIterator() to Deno.iter() (#4848) * rename Deno.toAsyncIterator() to Deno.iter() * adds sync version Deno.iterSync() * adds optional second argument for buffer size
2020-04-22 15:30:45 -04:00
* f.close();
*
* Second argument can be used to tune size of a buffer.
stabilize Deno.iter() and Deno.iterSync() (#4890)
2020-04-24 18:05:48 -04:00
* Default size of the buffer is 32kB.
BREAKING CHANGE: rename Deno.toAsyncIterator() to Deno.iter() (#4848) * rename Deno.toAsyncIterator() to Deno.iter() * adds sync version Deno.iterSync() * adds optional second argument for buffer size
2020-04-22 15:30:45 -04:00
*
stabilize Deno.iter() and Deno.iterSync() (#4890)
2020-04-24 18:05:48 -04:00
* let f = await Deno.open("/etc/passwd");
* const iter = Deno.iter(f, {
* bufSize: 1024 * 1024
* });
* for await (const chunk of iter) {
BREAKING CHANGE: rename Deno.toAsyncIterator() to Deno.iter() (#4848) * rename Deno.toAsyncIterator() to Deno.iter() * adds sync version Deno.iterSync() * adds optional second argument for buffer size
2020-04-22 15:30:45 -04:00
* console.log(chunk);
* }
* f.close();
*
stabilize Deno.iter() and Deno.iterSync() (#4890)
2020-04-24 18:05:48 -04:00
* Iterator uses an internal buffer of fixed size for efficiency; it returns
* a view on that buffer on each iteration. It is therefore caller's
* responsibility to copy contents of the buffer if needed; otherwise the
BREAKING CHANGE: rename Deno.toAsyncIterator() to Deno.iter() (#4848) * rename Deno.toAsyncIterator() to Deno.iter() * adds sync version Deno.iterSync() * adds optional second argument for buffer size
2020-04-22 15:30:45 -04:00
* next iteration will overwrite contents of previously returned chunk.
*/
export function iter(
r: Reader,
stabilize Deno.iter() and Deno.iterSync() (#4890)
2020-04-24 18:05:48 -04:00
options?: {
bufSize?: number;
}
BREAKING CHANGE: rename Deno.toAsyncIterator() to Deno.iter() (#4848) * rename Deno.toAsyncIterator() to Deno.iter() * adds sync version Deno.iterSync() * adds optional second argument for buffer size
2020-04-22 15:30:45 -04:00
): AsyncIterableIterator<Uint8Array>;
stabilize Deno.iter() and Deno.iterSync() (#4890)
2020-04-24 18:05:48 -04:00
/** Turns a SyncReader, `r`, into an iterator.
BREAKING CHANGE: rename Deno.toAsyncIterator() to Deno.iter() (#4848) * rename Deno.toAsyncIterator() to Deno.iter() * adds sync version Deno.iterSync() * adds optional second argument for buffer size
2020-04-22 15:30:45 -04:00
*
stabilize Deno.iter() and Deno.iterSync() (#4890)
2020-04-24 18:05:48 -04:00
* let f = Deno.openSync("/etc/passwd");
* for (const chunk of Deno.iterSync(reader)) {
BREAKING CHANGE: rename Deno.toAsyncIterator() to Deno.iter() (#4848) * rename Deno.toAsyncIterator() to Deno.iter() * adds sync version Deno.iterSync() * adds optional second argument for buffer size
2020-04-22 15:30:45 -04:00
* console.log(chunk);
* }
* f.close();
*
* Second argument can be used to tune size of a buffer.
stabilize Deno.iter() and Deno.iterSync() (#4890)
2020-04-24 18:05:48 -04:00
* Default size of the buffer is 32kB.
BREAKING CHANGE: rename Deno.toAsyncIterator() to Deno.iter() (#4848) * rename Deno.toAsyncIterator() to Deno.iter() * adds sync version Deno.iterSync() * adds optional second argument for buffer size
2020-04-22 15:30:45 -04:00
*
stabilize Deno.iter() and Deno.iterSync() (#4890)
2020-04-24 18:05:48 -04:00
* let f = await Deno.open("/etc/passwd");
* const iter = Deno.iterSync(f, {
* bufSize: 1024 * 1024
* });
* for (const chunk of iter) {
BREAKING CHANGE: rename Deno.toAsyncIterator() to Deno.iter() (#4848) * rename Deno.toAsyncIterator() to Deno.iter() * adds sync version Deno.iterSync() * adds optional second argument for buffer size
2020-04-22 15:30:45 -04:00
* console.log(chunk);
* }
stabilize Deno.iter() and Deno.iterSync() (#4890)
2020-04-24 18:05:48 -04:00
* f.close();
BREAKING CHANGE: rename Deno.toAsyncIterator() to Deno.iter() (#4848) * rename Deno.toAsyncIterator() to Deno.iter() * adds sync version Deno.iterSync() * adds optional second argument for buffer size
2020-04-22 15:30:45 -04:00
*
stabilize Deno.iter() and Deno.iterSync() (#4890)
2020-04-24 18:05:48 -04:00
* Iterator uses an internal buffer of fixed size for efficiency; it returns
* a view on that buffer on each iteration. It is therefore caller's
* responsibility to copy contents of the buffer if needed; otherwise the
BREAKING CHANGE: rename Deno.toAsyncIterator() to Deno.iter() (#4848) * rename Deno.toAsyncIterator() to Deno.iter() * adds sync version Deno.iterSync() * adds optional second argument for buffer size
2020-04-22 15:30:45 -04:00
* next iteration will overwrite contents of previously returned chunk.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*/
BREAKING CHANGE: rename Deno.toAsyncIterator() to Deno.iter() (#4848) * rename Deno.toAsyncIterator() to Deno.iter() * adds sync version Deno.iterSync() * adds optional second argument for buffer size
2020-04-22 15:30:45 -04:00
export function iterSync(
r: SyncReader,
stabilize Deno.iter() and Deno.iterSync() (#4890)
2020-04-24 18:05:48 -04:00
options?: {
bufSize?: number;
}
BREAKING CHANGE: rename Deno.toAsyncIterator() to Deno.iter() (#4848) * rename Deno.toAsyncIterator() to Deno.iter() * adds sync version Deno.iterSync() * adds optional second argument for buffer size
2020-04-22 15:30:45 -04:00
): IterableIterator<Uint8Array>;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
/** Synchronously open a file and return an instance of `Deno.File`. The
* file does not need to previously exist if using the `create` or `createNew`
* open options. It is the callers responsibility to close the file when finished
* with it.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* const file = Deno.openSync("/foo/bar.txt", { read: true, write: true });
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* // Do work with file
* Deno.close(file.rid);
Implemented alternative open mode in files (#3119) Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
2020-01-21 04:49:42 -05:00
*
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* Requires `allow-read` and/or `allow-write` permissions depending on options.
Implemented alternative open mode in files (#3119) Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
2020-01-21 04:49:42 -05:00
*/
Rename name/filename arguments to path (#4227) There's a lot of variation in doc comments and internal code about whether the first parameter to file system calls is `path` or `name` or `filename`. For consistency, have made it always be `path`.
2020-03-06 11:29:23 -05:00
export function openSync(path: string, options?: OpenOptions): File;
Implemented alternative open mode in files (#3119) Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
2020-01-21 04:49:42 -05:00
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
/** Open a file and resolve to an instance of `Deno.File`. The
* file does not need to previously exist if using the `create` or `createNew`
* open options. It is the callers responsibility to close the file when finished
* with it.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* const file = await Deno.open("/foo/bar.txt", { read: true, write: true });
* // Do work with file
* Deno.close(file.rid);
Implemented alternative open mode in files (#3119) Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
2020-01-21 04:49:42 -05:00
*
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* Requires `allow-read` and/or `allow-write` permissions depending on options.
Implemented alternative open mode in files (#3119) Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
2020-01-21 04:49:42 -05:00
*/
Rename name/filename arguments to path (#4227) There's a lot of variation in doc comments and internal code about whether the first parameter to file system calls is `path` or `name` or `filename`. For consistency, have made it always be `path`.
2020-03-06 11:29:23 -05:00
export function open(path: string, options?: OpenOptions): Promise<File>;
Implemented alternative open mode in files (#3119) Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
2020-01-21 04:49:42 -05:00
feat: Deno.create (#3629)
2020-01-08 17:07:03 -05:00
/** Creates a file if none exists or truncates an existing file and returns
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* an instance of `Deno.File`.
feat: Deno.create (#3629)
2020-01-08 17:07:03 -05:00
*
* const file = Deno.createSync("/foo/bar.txt");
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-read` and `allow-write` permissions.
feat: Deno.create (#3629)
2020-01-08 17:07:03 -05:00
*/
Rename name/filename arguments to path (#4227) There's a lot of variation in doc comments and internal code about whether the first parameter to file system calls is `path` or `name` or `filename`. For consistency, have made it always be `path`.
2020-03-06 11:29:23 -05:00
export function createSync(path: string): File;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** Creates a file if none exists or truncates an existing file and resolves to
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* an instance of `Deno.File`.
feat: Deno.create (#3629)
2020-01-08 17:07:03 -05:00
*
* const file = await Deno.create("/foo/bar.txt");
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-read` and `allow-write` permissions.
feat: Deno.create (#3629)
2020-01-08 17:07:03 -05:00
*/
Rename name/filename arguments to path (#4227) There's a lot of variation in doc comments and internal code about whether the first parameter to file system calls is `path` or `name` or `filename`. For consistency, have made it always be `path`.
2020-03-06 11:29:23 -05:00
export function create(path: string): Promise<File>;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
better parameter names for a couple functions (#4559)
2020-04-01 12:57:33 -04:00
/** Synchronously read from a resource ID (`rid`) into an array buffer (`buffer`).
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* Returns either the number of bytes read during the operation or End Of File
* (`Symbol(EOF)`) if there was nothing to read.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* // if "/foo/bar.txt" contains the text "hello world":
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
* const file = Deno.openSync("/foo/bar.txt");
* const buf = new Uint8Array(100);
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* const numberOfBytesRead = Deno.readSync(file.rid, buf); // 11 bytes
* const text = new TextDecoder().decode(buf); // "hello world"
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* Deno.close(file.rid);
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*/
better parameter names for a couple functions (#4559)
2020-04-01 12:57:33 -04:00
export function readSync(rid: number, buffer: Uint8Array): number | EOF;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
better parameter names for a couple functions (#4559)
2020-04-01 12:57:33 -04:00
/** Read from a resource ID (`rid`) into an array buffer (`buffer`).
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* Resolves to either the number of bytes read during the operation or End Of
* File (`Symbol(EOF)`) if there was nothing to read.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* // if "/foo/bar.txt" contains the text "hello world":
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* const file = await Deno.open("/foo/bar.txt");
* const buf = new Uint8Array(100);
* const numberOfBytesRead = await Deno.read(file.rid, buf); // 11 bytes
* const text = new TextDecoder().decode(buf); // "hello world"
* Deno.close(file.rid);
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*/
better parameter names for a couple functions (#4559)
2020-04-01 12:57:33 -04:00
export function read(rid: number, buffer: Uint8Array): Promise<number | EOF>;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
better parameter names for a couple functions (#4559)
2020-04-01 12:57:33 -04:00
/** Synchronously write to the resource ID (`rid`) the contents of the array
* buffer (`data`).
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* Returns the number of bytes written.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* const encoder = new TextEncoder();
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* const data = encoder.encode("Hello world");
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
* const file = Deno.openSync("/foo/bar.txt");
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* const bytesWritten = Deno.writeSync(file.rid, data); // 11
* Deno.close(file.rid);
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*/
better parameter names for a couple functions (#4559)
2020-04-01 12:57:33 -04:00
export function writeSync(rid: number, data: Uint8Array): number;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
better parameter names for a couple functions (#4559)
2020-04-01 12:57:33 -04:00
/** Write to the resource ID (`rid`) the contents of the array buffer (`data`).
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* Resolves to the number of bytes written.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
* const encoder = new TextEncoder();
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* const data = encoder.encode("Hello world");
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
* const file = await Deno.open("/foo/bar.txt");
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* const bytesWritten = await Deno.write(file.rid, data); // 11
* Deno.close(file.rid);
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*/
better parameter names for a couple functions (#4559)
2020-04-01 12:57:33 -04:00
export function write(rid: number, data: Uint8Array): Promise<number>;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
/** Synchronously seek a resource ID (`rid`) to the given `offset` under mode
adjust docs for Deno.seek (#4610)
2020-04-03 13:45:44 -04:00
* given by `whence`. The new position within the resource (bytes from the
* start) is returned.
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
*
* const file = Deno.openSync('hello.txt', {read: true, write: true, truncate: true, create: true});
* Deno.writeSync(file.rid, new TextEncoder().encode("Hello world"));
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* // advance cursor 6 bytes
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* const cursorPosition = Deno.seekSync(file.rid, 6, Deno.SeekMode.SEEK_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:
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* // Given file.rid pointing to file with "Hello world", which is 11 bytes long:
* // Seek 6 bytes from the start of the file
* console.log(Deno.seekSync(file.rid, 6, Deno.SeekMode.SEEK_START)); // "6"
* // Seek 2 more bytes from the current position
* console.log(Deno.seekSync(file.rid, 2, Deno.SeekMode.SEEK_CURRENT)); // "8"
* // Seek backwards 2 bytes from the end of the file
* console.log(Deno.seekSync(file.rid, -2, Deno.SeekMode.SEEK_END)); // "9" (e.g. 11-2)
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*/
seek should return cursor position (#4211)
2020-03-02 11:44:46 -05:00
export function seekSync(
rid: number,
offset: number,
whence: SeekMode
): number;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
/** Seek a resource ID (`rid`) to the given `offset` under mode given by `whence`.
adjust docs for Deno.seek (#4610)
2020-04-03 13:45:44 -04:00
* The call resolves to the new position within the resource (bytes from the start).
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
*
* const file = await Deno.open('hello.txt', {read: true, write: true, truncate: true, create: true});
* await Deno.write(file.rid, new TextEncoder().encode("Hello world"));
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* // advance cursor 6 bytes
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* const cursorPosition = await Deno.seek(file.rid, 6, Deno.SeekMode.SEEK_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:
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* // Given file.rid pointing to file with "Hello world", which is 11 bytes long:
* // Seek 6 bytes from the start of the file
* console.log(await Deno.seek(file.rid, 6, Deno.SeekMode.SEEK_START)); // "6"
* // Seek 2 more bytes from the current position
* console.log(await Deno.seek(file.rid, 2, Deno.SeekMode.SEEK_CURRENT)); // "8"
* // Seek backwards 2 bytes from the end of the file
* console.log(await Deno.seek(file.rid, -2, Deno.SeekMode.SEEK_END)); // "9" (e.g. 11-2)
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*/
export function seek(
rid: number,
offset: number,
whence: SeekMode
seek should return cursor position (#4211)
2020-03-02 11:44:46 -05:00
): Promise<number>;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
doc: API improvements to chown, close, compile and connect (#4463)
2020-03-23 00:03:45 -04:00
/** Close the given resource ID (rid) which has been previously opened, such
* as via opening or creating a file. Closing a file when you are finished
* with it is important to avoid leaking resources.
*
doc: improve various API docs and include examples (#4486)
2020-03-24 23:54:41 -04:00
* const file = await Deno.open("my_file.txt");
* // do work with "file" object
* Deno.close(file.rid);
doc: API improvements to chown, close, compile and connect (#4463)
2020-03-23 00:03:45 -04:00
*/
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export function close(rid: number): void;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
/** The Deno abstraction for reading and writing files. */
export class File
implements
Reader,
SyncReader,
Writer,
SyncWriter,
Seeker,
SyncSeeker,
Closer {
readonly rid: number;
constructor(rid: number);
write(p: Uint8Array): Promise<number>;
writeSync(p: Uint8Array): number;
read(p: Uint8Array): Promise<number | EOF>;
readSync(p: Uint8Array): number | EOF;
seek should return cursor position (#4211)
2020-03-02 11:44:46 -05:00
seek(offset: number, whence: SeekMode): Promise<number>;
seekSync(offset: number, whence: SeekMode): number;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
close(): void;
}
tty: Deno.setRaw(rid, mode) to turn on/off raw mode (#3958)
2020-02-26 01:01:24 -05:00
change type of stdio handles in JS api (#4891)
2020-04-24 19:01:25 -04:00
export interface Stdin extends Reader, SyncReader, Closer {
readonly rid: number;
}
export interface Stdout extends Writer, SyncWriter, Closer {
readonly rid: number;
}
export interface Stderr extends Writer, SyncWriter, Closer {
readonly rid: number;
}
/** A handle for `stdin`. */
export const stdin: Stdin;
/** A handle for `stdout`. */
export const stdout: Stdout;
/** A handle for `stderr`. */
export const stderr: Stderr;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
Implemented alternative open mode in files (#3119) Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
2020-01-21 04:49:42 -05:00
export interface OpenOptions {
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** Sets the option for read access. This option, when `true`, means that the
* file should be read-able if opened. */
Implemented alternative open mode in files (#3119) Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
2020-01-21 04:49:42 -05:00
read?: boolean;
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** 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. */
Implemented alternative open mode in files (#3119) Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
2020-01-21 04:49:42 -05:00
write?: boolean;
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/**Sets the option for the append mode. This option, when `true`, means that
* writes will append to a file instead of overwriting previous contents.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Note that setting `{ write: true, append: true }` has the same effect as
* setting only `{ append: true }`. */
Implemented alternative open mode in files (#3119) Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
2020-01-21 04:49:42 -05:00
append?: boolean;
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** 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`
BREAKING CHANGE FileInfo.len renamed to FileName.size (#4338)
2020-03-14 22:57:42 -04:00
* size if it already exists. The file must be opened with write access
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* for truncate to work. */
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. */
create?: boolean;
/** Defaults to `false`. 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. */
Implemented alternative open mode in files (#3119) Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
2020-01-21 04:49:42 -05:00
createNew?: boolean;
Add mode option to open/create (#4289)
2020-03-16 15:02:41 -04:00
/** Permissions to use if creating the file (defaults to `0o666`, before
* the process's umask).
* Ignored on Windows. */
mode?: number;
Implemented alternative open mode in files (#3119) Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
2020-01-21 04:49:42 -05:00
}
Improve isatty and kill API docs; Deno.kill() - throw on Windows (#4497)
2020-03-26 15:52:47 -04:00
/** **UNSTABLE**: new API, yet to be vetted
tty: Deno.setRaw(rid, mode) to turn on/off raw mode (#3958)
2020-02-26 01:01:24 -05:00
*
Improve isatty and kill API docs; Deno.kill() - throw on Windows (#4497)
2020-03-26 15:52:47 -04:00
* Check if a given resource id (`rid`) is a TTY.
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* // This example is system and context specific
Improve isatty and kill API docs; Deno.kill() - throw on Windows (#4497)
2020-03-26 15:52:47 -04:00
* const nonTTYRid = Deno.openSync("my_file.txt").rid;
* const ttyRid = Deno.openSync("/dev/tty6").rid;
* console.log(Deno.isatty(nonTTYRid)); // false
* console.log(Deno.isatty(ttyRid)); // true
* Deno.close(nonTTYRid);
* Deno.close(ttyRid);
*/
tty: Deno.setRaw(rid, mode) to turn on/off raw mode (#3958)
2020-02-26 01:01:24 -05:00
export function isatty(rid: number): boolean;
Improve isatty and kill API docs; Deno.kill() - throw on Windows (#4497)
2020-03-26 15:52:47 -04:00
/** **UNSTABLE**: new API, yet to be vetted
tty: Deno.setRaw(rid, mode) to turn on/off raw mode (#3958)
2020-02-26 01:01:24 -05:00
*
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* 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.
*
* Deno.setRaw(myTTY.rid, true);
*/
tty: Deno.setRaw(rid, mode) to turn on/off raw mode (#3958)
2020-02-26 01:01:24 -05:00
export function setRaw(rid: number, mode: boolean): void;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** A variable-sized buffer of bytes with `read()` and `write()` methods.
Add comment distinguishing Deno.Buffer from Node's Buffer (#4847)
2020-04-22 14:26:16 -04:00
*
* Deno.Buffer is almost always used with some I/O like files and sockets. It
* allows one to buffer up a download from a socket. Buffer grows and shrinks
* as necessary.
*
* Deno.Buffer is NOT the same thing as Node's Buffer. Node's Buffer was
* created in 2009 before JavaScript had the concept of ArrayBuffers. It's
* simply a non-standard ArrayBuffer.
*
* ArrayBuffer is a fixed memory allocation. Deno.Buffer is implemented on top
* of ArrayBuffer.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
* Based on [Go Buffer](https://golang.org/pkg/bytes/#Buffer). */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export class Buffer implements Reader, SyncReader, Writer, SyncWriter {
constructor(ab?: ArrayBuffer);
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Returns a slice holding the unread portion of the buffer.
*
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
* The slice is valid for use only until the next buffer modification (that
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* is, only until the next call to a method like `read()`, `write()`,
* `reset()`, or `truncate()`). The slice aliases the buffer content at
* least until the next buffer modification, so immediate changes to the
* slice will affect the result of future reads. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
bytes(): Uint8Array;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Returns the contents of the unread portion of the buffer as a `string`.
*
* **Warning**: if multibyte characters are present when data is flowing
* through the buffer, this method may result in incorrect strings due to a
* character being split. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
toString(): string;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Returns whether the unread portion of the buffer is empty. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
empty(): boolean;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** A read only number of bytes of the unread portion of the buffer. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
readonly length: number;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** The read only capacity of the buffer's underlying byte slice, that is,
* the total space allocated for the buffer's data. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
readonly capacity: number;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Discards all but the first `n` unread bytes from the buffer but
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* continues to use the same allocated storage. It throws if `n` is
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* negative or greater than the length of the buffer. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
truncate(n: number): void;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Resets the buffer to be empty, but it retains the underlying storage for
* use by future writes. `.reset()` is the same as `.truncate(0)`. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
reset(): void;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Reads the next `p.length` bytes from the buffer or until the buffer is
* drained. Returns the number of bytes read. If the buffer has no data to
* return, the return is `Deno.EOF`. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
readSync(p: Uint8Array): number | EOF;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Reads the next `p.length` bytes from the buffer or until the buffer is
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* drained. Resolves to the number of bytes read. If the buffer has no
* data to return, resolves to `Deno.EOF`. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
read(p: Uint8Array): Promise<number | EOF>;
writeSync(p: Uint8Array): number;
write(p: Uint8Array): Promise<number>;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Grows the buffer's capacity, if necessary, to guarantee space for
* another `n` bytes. After `.grow(n)`, at least `n` bytes can be written to
* the buffer without another allocation. If `n` is negative, `.grow()` will
* throw. If the buffer can't grow it will throw an error.
*
* Based on Go Lang's
* [Buffer.Grow](https://golang.org/pkg/bytes/#Buffer.Grow). */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
grow(n: number): void;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Reads data from `r` until `Deno.EOF` and appends it to the buffer,
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* growing the buffer as needed. It resolves to the number of bytes read.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* If the buffer becomes too large, `.readFrom()` will reject with an error.
*
* Based on Go Lang's
* [Buffer.ReadFrom](https://golang.org/pkg/bytes/#Buffer.ReadFrom). */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
readFrom(r: Reader): Promise<number>;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Reads data from `r` until `Deno.EOF` and appends it to the buffer,
* growing the buffer as needed. It returns the number of bytes read. If the
* buffer becomes too large, `.readFromSync()` will throw an error.
*
* Based on Go Lang's
* [Buffer.ReadFrom](https://golang.org/pkg/bytes/#Buffer.ReadFrom). */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
readFromSync(r: SyncReader): number;
}
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
/** Read Reader `r` until end of file (`Deno.EOF`) and resolve to the content
* as `Uint8Array`.
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* // Example from stdin
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* const stdinContent = await Deno.readAll(Deno.stdin);
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* // Example from file
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* const file = await Deno.open("my_file.txt", {read: true});
* const myFileContent = await Deno.readAll(file);
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* Deno.close(file.rid);
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* // Example from buffer
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* const myData = new Uint8Array(100);
* // ... fill myData array with data
* const reader = new Deno.Buffer(myData.buffer as ArrayBuffer);
* const bufferContent = await Deno.readAll(reader);
*/
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export function readAll(r: Reader): Promise<Uint8Array>;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
/** Synchronously reads Reader `r` until end of file (`Deno.EOF`) and returns
* the content as `Uint8Array`.
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* // Example from stdin
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* const stdinContent = Deno.readAllSync(Deno.stdin);
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* // Example from file
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* const file = Deno.openSync("my_file.txt", {read: true});
* const myFileContent = Deno.readAllSync(file);
* Deno.close(file.rid);
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* // Example from buffer
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* const myData = new Uint8Array(100);
* // ... fill myData array with data
* const reader = new Deno.Buffer(myData.buffer as ArrayBuffer);
* const bufferContent = Deno.readAllSync(reader);
*/
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export function readAllSync(r: SyncReader): Uint8Array;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
/** Write all the content of the array buffer (`arr`) to the writer (`w`).
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* // Example writing to stdout
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* const contentBytes = new TextEncoder().encode("Hello World");
* await Deno.writeAll(Deno.stdout, contentBytes);
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* // Example writing to file
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* const contentBytes = new TextEncoder().encode("Hello World");
* const file = await Deno.open('test.file', {write: true});
* await Deno.writeAll(file, contentBytes);
* Deno.close(file.rid);
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* // Example writing to buffer
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* const contentBytes = new TextEncoder().encode("Hello World");
* const writer = new Deno.Buffer();
* await Deno.writeAll(writer, contentBytes);
* console.log(writer.bytes().length); // 11
*/
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export function writeAll(w: Writer, arr: Uint8Array): Promise<void>;
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
/** Synchronously write all the content of the array buffer (`arr`) to the
* writer (`w`).
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* // Example writing to stdout
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* const contentBytes = new TextEncoder().encode("Hello World");
* Deno.writeAllSync(Deno.stdout, contentBytes);
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* // Example writing to file
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* const contentBytes = new TextEncoder().encode("Hello World");
* const file = Deno.openSync('test.file', {write: true});
* Deno.writeAllSync(file, contentBytes);
* Deno.close(file.rid);
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* // Example writing to buffer
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* const contentBytes = new TextEncoder().encode("Hello World");
* const writer = new Deno.Buffer();
* Deno.writeAllSync(writer, contentBytes);
* console.log(writer.bytes().length); // 11
*/
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
export function writeAllSync(w: SyncWriter, arr: Uint8Array): void;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
Rename Option -> Options (#4226) * Rename MkdirOption interface to MkdirOptions It was hard to remember which Options interfaces were spelled in the singular and which in the plural (and anyway this one contained two options). Also added MkdirOptions to cli/js/deno.ts. All the analogous interfaces were exported there. * Rename RemoveOption interface to RemoveOptions This was the last remaining Option interface spelled in the singular. Easier to remember if they're all Option**s**; plus we may want to add extra options here later.
2020-03-02 15:24:42 -05:00
export interface MkdirOptions {
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** Defaults to `false`. 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
Refactor and expand mkdir tests (#4579)
2020-04-02 14:54:33 -04:00
* permissions) if a directory already exists at the path, or if the path
* is a symlink to an existing directory. */
fix: Deno.mkdir should conform to style guide (#3617)
2020-01-07 14:14:33 -05:00
recursive?: boolean;
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** Permissions to use when creating the directory (defaults to `0o777`,
* before the process's umask).
support permission mode in mkdir (#4286)
2020-03-11 16:14:23 -04:00
* Ignored on Windows. */
fix: Deno.mkdir should conform to style guide (#3617)
2020-01-07 14:14:33 -05:00
mode?: number;
}
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** Synchronously creates a new directory with the specified path.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* Deno.mkdirSync("new_dir");
fix: Deno.mkdir should conform to style guide (#3617)
2020-01-07 14:14:33 -05:00
* Deno.mkdirSync("nested/directories", { recursive: true });
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* Deno.mkdirSync("restricted_access_dir", { mode: 0o700 });
*
Refactor and expand mkdir tests (#4579)
2020-04-02 14:54:33 -04:00
* Defaults to throwing error if the directory already exists.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* Requires `allow-write` permission. */
Rename Option -> Options (#4226) * Rename MkdirOption interface to MkdirOptions It was hard to remember which Options interfaces were spelled in the singular and which in the plural (and anyway this one contained two options). Also added MkdirOptions to cli/js/deno.ts. All the analogous interfaces were exported there. * Rename RemoveOption interface to RemoveOptions This was the last remaining Option interface spelled in the singular. Easier to remember if they're all Option**s**; plus we may want to add extra options here later.
2020-03-02 15:24:42 -05:00
export function mkdirSync(path: string, options?: MkdirOptions): void;
fix: Deno.mkdir should conform to style guide (#3617)
2020-01-07 14:14:33 -05:00
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
/** Creates a new directory with the specified path.
*
* await Deno.mkdir("new_dir");
fix: Deno.mkdir should conform to style guide (#3617)
2020-01-07 14:14:33 -05:00
* await Deno.mkdir("nested/directories", { recursive: true });
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* await Deno.mkdir("restricted_access_dir", { mode: 0o700 });
*
Refactor and expand mkdir tests (#4579)
2020-04-02 14:54:33 -04:00
* Defaults to throwing error if the directory already exists.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* Requires `allow-write` permission. */
Rename Option -> Options (#4226) * Rename MkdirOption interface to MkdirOptions It was hard to remember which Options interfaces were spelled in the singular and which in the plural (and anyway this one contained two options). Also added MkdirOptions to cli/js/deno.ts. All the analogous interfaces were exported there. * Rename RemoveOption interface to RemoveOptions This was the last remaining Option interface spelled in the singular. Easier to remember if they're all Option**s**; plus we may want to add extra options here later.
2020-03-02 15:24:42 -05:00
export function mkdir(path: string, options?: MkdirOptions): Promise<void>;
fix: Deno.mkdir should conform to style guide (#3617)
2020-01-07 14:14:33 -05:00
feat: Deno.makeTempFile (#4024)
2020-02-18 14:45:59 -05:00
export interface MakeTempOptions {
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** Directory where the temporary directory should be created (defaults to
* the env variable TMPDIR, or the system's default, usually /tmp). */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
dir?: string;
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** String that should precede the random portion of the temporary
* directory's name. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
prefix?: string;
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** String that should follow the random portion of the temporary
* directory's name. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
suffix?: string;
}
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
/** Synchronously creates a new temporary directory in the default directory
* for temporary files (see also `Deno.dir("temp")`), unless `dir` is specified.
* Other optional options include prefixing and suffixing the directory name
* with `prefix` and `suffix` respectively.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* The full path to the newly created directory is returned.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* Multiple programs calling this function simultaneously will create different
* directories. It is the caller's responsibility to remove the directory when
* no longer needed.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* const tempDirName0 = Deno.makeTempDirSync(); // e.g. /tmp/2894ea76
* const tempDirName1 = Deno.makeTempDirSync({ prefix: 'my_temp' }); // e.g. /tmp/my_temp339c944d
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* Requires `allow-write` permission. */
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
// TODO(ry) Doesn't check permissions.
feat: Deno.makeTempFile (#4024)
2020-02-18 14:45:59 -05:00
export function makeTempDirSync(options?: MakeTempOptions): string;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
/** Creates a new temporary directory in the default directory for temporary
* files (see also `Deno.dir("temp")`), unless `dir` is specified. Other
* optional options include prefixing and suffixing the directory name with
* `prefix` and `suffix` respectively.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* This call resolves to the full path to the newly created directory.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* Multiple programs calling this function simultaneously will create different
* directories. It is the caller's responsibility to remove the directory when
* no longer needed.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* const tempDirName0 = await Deno.makeTempDir(); // e.g. /tmp/2894ea76
* const tempDirName1 = await Deno.makeTempDir({ prefix: 'my_temp' }); // e.g. /tmp/my_temp339c944d
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* Requires `allow-write` permission. */
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
// TODO(ry) Doesn't check permissions.
feat: Deno.makeTempFile (#4024)
2020-02-18 14:45:59 -05:00
export function makeTempDir(options?: MakeTempOptions): Promise<string>;
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
/** Synchronously creates a new temporary file in the default directory for
* temporary files (see also `Deno.dir("temp")`), unless `dir` is specified.
* Other optional options include prefixing and suffixing the directory name
* with `prefix` and `suffix` respectively.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* The full path to the newly created file is returned.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* Multiple programs calling this function simultaneously will create different
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* files. It is the caller's responsibility to remove the file when no longer
* needed.
feat: Deno.makeTempFile (#4024)
2020-02-18 14:45:59 -05:00
*
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* const tempFileName0 = Deno.makeTempFileSync(); // e.g. /tmp/419e0bf2
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* const tempFileName1 = Deno.makeTempFileSync({ prefix: 'my_temp' }); // e.g. /tmp/my_temp754d3098
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* Requires `allow-write` permission. */
feat: Deno.makeTempFile (#4024)
2020-02-18 14:45:59 -05:00
export function makeTempFileSync(options?: MakeTempOptions): string;
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
/** Creates a new temporary file in the default directory for temporary
* files (see also `Deno.dir("temp")`), unless `dir` is specified. Other
* optional options include prefixing and suffixing the directory name with
* `prefix` and `suffix` respectively.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* This call resolves to the full path to the newly created file.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* Multiple programs calling this function simultaneously will create different
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* files. It is the caller's responsibility to remove the file when no longer
* needed.
feat: Deno.makeTempFile (#4024)
2020-02-18 14:45:59 -05:00
*
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* const tmpFileName0 = await Deno.makeTempFile(); // e.g. /tmp/419e0bf2
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* const tmpFileName1 = await Deno.makeTempFile({ prefix: 'my_temp' }); // e.g. /tmp/my_temp754d3098
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* Requires `allow-write` permission. */
feat: Deno.makeTempFile (#4024)
2020-02-18 14:45:59 -05:00
export function makeTempFile(options?: MakeTempOptions): Promise<string>;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** Synchronously changes the permission of a specific file/directory of
* specified path. Ignores the process's umask.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* Deno.chmodSync("/path/to/file", 0o666);
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Chmod API documentation improvements (#4427)
2020-03-18 21:25:01 -04:00
* For a full description, see [chmod](#chmod)
*
chmod should throw on Windows (#4446)
2020-03-20 16:03:04 -04:00
* NOTE: This API currently throws on Windows
Chmod API documentation improvements (#4427)
2020-03-18 21:25:01 -04:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-write` permission. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export function chmodSync(path: string, mode: number): void;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
/** Changes the permission of a specific file/directory of specified path.
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* Ignores the process's umask.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* await Deno.chmod("/path/to/file", 0o666);
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Chmod API documentation improvements (#4427)
2020-03-18 21:25:01 -04:00
* 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 |
*
chmod should throw on Windows (#4446)
2020-03-20 16:03:04 -04:00
* NOTE: This API currently throws on Windows
Chmod API documentation improvements (#4427)
2020-03-18 21:25:01 -04:00
*
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* Requires `allow-write` permission. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export function chmod(path: string, mode: number): Promise<void>;
doc: API improvements to chown, close, compile and connect (#4463)
2020-03-23 00:03:45 -04:00
/** Synchronously change owner of a regular file or directory. This functionality
* is not available on Windows.
*
doc: improve various API docs and include examples (#4486)
2020-03-24 23:54:41 -04:00
* Deno.chownSync("myFile.txt", 1000, 1002);
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-write` permission.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
doc: API improvements to chown, close, compile and connect (#4463)
2020-03-23 00:03:45 -04:00
* Throws Error (not implemented) if executed on Windows
*
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
* @param path path to the file
doc: API improvements to chown, close, compile and connect (#4463)
2020-03-23 00:03:45 -04:00
* @param uid user id (UID) of the new owner
* @param gid group id (GID) of the new owner
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*/
export function chownSync(path: string, uid: number, gid: number): void;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
doc: API improvements to chown, close, compile and connect (#4463)
2020-03-23 00:03:45 -04:00
/** Change owner of a regular file or directory. This functionality
* is not available on Windows.
*
doc: improve various API docs and include examples (#4486)
2020-03-24 23:54:41 -04:00
* await Deno.chown("myFile.txt", 1000, 1002);
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-write` permission.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
doc: API improvements to chown, close, compile and connect (#4463)
2020-03-23 00:03:45 -04:00
* Throws Error (not implemented) if executed on Windows
*
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
* @param path path to the file
doc: API improvements to chown, close, compile and connect (#4463)
2020-03-23 00:03:45 -04:00
* @param uid user id (UID) of the new owner
* @param gid group id (GID) of the new owner
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*/
export function chown(path: string, uid: number, gid: number): Promise<void>;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE**: needs investigation into high precision time.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* 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.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* Deno.utimeSync("myfile.txt", 1556495550, new Date());
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* Requires `allow-write` permission. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export function utimeSync(
Rename name/filename arguments to path (#4227) There's a lot of variation in doc comments and internal code about whether the first parameter to file system calls is `path` or `name` or `filename`. For consistency, have made it always be `path`.
2020-03-06 11:29:23 -05:00
path: string,
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
atime: number | Date,
mtime: number | Date
): void;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE**: needs investigation into high precision time.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* 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.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* await Deno.utime("myfile.txt", 1556495550, new Date());
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-write` permission. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export function utime(
Rename name/filename arguments to path (#4227) There's a lot of variation in doc comments and internal code about whether the first parameter to file system calls is `path` or `name` or `filename`. For consistency, have made it always be `path`.
2020-03-06 11:29:23 -05:00
path: string,
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
atime: number | Date,
mtime: number | Date
): Promise<void>;
Rename Option -> Options (#4226) * Rename MkdirOption interface to MkdirOptions It was hard to remember which Options interfaces were spelled in the singular and which in the plural (and anyway this one contained two options). Also added MkdirOptions to cli/js/deno.ts. All the analogous interfaces were exported there. * Rename RemoveOption interface to RemoveOptions This was the last remaining Option interface spelled in the singular. Easier to remember if they're all Option**s**; plus we may want to add extra options here later.
2020-03-02 15:24:42 -05:00
export interface RemoveOptions {
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** Defaults to `false`. If set to `true`, path will be removed even if
* it's a non-empty directory. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
recursive?: boolean;
}
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
/** Synchronously removes the named file or directory.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* 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`.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-write` permission. */
Rename Option -> Options (#4226) * Rename MkdirOption interface to MkdirOptions It was hard to remember which Options interfaces were spelled in the singular and which in the plural (and anyway this one contained two options). Also added MkdirOptions to cli/js/deno.ts. All the analogous interfaces were exported there. * Rename RemoveOption interface to RemoveOptions This was the last remaining Option interface spelled in the singular. Easier to remember if they're all Option**s**; plus we may want to add extra options here later.
2020-03-02 15:24:42 -05:00
export function removeSync(path: string, options?: RemoveOptions): void;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
/** Removes the named file or directory.
*
* await Deno.remove("/path/to/empty_dir/or/file");
* await Deno.remove("/path/to/populated_dir/or/file", { recursive: true });
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* Throws error if permission denied, path not found, or path is a non-empty
* directory and the `recursive` option isn't set to `true`.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-write` permission. */
Rename Option -> Options (#4226) * Rename MkdirOption interface to MkdirOptions It was hard to remember which Options interfaces were spelled in the singular and which in the plural (and anyway this one contained two options). Also added MkdirOptions to cli/js/deno.ts. All the analogous interfaces were exported there. * Rename RemoveOption interface to RemoveOptions This was the last remaining Option interface spelled in the singular. Easier to remember if they're all Option**s**; plus we may want to add extra options here later.
2020-03-02 15:24:42 -05:00
export function remove(path: string, options?: RemoveOptions): Promise<void>;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
/** 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.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* Deno.renameSync("old/path", "new/path");
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Improve tests and docs for Deno.rename (#4597)
2020-04-03 11:00:16 -04:00
* On Unix, 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.
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-read` and `allow-write` permissions. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export function renameSync(oldpath: string, newpath: string): void;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
/** 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.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* await Deno.rename("old/path", "new/path");
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Improve tests and docs for Deno.rename (#4597)
2020-04-03 11:00:16 -04:00
* On Unix, 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.
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
*
Improve tests and docs for Deno.rename (#4597)
2020-04-03 11:00:16 -04:00
* Requires `allow-read` and `allow-write` permission. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export function rename(oldpath: string, newpath: string): Promise<void>;
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
/** 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. Reading a directory returns an empty data array.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* const decoder = new TextDecoder("utf-8");
* const data = Deno.readFileSync("hello.txt");
* console.log(decoder.decode(data));
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-read` permission. */
Rename name/filename arguments to path (#4227) There's a lot of variation in doc comments and internal code about whether the first parameter to file system calls is `path` or `name` or `filename`. For consistency, have made it always be `path`.
2020-03-06 11:29:23 -05:00
export function readFileSync(path: string): Uint8Array;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
/** 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.
* Reading a directory returns an empty data array.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* const decoder = new TextDecoder("utf-8");
* const data = await Deno.readFile("hello.txt");
* console.log(decoder.decode(data));
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-read` permission. */
Rename name/filename arguments to path (#4227) There's a lot of variation in doc comments and internal code about whether the first parameter to file system calls is `path` or `name` or `filename`. For consistency, have made it always be `path`.
2020-03-06 11:29:23 -05:00
export function readFile(path: string): Promise<Uint8Array>;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
BREAKING CHANGE FileInfo.len renamed to FileName.size (#4338)
2020-03-14 22:57:42 -04:00
/** A FileInfo describes a file and is returned by `stat`, `lstat`,
refactor(cli/js/ops/fs): Improve readdir() and FileInfo interfaces (#4763)
2020-04-16 01:40:30 -04:00
* `statSync`, `lstatSync`. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export interface FileInfo {
refactor(cli/js/ops/fs): Improve readdir() and FileInfo interfaces (#4763)
2020-04-16 01:40:30 -04:00
/** 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;
BREAKING CHANGE FileInfo.len renamed to FileName.size (#4338)
2020-03-14 22:57:42 -04:00
/** The size of the file, in bytes. */
size: number;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
/** The last modification time of the file. This corresponds to the `mtime`
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* field from `stat` on Linux/Mac OS and `ftLastWriteTime` on Windows. This
* may not be available on all platforms. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
modified: number | null;
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** 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. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
accessed: number | null;
fix(doc): `FileInfo.created` is creation time (#4799)
2020-04-18 00:05:33 -04:00
/** The creation time of the file. This corresponds to the `birthtime`
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* field from `stat` on Mac/BSD and `ftCreationTime` on Windows. This may not
* be available on all platforms. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
created: number | null;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** ID of the device containing the file.
*
* _Linux/Mac OS only._ */
feat(fs): add more unix-only fields to FileInfo (#3680)
2020-01-16 09:46:32 -05:00
dev: number | null;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Inode number.
*
* _Linux/Mac OS only._ */
feat(fs): add more unix-only fields to FileInfo (#3680)
2020-01-16 09:46:32 -05:00
ino: number | null;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE**: Match behavior with Go on Windows for `mode`.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Rename perm to mode (#4276) There's a lot of variation in doc comments and internal code about whether chmod/0o777-style permissions are called `mode` or `perm`. (For example, mkdir and writeFile choose differently.) Had proposed earlier to go consistently with `perm`, but on balance devs prefer to go with `mode`.
2020-03-07 22:29:12 -05:00
* The underlying raw `st_mode` bits that contain the standard Unix
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* permissions for this file/directory. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
mode: number | null;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Number of hard links pointing to this file.
*
* _Linux/Mac OS only._ */
feat(fs): add more unix-only fields to FileInfo (#3680)
2020-01-16 09:46:32 -05:00
nlink: number | null;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** User ID of the owner of this file.
*
* _Linux/Mac OS only._ */
feat(fs): add more unix-only fields to FileInfo (#3680)
2020-01-16 09:46:32 -05:00
uid: number | null;
fix(doc): Group ID (#4803)
2020-04-18 11:25:35 -04:00
/** Group ID of the owner of this file.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
* _Linux/Mac OS only._ */
feat(fs): add more unix-only fields to FileInfo (#3680)
2020-01-16 09:46:32 -05:00
gid: number | null;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Device ID of this file.
*
* _Linux/Mac OS only._ */
feat(fs): add more unix-only fields to FileInfo (#3680)
2020-01-16 09:46:32 -05:00
rdev: number | null;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Blocksize for filesystem I/O.
*
* _Linux/Mac OS only._ */
feat(fs): add more unix-only fields to FileInfo (#3680)
2020-01-16 09:46:32 -05:00
blksize: number | null;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Number of blocks allocated to the file, in 512-byte units.
*
* _Linux/Mac OS only._ */
feat(fs): add more unix-only fields to FileInfo (#3680)
2020-01-16 09:46:32 -05:00
blocks: number | null;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
}
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
/** Returns absolute normalized path, with symbolic links resolved.
Add Deno.realpath (#3404)
2019-11-26 03:40:57 -05:00
*
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* // 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"
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* console.log(realSymLinkPath); // outputs "/home/alice/file.txt"
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-read` permission. */
Add Deno.realpath (#3404)
2019-11-26 03:40:57 -05:00
export function realpathSync(path: string): string;
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** Resolves to the absolute normalized path, with symbolic links resolved.
Add Deno.realpath (#3404)
2019-11-26 03:40:57 -05:00
*
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* // 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"
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* console.log(realSymLinkPath); // outputs "/home/alice/file.txt"
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-read` permission. */
Add Deno.realpath (#3404)
2019-11-26 03:40:57 -05:00
export function realpath(path: string): Promise<string>;
refactor(cli/js/ops/fs): Improve readdir() and FileInfo interfaces (#4763)
2020-04-16 01:40:30 -04:00
export interface DirEntry extends FileInfo {
name: string;
}
/** Synchronously reads the directory given by `path` and returns an iterable
* of `Deno.DirEntry`.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
refactor(cli/js/ops/fs): Improve readdir() and FileInfo interfaces (#4763)
2020-04-16 01:40:30 -04:00
* for (const dirEntry of Deno.readdirSync("/")) {
* console.log(dirEntry.name);
* }
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* Throws error if `path` is not a directory.
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-read` permission. */
refactor(cli/js/ops/fs): Improve readdir() and FileInfo interfaces (#4763)
2020-04-16 01:40:30 -04:00
export function readdirSync(path: string): Iterable<DirEntry>;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
refactor(cli/js/ops/fs): Improve readdir() and FileInfo interfaces (#4763)
2020-04-16 01:40:30 -04:00
/** Reads the directory given by `path` and returns an async iterable of
* `Deno.DirEntry`.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
refactor(cli/js/ops/fs): Improve readdir() and FileInfo interfaces (#4763)
2020-04-16 01:40:30 -04:00
* for await (const dirEntry of Deno.readdir("/")) {
* console.log(dirEntry.name);
* }
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* Throws error if `path` is not a directory.
*
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* Requires `allow-read` permission. */
refactor(cli/js/ops/fs): Improve readdir() and FileInfo interfaces (#4763)
2020-04-16 01:40:30 -04:00
export function readdir(path: string): AsyncIterable<DirEntry>;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** 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.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* Deno.copyFileSync("from.txt", "to.txt");
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* Requires `allow-read` permission on fromPath.
* Requires `allow-write` permission on toPath. */
export function copyFileSync(fromPath: string, toPath: string): void;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** 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.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* await Deno.copyFile("from.txt", "to.txt");
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* Requires `allow-read` permission on fromPath.
* Requires `allow-write` permission on toPath. */
export function copyFile(fromPath: string, toPath: string): Promise<void>;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
/** Returns the full path destination of the named symbolic link.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* 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
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-read` permission. */
Rename name/filename arguments to path (#4227) There's a lot of variation in doc comments and internal code about whether the first parameter to file system calls is `path` or `name` or `filename`. For consistency, have made it always be `path`.
2020-03-06 11:29:23 -05:00
export function readlinkSync(path: string): string;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
/** Resolves to the full path destination of the named symbolic link.
*
* await Deno.symlink("./test.txt", "./test_link.txt");
* const target = await Deno.readlink("./test_link.txt"); // full path of ./test.txt
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* Throws TypeError if called with a hard link
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-read` permission. */
Rename name/filename arguments to path (#4227) There's a lot of variation in doc comments and internal code about whether the first parameter to file system calls is `path` or `name` or `filename`. For consistency, have made it always be `path`.
2020-03-06 11:29:23 -05:00
export function readlink(path: string): Promise<string>;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
Rename name/filename arguments to path (#4227) There's a lot of variation in doc comments and internal code about whether the first parameter to file system calls is `path` or `name` or `filename`. For consistency, have made it always be `path`.
2020-03-06 11:29:23 -05:00
/** Resolves to a `Deno.FileInfo` for the specified `path`. If `path` is a
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* symlink, information for the symlink will be returned instead of what it
* points to.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* const fileInfo = await Deno.lstat("hello.txt");
refactor(cli/js/ops/fs): Improve readdir() and FileInfo interfaces (#4763)
2020-04-16 01:40:30 -04:00
* assert(fileInfo.isFile);
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-read` permission. */
Rename name/filename arguments to path (#4227) There's a lot of variation in doc comments and internal code about whether the first parameter to file system calls is `path` or `name` or `filename`. For consistency, have made it always be `path`.
2020-03-06 11:29:23 -05:00
export function lstat(path: string): Promise<FileInfo>;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
Rename name/filename arguments to path (#4227) There's a lot of variation in doc comments and internal code about whether the first parameter to file system calls is `path` or `name` or `filename`. For consistency, have made it always be `path`.
2020-03-06 11:29:23 -05:00
/** Synchronously returns a `Deno.FileInfo` for the specified `path`. If
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* `path` is a symlink, information for the symlink will be returned instead of
* what it points to..
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* const fileInfo = Deno.lstatSync("hello.txt");
refactor(cli/js/ops/fs): Improve readdir() and FileInfo interfaces (#4763)
2020-04-16 01:40:30 -04:00
* assert(fileInfo.isFile);
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-read` permission. */
Rename name/filename arguments to path (#4227) There's a lot of variation in doc comments and internal code about whether the first parameter to file system calls is `path` or `name` or `filename`. For consistency, have made it always be `path`.
2020-03-06 11:29:23 -05:00
export function lstatSync(path: string): FileInfo;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
Rename name/filename arguments to path (#4227) There's a lot of variation in doc comments and internal code about whether the first parameter to file system calls is `path` or `name` or `filename`. For consistency, have made it always be `path`.
2020-03-06 11:29:23 -05:00
/** Resolves to a `Deno.FileInfo` for the specified `path`. Will always
* follow symlinks.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* const fileInfo = await Deno.stat("hello.txt");
refactor(cli/js/ops/fs): Improve readdir() and FileInfo interfaces (#4763)
2020-04-16 01:40:30 -04:00
* assert(fileInfo.isFile);
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-read` permission. */
Rename name/filename arguments to path (#4227) There's a lot of variation in doc comments and internal code about whether the first parameter to file system calls is `path` or `name` or `filename`. For consistency, have made it always be `path`.
2020-03-06 11:29:23 -05:00
export function stat(path: string): Promise<FileInfo>;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
Rename name/filename arguments to path (#4227) There's a lot of variation in doc comments and internal code about whether the first parameter to file system calls is `path` or `name` or `filename`. For consistency, have made it always be `path`.
2020-03-06 11:29:23 -05:00
/** Synchronously returns a `Deno.FileInfo` for the specified `path`. Will
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* always follow symlinks.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* const fileInfo = Deno.statSync("hello.txt");
refactor(cli/js/ops/fs): Improve readdir() and FileInfo interfaces (#4763)
2020-04-16 01:40:30 -04:00
* assert(fileInfo.isFile);
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-read` permission. */
Rename name/filename arguments to path (#4227) There's a lot of variation in doc comments and internal code about whether the first parameter to file system calls is `path` or `name` or `filename`. For consistency, have made it always be `path`.
2020-03-06 11:29:23 -05:00
export function statSync(path: string): FileInfo;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
/** Synchronously creates `newpath` as a hard link to `oldpath`.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* Deno.linkSync("old/name", "new/name");
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-read` and `allow-write` permissions. */
refactor: move code from fs.rs into ops/fs.rs (#4428) This a complex boring PR that shifts around code (primarily) in cli/fs.rs and cli/ops/fs.rs. The gain of this refactoring is to ease the way for #4188 and #4017, and also to avoid some future development pain. Mostly there is no change in functionality. Except: * squashed bugs where op_utime and op_chown weren't using `resolve_from_cwd` * eliminated the use of the external `remove_dir_all` crate. * op_chmod now only queries metadata to verify file/dir exists on Windows (it will already fail on Unix if it doesn't) * op_chown now verifies the file/dir's existence on Windows like chmod does.
2020-03-20 09:46:26 -04:00
export function linkSync(oldpath: string, newpath: string): void;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
refactor: move code from fs.rs into ops/fs.rs (#4428) This a complex boring PR that shifts around code (primarily) in cli/fs.rs and cli/ops/fs.rs. The gain of this refactoring is to ease the way for #4188 and #4017, and also to avoid some future development pain. Mostly there is no change in functionality. Except: * squashed bugs where op_utime and op_chown weren't using `resolve_from_cwd` * eliminated the use of the external `remove_dir_all` crate. * op_chmod now only queries metadata to verify file/dir exists on Windows (it will already fail on Unix if it doesn't) * op_chown now verifies the file/dir's existence on Windows like chmod does.
2020-03-20 09:46:26 -04:00
/** Creates `newpath` as a hard link to `oldpath`.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* await Deno.link("old/name", "new/name");
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-read` and `allow-write` permissions. */
refactor: move code from fs.rs into ops/fs.rs (#4428) This a complex boring PR that shifts around code (primarily) in cli/fs.rs and cli/ops/fs.rs. The gain of this refactoring is to ease the way for #4188 and #4017, and also to avoid some future development pain. Mostly there is no change in functionality. Except: * squashed bugs where op_utime and op_chown weren't using `resolve_from_cwd` * eliminated the use of the external `remove_dir_all` crate. * op_chmod now only queries metadata to verify file/dir exists on Windows (it will already fail on Unix if it doesn't) * op_chown now verifies the file/dir's existence on Windows like chmod does.
2020-03-20 09:46:26 -04:00
export function link(oldpath: string, newpath: string): Promise<void>;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE**: `type` argument type may be changed to `"dir" | "file"`.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* Creates `newpath` as a symbolic link to `oldpath`.
*
* The type argument can be set to `dir` or `file`. This argument is only
* available on Windows and ignored on other platforms.
*
* NOTE: This function is not yet implemented on Windows.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* Deno.symlinkSync("old/name", "new/name");
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-read` and `allow-write` permissions. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export function symlinkSync(
refactor: move code from fs.rs into ops/fs.rs (#4428) This a complex boring PR that shifts around code (primarily) in cli/fs.rs and cli/ops/fs.rs. The gain of this refactoring is to ease the way for #4188 and #4017, and also to avoid some future development pain. Mostly there is no change in functionality. Except: * squashed bugs where op_utime and op_chown weren't using `resolve_from_cwd` * eliminated the use of the external `remove_dir_all` crate. * op_chmod now only queries metadata to verify file/dir exists on Windows (it will already fail on Unix if it doesn't) * op_chown now verifies the file/dir's existence on Windows like chmod does.
2020-03-20 09:46:26 -04:00
oldpath: string,
newpath: string,
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
type?: string
): void;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
/** **UNSTABLE**: `type` argument may be changed to `"dir" | "file"`
*
* Creates `newpath` as a symbolic link to `oldpath`.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* The type argument can be set to `dir` or `file`. This argument is only
* available on Windows and ignored on other platforms.
*
* NOTE: This function is not yet implemented on Windows.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* await Deno.symlink("old/name", "new/name");
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-read` and `allow-write` permissions. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export function symlink(
refactor: move code from fs.rs into ops/fs.rs (#4428) This a complex boring PR that shifts around code (primarily) in cli/fs.rs and cli/ops/fs.rs. The gain of this refactoring is to ease the way for #4188 and #4017, and also to avoid some future development pain. Mostly there is no change in functionality. Except: * squashed bugs where op_utime and op_chown weren't using `resolve_from_cwd` * eliminated the use of the external `remove_dir_all` crate. * op_chmod now only queries metadata to verify file/dir exists on Windows (it will already fail on Unix if it doesn't) * op_chown now verifies the file/dir's existence on Windows like chmod does.
2020-03-20 09:46:26 -04:00
oldpath: string,
newpath: string,
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
type?: string
): Promise<void>;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Options for writing to a file. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export interface WriteFileOptions {
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** Defaults to `false`. If set to `true`, will append to a file instead of
* overwriting previous contents. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
append?: boolean;
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** Sets the option to allow creating a new file, if one doesn't already
* exist at the specified path (defaults to `true`). */
create?: boolean;
/** Permissions always applied to file. */
Rename perm to mode (#4276) There's a lot of variation in doc comments and internal code about whether chmod/0o777-style permissions are called `mode` or `perm`. (For example, mkdir and writeFile choose differently.) Had proposed earlier to go consistently with `perm`, but on balance devs prefer to go with `mode`.
2020-03-07 22:29:12 -05:00
mode?: number;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
}
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
/** Synchronously write `data` to the given `path`, by default creating a new
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* file if needed, else overwriting.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* const encoder = new TextEncoder();
* const data = encoder.encode("Hello world\n");
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* 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
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* Requires `allow-write` permission, and `allow-read` if `options.create` is
* `false`.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*/
export function writeFileSync(
Rename name/filename arguments to path (#4227) There's a lot of variation in doc comments and internal code about whether the first parameter to file system calls is `path` or `name` or `filename`. For consistency, have made it always be `path`.
2020-03-06 11:29:23 -05:00
path: string,
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
data: Uint8Array,
options?: WriteFileOptions
): void;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
/** Write `data` to the given `path`, by default creating a new file if needed,
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* else overwriting.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* const encoder = new TextEncoder();
* const data = encoder.encode("Hello world\n");
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* 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
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* Requires `allow-write` permission, and `allow-read` if `options.create` is `false`.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*/
export function writeFile(
Rename name/filename arguments to path (#4227) There's a lot of variation in doc comments and internal code about whether the first parameter to file system calls is `path` or `name` or `filename`. For consistency, have made it always be `path`.
2020-03-06 11:29:23 -05:00
path: string,
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
data: Uint8Array,
options?: WriteFileOptions
): Promise<void>;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE**: Should not have same name as `window.location` type. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
interface Location {
/** The full url for the module, e.g. `file://some/file.ts` or
* `https://some/file.ts`. */
refactor(core/js_error): Align JSStackFrame with CallSite (#4715) Renames and adds missing fields to JSStackFrame from CallSite. Fixes #4705. Cleans up base changes for line and column numbers.
2020-04-13 10:54:16 -04:00
fileName: string;
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** The line number in the file. It is assumed to be 1-indexed. */
refactor(core/js_error): Align JSStackFrame with CallSite (#4715) Renames and adds missing fields to JSStackFrame from CallSite. Fixes #4705. Cleans up base changes for line and column numbers.
2020-04-13 10:54:16 -04:00
lineNumber: number;
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** The column number in the file. It is assumed to be 1-indexed. */
refactor(core/js_error): Align JSStackFrame with CallSite (#4715) Renames and adds missing fields to JSStackFrame from CallSite. Fixes #4705. Cleans up base changes for line and column numbers.
2020-04-13 10:54:16 -04:00
columnNumber: number;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
}
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** UNSTABLE: new API, yet to be vetted.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Given a current location in a module, lookup the source location and return
* it.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* When Deno transpiles code, it keep source maps of the transpiled code. This
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* function can be used to lookup the original location. This is
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* automatically done when accessing the `.stack` of an error, or when an
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* uncaught error is logged. This function can be used to perform the lookup
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* for creating better error handling.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* **Note:** `line` and `column` are 1 indexed, which matches display
* expectations, but is not typical of most index numbers in Deno.
*
* An example:
*
* const orig = Deno.applySourceMap({
refactor(core/js_error): Align JSStackFrame with CallSite (#4715) Renames and adds missing fields to JSStackFrame from CallSite. Fixes #4705. Cleans up base changes for line and column numbers.
2020-04-13 10:54:16 -04:00
* fileName: "file://my/module.ts",
* lineNumber: 5,
* columnNumber: 15
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
* });
* console.log(`${orig.filename}:${orig.line}:${orig.column}`);
*/
export function applySourceMap(location: Location): Location;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** A set of error constructors that are raised by Deno APIs. */
export const errors: {
NotFound: ErrorConstructor;
PermissionDenied: ErrorConstructor;
ConnectionRefused: ErrorConstructor;
ConnectionReset: ErrorConstructor;
ConnectionAborted: ErrorConstructor;
NotConnected: ErrorConstructor;
AddrInUse: ErrorConstructor;
AddrNotAvailable: ErrorConstructor;
BrokenPipe: ErrorConstructor;
AlreadyExists: ErrorConstructor;
InvalidData: ErrorConstructor;
TimedOut: ErrorConstructor;
Interrupted: ErrorConstructor;
WriteZero: ErrorConstructor;
UnexpectedEof: ErrorConstructor;
BadResource: ErrorConstructor;
Http: ErrorConstructor;
Make writeSync, readSync, seekSync, openSync, isatty proper synchronous syscalls (#4762)
2020-04-15 20:43:19 -04:00
Busy: ErrorConstructor;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
};
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE**: potentially want names to overlap more with browser.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* The permissions as granted by the caller.
*
* See: https://w3c.github.io/permissions/#permission-registry */
Use web standard Permissions API (#3200)
2019-10-27 11:22:53 -04:00
export type PermissionName =
| "run"
| "read"
| "write"
| "net"
| "env"
feat: first pass at native plugins (#3372)
2019-12-05 15:30:20 -05:00
| "plugin"
Use web standard Permissions API (#3200)
2019-10-27 11:22:53 -04:00
| "hrtime";
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** The current status of the permission.
*
* See: https://w3c.github.io/permissions/#status-of-a-permission */
Use web standard Permissions API (#3200)
2019-10-27 11:22:53 -04:00
export type PermissionState = "granted" | "denied" | "prompt";
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
Use web standard Permissions API (#3200)
2019-10-27 11:22:53 -04:00
interface RunPermissionDescriptor {
name: "run";
}
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
Use web standard Permissions API (#3200)
2019-10-27 11:22:53 -04:00
interface ReadWritePermissionDescriptor {
name: "read" | "write";
path?: string;
}
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
Use web standard Permissions API (#3200)
2019-10-27 11:22:53 -04:00
interface NetPermissionDescriptor {
name: "net";
url?: string;
}
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
Use web standard Permissions API (#3200)
2019-10-27 11:22:53 -04:00
interface EnvPermissionDescriptor {
name: "env";
}
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
feat: first pass at native plugins (#3372)
2019-12-05 15:30:20 -05:00
interface PluginPermissionDescriptor {
name: "plugin";
}
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
Use web standard Permissions API (#3200)
2019-10-27 11:22:53 -04:00
interface HrtimePermissionDescriptor {
name: "hrtime";
}
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Permission descriptors which define a permission which can be queried,
* requested, or revoked.
*
* See: https://w3c.github.io/permissions/#permission-descriptor */
Use web standard Permissions API (#3200)
2019-10-27 11:22:53 -04:00
type PermissionDescriptor =
| RunPermissionDescriptor
| ReadWritePermissionDescriptor
| NetPermissionDescriptor
| EnvPermissionDescriptor
feat: first pass at native plugins (#3372)
2019-12-05 15:30:20 -05:00
| PluginPermissionDescriptor
Use web standard Permissions API (#3200)
2019-10-27 11:22:53 -04:00
| HrtimePermissionDescriptor;
export class Permissions {
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** Resolves to the current status of a permission.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
Use web standard Permissions API (#3200)
2019-10-27 11:22:53 -04:00
* const status = await Deno.permissions.query({ name: "read", path: "/etc" });
* if (status.state === "granted") {
* data = await Deno.readFile("/etc/passwd");
* }
*/
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
query(desc: PermissionDescriptor): Promise<PermissionStatus>;
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** Revokes a permission, and resolves to the state of the permission.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
Use web standard Permissions API (#3200)
2019-10-27 11:22:53 -04:00
* const status = await Deno.permissions.revoke({ name: "run" });
* assert(status.state !== "granted")
*/
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
revoke(desc: PermissionDescriptor): Promise<PermissionStatus>;
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** Requests the permission, and resolves to the state of the permission.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
Add permissions.request (#3296)
2019-11-11 10:33:29 -05:00
* const status = await Deno.permissions.request({ name: "env" });
* if (status.state === "granted") {
* console.log(Deno.homeDir());
* } else {
* console.log("'env' permission is denied.");
* }
*/
request(desc: PermissionDescriptor): Promise<PermissionStatus>;
Use web standard Permissions API (#3200)
2019-10-27 11:22:53 -04:00
}
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE**: maybe move to `navigator.permissions` to match web API. */
Use web standard Permissions API (#3200)
2019-10-27 11:22:53 -04:00
export const permissions: Permissions;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** see: https://w3c.github.io/permissions/#permissionstatus */
Use web standard Permissions API (#3200)
2019-10-27 11:22:53 -04:00
export class PermissionStatus {
state: PermissionState;
constructor(state: PermissionState);
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
}
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** Synchronously truncates or extends the specified file, to reach the
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* specified `len`. If `len` is not specified then the entire file contents
* are truncated.
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* // truncate the entire file
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* Deno.truncateSync("my_file.txt");
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* // truncate part of the file
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* 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));
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-write` permission. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export function truncateSync(name: string, len?: number): void;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
/** Truncates or extends the specified file, to reach the specified `len`. If
* `len` is not specified then the entire file contents are truncated.
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* // truncate the entire file
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* await Deno.truncate("my_file.txt");
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* // truncate part of the file
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* const file = await Deno.makeTempFile();
* await Deno.writeFile(file, new TextEncoder().encode("Hello World"));
* await Deno.truncate(file, 7);
* const data = await Deno.readFile(file);
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* console.log(new TextDecoder().decode(data)); // "Hello W"
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-write` permission. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export function truncate(name: string, len?: number): Promise<void>;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE**: new API, yet to be vetted.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
* Open and initalize a plugin.
feat: first pass at native plugins (#3372)
2019-12-05 15:30:20 -05:00
*
Remove core/plugin.rs (#4824) This simplifies the plugin interface in order to deliver op crates with a similar API
2020-04-20 10:27:15 -04:00
* const rid = Deno.openPlugin("./path/to/some/plugin.so");
* const opId = Deno.core.ops()["some_op"];
* const response = Deno.core.dispatch(opId, new Uint8Array([1,2,3,4]));
feat: first pass at native plugins (#3372)
2019-12-05 15:30:20 -05:00
* console.log(`Response from plugin ${response}`);
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
Remove core/plugin.rs (#4824) This simplifies the plugin interface in order to deliver op crates with a similar API
2020-04-20 10:27:15 -04:00
* Requires `allow-plugin` permission.
*
* The plugin system is not stable and will change in the future, hence the
* lack of docs. For now take a look at the example
* https://github.com/denoland/deno/tree/master/test_plugin
*/
export function openPlugin(filename: string): number;
feat: Support Unix Domain Sockets (#4176)
2020-03-23 18:02:51 -04:00
export interface NetAddr {
transport: "tcp" | "udp";
stabilize net Addr (#3709) Co-authored-by: xiaoxintang <15707971810@163.com>
2020-01-18 15:49:55 -05:00
hostname: string;
port: number;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
}
dial/listen API change (#3000) Previously: dial("tcp", "deno.land:80") Now: dial({ hostname: "deno.land", port: 80, transport: "tcp" }) Similarly with listen().
2019-09-20 18:32:18 -04:00
feat: Support Unix Domain Sockets (#4176)
2020-03-23 18:02:51 -04:00
export interface UnixAddr {
transport: "unix" | "unixpacket";
address: string;
feat: support UDP sockets (#3946)
2020-02-21 11:26:54 -05:00
}
feat: Support Unix Domain Sockets (#4176)
2020-03-23 18:02:51 -04:00
export type Addr = NetAddr | UnixAddr;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE**: Maybe remove `ShutdownMode` entirely.
*
* Corresponds to `SHUT_RD`, `SHUT_WR`, `SHUT_RDWR` on POSIX-like systems.
*
* See: http://man7.org/linux/man-pages/man2/shutdown.2.html */
net: expose shutdown TS def (#3560)
2019-12-30 05:30:20 -05:00
export enum ShutdownMode {
Read = 0,
Write,
Update to Prettier 2 and use ES Private Fields (#4498)
2020-03-28 13:03:49 -04:00
ReadWrite, // TODO(ry) panics on ReadWrite.
net: expose shutdown TS def (#3560)
2019-12-30 05:30:20 -05:00
}
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
/** **UNSTABLE**: Both the `how` parameter and `ShutdownMode` enum are under
* consideration for removal.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
* Shutdown socket send and receive operations.
net: expose shutdown TS def (#3560)
2019-12-30 05:30:20 -05:00
*
* Matches behavior of POSIX shutdown(3).
*
* const listener = Deno.listen({ port: 80 });
* const conn = await listener.accept();
* Deno.shutdown(conn.rid, Deno.ShutdownMode.Write);
*/
export function shutdown(rid: number, how: ShutdownMode): void;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE**: new API, yet to be vetted.
*
* A generic transport listener for message-oriented protocols. */
feat: Support Unix Domain Sockets (#4176)
2020-03-23 18:02:51 -04:00
export interface DatagramConn extends AsyncIterable<[Uint8Array, Addr]> {
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE**: new API, yet to be vetted.
*
* Waits for and resolves to the next message to the `UDPConn`. */
feat: support UDP sockets (#3946)
2020-02-21 11:26:54 -05:00
receive(p?: Uint8Array): Promise<[Uint8Array, Addr]>;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** UNSTABLE: new API, yet to be vetted.
*
feat: support UDP sockets (#3946)
2020-02-21 11:26:54 -05:00
* Sends a message to the target. */
feat: Support Unix Domain Sockets (#4176)
2020-03-23 18:02:51 -04:00
send(p: Uint8Array, addr: Addr): Promise<void>;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** UNSTABLE: new API, yet to be vetted.
*
feat: support UDP sockets (#3946)
2020-02-21 11:26:54 -05:00
* Close closes the socket. Any pending message promises will be rejected
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* with errors. */
feat: support UDP sockets (#3946)
2020-02-21 11:26:54 -05:00
close(): void;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Return the address of the `UDPConn`. */
readonly addr: Addr;
fix(cli/js/net): Make generator return types iterable (#4661)
2020-04-15 06:44:09 -04:00
[Symbol.asyncIterator](): AsyncIterableIterator<[Uint8Array, Addr]>;
feat: support UDP sockets (#3946)
2020-02-21 11:26:54 -05:00
}
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** A generic network listener for stream-oriented protocols. */
refactor(cli/js/net): Cleanup iterable APIs (#4236) Listener and UDPConn are AsyncIterables instead of AsyncIterators. The [Symbol.asyncIterator]()s are defined as generators and the next() methods are gone. "Listener/Socket has been closed" errors are now BadResource.
2020-03-10 15:14:22 -04:00
export interface Listener extends AsyncIterable<Conn> {
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
/** Waits for and resolves to the next connection to the `Listener`. */
accept(): Promise<Conn>;
/** Close closes the listener. Any pending accept promises will be rejected
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* with errors. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
close(): void;
/** Return the address of the `Listener`. */
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
readonly addr: Addr;
feat: Support Unix Domain Sockets (#4176)
2020-03-23 18:02:51 -04:00
fix(cli/js/net): Make generator return types iterable (#4661)
2020-04-15 06:44:09 -04:00
[Symbol.asyncIterator](): AsyncIterableIterator<Conn>;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
}
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export interface Conn extends Reader, Writer, Closer {
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** The local address of the connection. */
readonly localAddr: Addr;
/** The remote address of the connection. */
readonly remoteAddr: Addr;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
/** The resource ID of the connection. */
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
readonly rid: number;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
/** Shuts down (`shutdown(2)`) the reading side of the TCP connection. Most
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* callers should just use `close()`. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
closeRead(): void;
/** Shuts down (`shutdown(2)`) the writing side of the TCP connection. Most
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* callers should just use `close()`. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
closeWrite(): void;
}
dial/listen API change (#3000) Previously: dial("tcp", "deno.land:80") Now: dial({ hostname: "deno.land", port: 80, transport: "tcp" }) Similarly with listen().
2019-09-20 18:32:18 -04:00
export interface ListenOptions {
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** The port to listen on. */
dial/listen API change (#3000) Previously: dial("tcp", "deno.land:80") Now: dial({ hostname: "deno.land", port: 80, transport: "tcp" }) Similarly with listen().
2019-09-20 18:32:18 -04:00
port: number;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** A literal IP address or host name that can be resolved to an IP address.
* If not specified, defaults to `0.0.0.0`. */
dial/listen API change (#3000) Previously: dial("tcp", "deno.land:80") Now: dial({ hostname: "deno.land", port: 80, transport: "tcp" }) Similarly with listen().
2019-09-20 18:32:18 -04:00
hostname?: string;
}
feat: Support Unix Domain Sockets (#4176)
2020-03-23 18:02:51 -04:00
export interface UnixListenOptions {
/** A Path to the Unix Socket. */
address: string;
}
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
/** **UNSTABLE**: new API, yet to be vetted.
feat: support UDP sockets (#3946)
2020-02-21 11:26:54 -05:00
*
* Listen announces on the local transport address.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* 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" });
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-net` permission. */
feat: support UDP sockets (#3946)
2020-02-21 11:26:54 -05:00
export function listen(
options: ListenOptions & { transport?: "tcp" }
): Listener;
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
/** **UNSTABLE**: new API, yet to be vetted.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
* Listen announces on the local transport address.
*
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* const listener = Deno.listen({ address: "/foo/bar.sock", transport: "unix" })
feat: Support Unix Domain Sockets (#4176)
2020-03-23 18:02:51 -04:00
*
* Requires `allow-read` permission. */
export function listen(
options: UnixListenOptions & { transport: "unix" }
): Listener;
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
/** **UNSTABLE**: new API, yet to be vetted.
feat: Support Unix Domain Sockets (#4176)
2020-03-23 18:02:51 -04:00
*
* Listen announces on the local transport address.
*
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* const listener1 = Deno.listen({ port: 80, transport: "udp" })
* const listener2 = Deno.listen({ hostname: "golang.org", port: 80, transport: "udp" });
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
* Requires `allow-net` permission. */
feat: support UDP sockets (#3946)
2020-02-21 11:26:54 -05:00
export function listen(
options: ListenOptions & { transport: "udp" }
feat: Support Unix Domain Sockets (#4176)
2020-03-23 18:02:51 -04:00
): DatagramConn;
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
/** **UNSTABLE**: new API, yet to be vetted.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
* Listen announces on the local transport address.
*
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* const listener = Deno.listen({ address: "/foo/bar.sock", transport: "unixpacket" })
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
feat: Support Unix Domain Sockets (#4176)
2020-03-23 18:02:51 -04:00
* Requires `allow-read` permission. */
export function listen(
options: UnixListenOptions & { transport: "unixpacket" }
): DatagramConn;
dial/listen API change (#3000) Previously: dial("tcp", "deno.land:80") Now: dial({ hostname: "deno.land", port: 80, transport: "tcp" }) Similarly with listen().
2019-09-20 18:32:18 -04:00
BREAKING CHANGE: rename TLS APIs to camel case (#4888) This commit renames all APIs containing "TLS" to use camel case (connectTLS -> connectTls, etc.)
2020-04-24 17:29:14 -04:00
export interface ListenTlsOptions extends ListenOptions {
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Server certificate file. */
feat: Deno.listenTLS (#3152)
2019-10-21 14:38:28 -04:00
certFile: string;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Server public key file. */
feat: Deno.listenTLS (#3152)
2019-10-21 14:38:28 -04:00
keyFile: string;
feat: Support Unix Domain Sockets (#4176)
2020-03-23 18:02:51 -04:00
transport?: "tcp";
feat: Deno.listenTLS (#3152)
2019-10-21 14:38:28 -04:00
}
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Listen announces on the local transport address over TLS (transport layer
* security).
feat: Deno.listenTLS (#3152)
2019-10-21 14:38:28 -04:00
*
BREAKING CHANGE: rename TLS APIs to camel case (#4888) This commit renames all APIs containing "TLS" to use camel case (connectTLS -> connectTls, etc.)
2020-04-24 17:29:14 -04:00
* const lstnr = Deno.listenTls({ port: 443, certFile: "./server.crt", keyFile: "./server.key" });
feat: Deno.listenTLS (#3152)
2019-10-21 14:38:28 -04:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-net` permission. */
BREAKING CHANGE: rename TLS APIs to camel case (#4888) This commit renames all APIs containing "TLS" to use camel case (connectTLS -> connectTls, etc.)
2020-04-24 17:29:14 -04:00
export function listenTls(options: ListenTlsOptions): Listener;
feat: Deno.listenTLS (#3152)
2019-10-21 14:38:28 -04:00
rename dial to connect and dialTLS to connectTLS (#3710)
2020-01-18 12:35:12 -05:00
export interface ConnectOptions {
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** The port to connect to. */
dial/listen API change (#3000) Previously: dial("tcp", "deno.land:80") Now: dial({ hostname: "deno.land", port: 80, transport: "tcp" }) Similarly with listen().
2019-09-20 18:32:18 -04:00
port: number;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** A literal IP address or host name that can be resolved to an IP address.
* If not specified, defaults to `127.0.0.1`. */
dial/listen API change (#3000) Previously: dial("tcp", "deno.land:80") Now: dial({ hostname: "deno.land", port: 80, transport: "tcp" }) Similarly with listen().
2019-09-20 18:32:18 -04:00
hostname?: string;
feat: Support Unix Domain Sockets (#4176)
2020-03-23 18:02:51 -04:00
transport?: "tcp";
}
export interface UnixConnectOptions {
transport: "unix";
address: string;
dial/listen API change (#3000) Previously: dial("tcp", "deno.land:80") Now: dial({ hostname: "deno.land", port: 80, transport: "tcp" }) Similarly with listen().
2019-09-20 18:32:18 -04:00
}
rename dial to connect and dialTLS to connectTLS (#3710)
2020-01-18 12:35:12 -05:00
/**
doc: API improvements to chown, close, compile and connect (#4463)
2020-03-23 00:03:45 -04:00
* Connects to the hostname (default is "127.0.0.1") and port on the named
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
* transport (default is "tcp"), and resolves to the connection (`Conn`).
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
doc: improve various API docs and include examples (#4486)
2020-03-24 23:54:41 -04:00
* const conn1 = await Deno.connect({ port: 80 });
* const conn2 = await Deno.connect({ hostname: "192.0.2.1", port: 80 });
doc: API improvements to chown, close, compile and connect (#4463)
2020-03-23 00:03:45 -04:00
* const conn3 = await Deno.connect({ hostname: "[2001:db8::1]", port: 80 });
feat: Support Unix Domain Sockets (#4176)
2020-03-23 18:02:51 -04:00
* const conn4 = await Deno.connect({ hostname: "golang.org", port: 80, transport: "tcp" });
* const conn5 = await Deno.connect({ address: "/foo/bar.sock", transport: "unix" });
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
feat: Support Unix Domain Sockets (#4176)
2020-03-23 18:02:51 -04:00
* Requires `allow-net` permission for "tcp" and `allow-read` for unix. */
export function connect(
options: ConnectOptions | UnixConnectOptions
): Promise<Conn>;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
BREAKING CHANGE: rename TLS APIs to camel case (#4888) This commit renames all APIs containing "TLS" to use camel case (connectTLS -> connectTls, etc.)
2020-04-24 17:29:14 -04:00
export interface ConnectTlsOptions {
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** The port to connect to. */
feat: Add Deno.dialTLS() Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
2019-09-23 14:40:38 -04:00
port: number;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** A literal IP address or host name that can be resolved to an IP address.
* If not specified, defaults to `127.0.0.1`. */
feat: Add Deno.dialTLS() Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
2019-09-23 14:40:38 -04:00
hostname?: string;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Server certificate file. */
feat: Deno.listenTLS (#3152)
2019-10-21 14:38:28 -04:00
certFile?: string;
feat: Add Deno.dialTLS() Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
2019-09-23 14:40:38 -04:00
}
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
doc: improve various API docs and include examples (#4486)
2020-03-24 23:54:41 -04:00
/** Establishes a secure connection over TLS (transport layer security) using
* an optional cert file, hostname (default is "127.0.0.1") 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)
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
BREAKING CHANGE: rename TLS APIs to camel case (#4888) This commit renames all APIs containing "TLS" to use camel case (connectTLS -> connectTls, etc.)
2020-04-24 17:29:14 -04:00
* const conn1 = await Deno.connectTls({ port: 80 });
* const conn2 = await Deno.connectTls({ certFile: "./certs/my_custom_root_CA.pem", hostname: "192.0.2.1", port: 80 });
* const conn3 = await Deno.connectTls({ hostname: "[2001:db8::1]", port: 80 });
* const conn4 = await Deno.connectTls({ certFile: "./certs/my_custom_root_CA.pem", hostname: "golang.org", port: 80});
doc: improve various API docs and include examples (#4486)
2020-03-24 23:54:41 -04:00
*
* Requires `allow-net` permission.
*/
BREAKING CHANGE: rename TLS APIs to camel case (#4888) This commit renames all APIs containing "TLS" to use camel case (connectTLS -> connectTls, etc.)
2020-04-24 17:29:14 -04:00
export function connectTls(options: ConnectTlsOptions): Promise<Conn>;
feat: startTLS (#4773)
2020-04-18 11:21:20 -04:00
BREAKING CHANGE: rename TLS APIs to camel case (#4888) This commit renames all APIs containing "TLS" to use camel case (connectTLS -> connectTls, etc.)
2020-04-24 17:29:14 -04:00
export interface StartTlsOptions {
feat: startTLS (#4773)
2020-04-18 11:21:20 -04:00
/** A literal IP address or host name that can be resolved to an IP address.
* If not specified, defaults to `127.0.0.1`. */
hostname?: string;
/** Server certificate file. */
certFile?: string;
}
/** **UNSTABLE**: new API, yet to be vetted.
*
* Start TLS handshake from an existing connection using
* an optional cert file, hostname (default is "127.0.0.1"). 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)
* Using this function requires that the other end of the connection is
* prepared for TLS handshake.
*
* const conn = await Deno.connect({ port: 80, hostname: "127.0.0.1" });
BREAKING CHANGE: rename TLS APIs to camel case (#4888) This commit renames all APIs containing "TLS" to use camel case (connectTLS -> connectTls, etc.)
2020-04-24 17:29:14 -04:00
* const tlsConn = await Deno.startTls(conn, { certFile: "./certs/my_custom_root_CA.pem", hostname: "127.0.0.1", port: 80 });
feat: startTLS (#4773)
2020-04-18 11:21:20 -04:00
*
* Requires `allow-net` permission.
*/
BREAKING CHANGE: rename TLS APIs to camel case (#4888) This commit renames all APIs containing "TLS" to use camel case (connectTLS -> connectTls, etc.)
2020-04-24 17:29:14 -04:00
export function startTls(
feat: startTLS (#4773)
2020-04-18 11:21:20 -04:00
conn: Conn,
BREAKING CHANGE: rename TLS APIs to camel case (#4888) This commit renames all APIs containing "TLS" to use camel case (connectTLS -> connectTls, etc.)
2020-04-24 17:29:14 -04:00
options?: StartTlsOptions
feat: startTLS (#4773)
2020-04-18 11:21:20 -04:00
): Promise<Conn>;
feat: Add Deno.dialTLS() Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
2019-09-23 14:40:38 -04:00
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE**: not sure if broken or not */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export interface Metrics {
opsDispatched: number;
feat: update metrics to track different op types (#4221)
2020-03-02 13:13:36 -05:00
opsDispatchedSync: number;
opsDispatchedAsync: number;
opsDispatchedAsyncUnref: number;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
opsCompleted: number;
feat: update metrics to track different op types (#4221)
2020-03-02 13:13:36 -05:00
opsCompletedSync: number;
opsCompletedAsync: number;
opsCompletedAsyncUnref: number;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
bytesSentControl: number;
bytesSentData: number;
bytesReceived: number;
}
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
API doc improvments (#4525)
2020-03-29 21:39:10 -04:00
/** Receive metrics from the privileged side of Deno. This is primarily used
* in the development of Deno. 'Ops', also called 'bindings', are the go-between
* between Deno Javascript and Deno Rust.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* > console.table(Deno.metrics())
feat: update metrics to track different op types (#4221)
2020-03-02 13:13:36 -05:00
* ┌─────────────────────────┬────────┐
* │ (index) │ Values │
* ├─────────────────────────┼────────┤
* │ opsDispatched │ 3 │
* │ opsDispatchedSync │ 2 │
* │ opsDispatchedAsync │ 1 │
* │ opsDispatchedAsyncUnref │ 0 │
* │ opsCompleted │ 3 │
* │ opsCompletedSync │ 2 │
* │ opsCompletedAsync │ 1 │
* │ opsCompletedAsyncUnref │ 0 │
* │ bytesSentControl │ 73 │
* │ bytesSentData │ 0 │
* │ bytesReceived │ 375 │
* └─────────────────────────┴────────┘
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*/
export function metrics(): Metrics;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE**: reconsider representation. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
interface ResourceMap {
[rid: number]: string;
}
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
/** **UNSTABLE**: The return type is under consideration and may change.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* Returns a map of open _file like_ resource ids (rid) along with their string
* representations.
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* console.log(Deno.resources()); // e.g. { 0: "stdin", 1: "stdout", 2: "stderr" }
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* Deno.openSync('../test.file');
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* console.log(Deno.resources()); // e.g. { 0: "stdin", 1: "stdout", 2: "stderr", 3: "fsFile" }
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
*/
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export function resources(): ResourceMap;
feat: Deno.fsEvents() (#3452)
2020-02-21 13:21:51 -05:00
export interface FsEvent {
kind: "any" | "access" | "create" | "modify" | "remove";
paths: string[];
}
BREAKING CHANGE: rename Deno.fsEvents() to Deno.watchFs() (#4886)
2020-04-24 17:40:29 -04:00
/** Watch for file system events against one or more `paths`, which can be files
doc: improve various API docs and include examples (#4486)
2020-03-24 23:54:41 -04:00
* 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`). 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.
*
BREAKING CHANGE: rename Deno.fsEvents() to Deno.watchFs() (#4886)
2020-04-24 17:40:29 -04:00
* const watcher = Deno.watchFs("/");
* for await (const event of watcher) {
* console.log(">>>> event", event);
* // { kind: "create", paths: [ "/foo.txt" ] }
doc: improve various API docs and include examples (#4486)
2020-03-24 23:54:41 -04:00
* }
feat: Deno.fsEvents() (#3452)
2020-02-21 13:21:51 -05:00
*
doc: improve various API docs and include examples (#4486)
2020-03-24 23:54:41 -04:00
* Requires `allow-read` permission.
*/
BREAKING CHANGE: rename Deno.fsEvents() to Deno.watchFs() (#4886)
2020-04-24 17:40:29 -04:00
export function watchFs(
feat: Deno.fsEvents() (#3452)
2020-02-21 13:21:51 -05:00
paths: string | string[],
options?: { recursive: boolean }
): AsyncIterableIterator<FsEvent>;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
/** How to handle subprocess stdio.
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* `"inherit"` The default if unspecified. The child inherits from the
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
* corresponding parent descriptor.
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* `"piped"` A new pipe should be arranged to connect the parent and child
* sub-processes.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* `"null"` This stream will be ignored. This is the equivalent of attaching
* the stream to `/dev/null`. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
type ProcessStdio = "inherit" | "piped" | "null";
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
Improve isatty and kill API docs; Deno.kill() - throw on Windows (#4497)
2020-03-26 15:52:47 -04:00
/** **UNSTABLE**: The `signo` argument may change to require the Deno.Signal
* enum.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Improve isatty and kill API docs; Deno.kill() - throw on Windows (#4497)
2020-03-26 15:52:47 -04:00
* Send a signal to process under given `pid`. This functionality currently
* only works on Linux and Mac OS.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* If `pid` is negative, the signal will be sent to the process group
* identified by `pid`.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Improve isatty and kill API docs; Deno.kill() - throw on Windows (#4497)
2020-03-26 15:52:47 -04:00
* const p = Deno.run({
* cmd: ["python", "-c", "from time import sleep; sleep(10000)"]
* });
*
* Deno.kill(p.pid, Deno.Signal.SIGINT);
*
* Throws Error (not yet implemented) on Windows
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
* Requires `allow-run` permission. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export function kill(pid: number, signo: number): void;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE**: There are some issues to work out with respect to when and
* how the process should be closed. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export class Process {
readonly rid: number;
readonly pid: number;
readonly stdin?: WriteCloser;
readonly stdout?: ReadCloser;
readonly stderr?: ReadCloser;
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** Resolves to the current status of the process. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
status(): Promise<ProcessStatus>;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Buffer the stdout and return it as `Uint8Array` after `Deno.EOF`.
*
* You must set stdout to `"piped"` when creating the process.
*
* This calls `close()` on stdout after its done. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
output(): Promise<Uint8Array>;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Buffer the stderr and return it as `Uint8Array` after `Deno.EOF`.
*
* You must set stderr to `"piped"` when creating the process.
*
* This calls `close()` on stderr after its done. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
stderrOutput(): Promise<Uint8Array>;
close(): void;
kill(signo: number): void;
}
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
Convert ProcessStatus to a tagged union (#4732)
2020-04-13 10:46:34 -04:00
export type ProcessStatus =
| {
success: true;
code: 0;
signal?: undefined;
}
| {
success: false;
code: number;
signal?: number;
};
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
BREAKING CHANGE Rename Deno.run's args to cmd (#4444) This is to avoid confusion with Deno.args which does not include the executable to be run.
2020-03-21 17:44:18 -04:00
/** **UNSTABLE**: `args` has been recently renamed to `cmd` to differentiate from
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* `Deno.args`. */
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
export interface RunOptions {
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Arguments to pass. Note, the first element needs to be a path to the
* binary */
BREAKING CHANGE Rename Deno.run's args to cmd (#4444) This is to avoid confusion with Deno.args which does not include the executable to be run.
2020-03-21 17:44:18 -04:00
cmd: string[];
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
cwd?: string;
env?: {
[key: string]: string;
};
stdout?: ProcessStdio | number;
stderr?: ProcessStdio | number;
stdin?: ProcessStdio | number;
}
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
/** Spawns new subprocess. RunOptions must contain at a minimum the `opt.cmd`,
* an array of program arguments, the first of which is the binary.
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
*
* Subprocess uses same working directory as parent process unless `opt.cwd`
* is specified.
*
* Environmental variables for subprocess can be specified using `opt.env`
* mapping.
*
* By default subprocess inherits stdio of parent process. To change that
* `opt.stdout`, `opt.stderr` and `opt.stdin` can be specified independently -
* they can be set to either `ProcessStdio` or `rid` of open file.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* Details of the spawned process are returned.
*
* const p = Deno.run({
* cmd: ["echo", "hello"],
* });
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Requires `allow-run` permission. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export function run(opt: RunOptions): Process;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
enum LinuxSignal {
SIGHUP = 1,
SIGINT = 2,
SIGQUIT = 3,
SIGILL = 4,
SIGTRAP = 5,
SIGABRT = 6,
SIGBUS = 7,
SIGFPE = 8,
SIGKILL = 9,
SIGUSR1 = 10,
SIGSEGV = 11,
SIGUSR2 = 12,
SIGPIPE = 13,
SIGALRM = 14,
SIGTERM = 15,
SIGSTKFLT = 16,
SIGCHLD = 17,
SIGCONT = 18,
SIGSTOP = 19,
SIGTSTP = 20,
SIGTTIN = 21,
SIGTTOU = 22,
SIGURG = 23,
SIGXCPU = 24,
SIGXFSZ = 25,
SIGVTALRM = 26,
SIGPROF = 27,
SIGWINCH = 28,
SIGIO = 29,
SIGPWR = 30,
Update to Prettier 2 and use ES Private Fields (#4498)
2020-03-28 13:03:49 -04:00
SIGSYS = 31,
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
}
enum MacOSSignal {
SIGHUP = 1,
SIGINT = 2,
SIGQUIT = 3,
SIGILL = 4,
SIGTRAP = 5,
SIGABRT = 6,
SIGEMT = 7,
SIGFPE = 8,
SIGKILL = 9,
SIGBUS = 10,
SIGSEGV = 11,
SIGSYS = 12,
SIGPIPE = 13,
SIGALRM = 14,
SIGTERM = 15,
SIGURG = 16,
SIGSTOP = 17,
SIGTSTP = 18,
SIGCONT = 19,
SIGCHLD = 20,
SIGTTIN = 21,
SIGTTOU = 22,
SIGIO = 23,
SIGXCPU = 24,
SIGXFSZ = 25,
SIGVTALRM = 26,
SIGPROF = 27,
SIGWINCH = 28,
SIGINFO = 29,
SIGUSR1 = 30,
Update to Prettier 2 and use ES Private Fields (#4498)
2020-03-28 13:03:49 -04:00
SIGUSR2 = 31,
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
}
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE**: make platform independent.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Signals numbers. This is platform dependent. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export const Signal: typeof MacOSSignal | typeof LinuxSignal;
refactor: rename ConsoleOptions to InspectOptions (#4493)
2020-03-25 20:48:47 -04:00
interface InspectOptions {
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
showHidden?: boolean;
depth?: number;
colors?: boolean;
indentLevel?: number;
}
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
refactor: rename ConsoleOptions to InspectOptions (#4493)
2020-03-25 20:48:47 -04:00
/** **UNSTABLE**: The exact form of the string output is under consideration
* and may change.
*
* Converts the input into a string that has the same format as printed by
* `console.log()`.
*
* const obj = {};
* obj.propA = 10;
* obj.propB = "hello"
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* const objAsString = Deno.inspect(obj); // { propA: 10, propB: "hello" }
* console.log(obj); // prints same value as objAsString, e.g. { propA: 10, propB: "hello" }
refactor: rename ConsoleOptions to InspectOptions (#4493)
2020-03-25 20:48:47 -04:00
*
* You can also register custom inspect functions, via the `customInspect` Deno
* symbol on objects, to control and customize the output.
*
* class A {
* x = 10;
* y = "hello";
* [Deno.symbols.customInspect](): string {
* return "x=" + this.x + ", y=" + this.y;
* }
* }
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* const inStringFormat = Deno.inspect(new A()); // "x=10, y=hello"
* console.log(inStringFormat); // prints "x=10, y=hello"
refactor: rename ConsoleOptions to InspectOptions (#4493)
2020-03-25 20:48:47 -04:00
*
* Finally, a number of output options are also available.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
refactor: rename ConsoleOptions to InspectOptions (#4493)
2020-03-25 20:48:47 -04:00
* const out = Deno.inspect(obj, {showHidden: true, depth: 4, colors: true, indentLevel: 2});
*
*/
export function inspect(value: unknown, options?: InspectOptions): string;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export type OperatingSystem = "mac" | "win" | "linux";
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export type Arch = "x64" | "arm64";
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
interface BuildInfo {
/** The CPU architecture. */
arch: Arch;
/** The operating system. */
os: OperatingSystem;
}
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Build related information. */
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
export const build: BuildInfo;
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
interface Version {
deno: string;
v8: string;
typescript: string;
}
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Version related information. */
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export const version: Version;
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** The log category for a diagnostic message. */
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
export enum DiagnosticCategory {
Log = 0,
Debug = 1,
Info = 2,
Error = 3,
Warning = 4,
Update to Prettier 2 and use ES Private Fields (#4498)
2020-03-28 13:03:49 -04:00
Suggestion = 5,
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
}
export interface DiagnosticMessageChain {
message: string;
category: DiagnosticCategory;
code: number;
next?: DiagnosticMessageChain[];
}
export interface DiagnosticItem {
/** A string message summarizing the diagnostic. */
message: string;
/** An ordered array of further diagnostics. */
messageChain?: DiagnosticMessageChain;
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** Information related to the diagnostic. This is present when there is a
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
* suggestion or other additional diagnostic information */
relatedInformation?: DiagnosticItem[];
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** The text of the source line related to the diagnostic. */
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
sourceLine?: string;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** The line number that is related to the diagnostic. */
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
lineNumber?: number;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** The name of the script resource related to the diagnostic. */
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
scriptResourceName?: string;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** The start position related to the diagnostic. */
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
startPosition?: number;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** The end position related to the diagnostic. */
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
endPosition?: number;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** The category of the diagnostic. */
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
category: DiagnosticCategory;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** A number identifier. */
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
code: number;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** The the start column of the sourceLine related to the diagnostic. */
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
startColumn?: number;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** The end column of the sourceLine related to the diagnostic. */
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
endColumn?: number;
}
export interface Diagnostic {
/** An array of diagnostic items. */
items: DiagnosticItem[];
}
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE**: new API, yet to be vetted.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
doc: improve various API docs and include examples (#4486)
2020-03-24 23:54:41 -04:00
* Format an array of diagnostic items and return them as a single string in a
* user friendly format.
*
* const [diagnostics, result] = Deno.compile("file_with_compile_issues.ts");
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* console.table(diagnostics); // Prints raw diagnostic data
* console.log(Deno.formatDiagnostics(diagnostics)); // User friendly output of diagnostics
doc: improve various API docs and include examples (#4486)
2020-03-24 23:54:41 -04:00
*
feat: Add Deno.formatDiagnostics (#4032)
2020-02-24 14:48:14 -05:00
* @param items An array of diagnostic items to format
*/
export function formatDiagnostics(items: DiagnosticItem[]): string;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE**: new API, yet to be vetted.
feat: Add Deno.formatDiagnostics (#4032)
2020-02-24 14:48:14 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* A specific subset TypeScript compiler options that can be supported by the
* Deno TypeScript compiler. */
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
export interface CompilerOptions {
/** Allow JavaScript files to be compiled. Defaults to `true`. */
allowJs?: boolean;
/** Allow default imports from modules with no default export. This does not
* affect code emit, just typechecking. Defaults to `false`. */
allowSyntheticDefaultImports?: boolean;
/** Allow accessing UMD globals from modules. Defaults to `false`. */
allowUmdGlobalAccess?: boolean;
/** Do not report errors on unreachable code. Defaults to `false`. */
allowUnreachableCode?: boolean;
/** Do not report errors on unused labels. Defaults to `false` */
allowUnusedLabels?: boolean;
/** Parse in strict mode and emit `"use strict"` for each source file.
* Defaults to `true`. */
alwaysStrict?: boolean;
/** Base directory to resolve non-relative module names. Defaults to
* `undefined`. */
baseUrl?: string;
/** Report errors in `.js` files. Use in conjunction with `allowJs`. Defaults
* to `false`. */
checkJs?: boolean;
/** Generates corresponding `.d.ts` file. Defaults to `false`. */
declaration?: boolean;
/** Output directory for generated declaration files. */
declarationDir?: string;
/** Generates a source map for each corresponding `.d.ts` file. Defaults to
* `false`. */
declarationMap?: boolean;
/** Provide full support for iterables in `for..of`, spread and
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* destructuring when targeting ES5 or ES3. Defaults to `false`. */
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
downlevelIteration?: boolean;
/** Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files.
* Defaults to `false`. */
emitBOM?: boolean;
/** Only emit `.d.ts` declaration files. Defaults to `false`. */
emitDeclarationOnly?: boolean;
/** Emit design-type metadata for decorated declarations in source. See issue
* [microsoft/TypeScript#2577](https://github.com/Microsoft/TypeScript/issues/2577)
* for details. Defaults to `false`. */
emitDecoratorMetadata?: boolean;
/** Emit `__importStar` and `__importDefault` helpers for runtime babel
* ecosystem compatibility and enable `allowSyntheticDefaultImports` for type
* system compatibility. Defaults to `true`. */
esModuleInterop?: boolean;
/** Enables experimental support for ES decorators. Defaults to `false`. */
experimentalDecorators?: boolean;
/** Emit a single file with source maps instead of having a separate file.
* Defaults to `false`. */
inlineSourceMap?: boolean;
/** Emit the source alongside the source maps within a single file; requires
* `inlineSourceMap` or `sourceMap` to be set. Defaults to `false`. */
inlineSources?: boolean;
/** Perform additional checks to ensure that transpile only would be safe.
* Defaults to `false`. */
isolatedModules?: boolean;
/** Support JSX in `.tsx` files: `"react"`, `"preserve"`, `"react-native"`.
* Defaults to `"react"`. */
jsx?: "react" | "preserve" | "react-native";
/** Specify the JSX factory function to use when targeting react JSX emit,
* e.g. `React.createElement` or `h`. Defaults to `React.createElement`. */
jsxFactory?: string;
/** Resolve keyof to string valued property names only (no numbers or
* symbols). Defaults to `false`. */
keyofStringsOnly?: string;
/** Emit class fields with ECMAScript-standard semantics. Defaults to `false`.
* Does not apply to `"esnext"` target. */
useDefineForClassFields?: boolean;
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** List of library files to be included in the compilation. If omitted,
Support loading additional TS lib files (#3863) Fixes #3726 This PR provides support for referencing other lib files (like lib.dom.d.ts that are not used by default in Deno.
2020-02-19 00:34:11 -05:00
* then the Deno main runtime libs are used. */
lib?: string[];
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
/** The locale to use to show error messages. */
locale?: string;
/** Specifies the location where debugger should locate map files instead of
* generated locations. Use this flag if the `.map` files will be located at
* run-time in a different location than the `.js` files. The location
* specified will be embedded in the source map to direct the debugger where
* the map files will be located. Defaults to `undefined`. */
mapRoot?: string;
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
/** Specify the module format for the emitted code. Defaults to
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
* `"esnext"`. */
module?:
| "none"
| "commonjs"
| "amd"
| "system"
| "umd"
| "es6"
| "es2015"
| "esnext";
/** Do not generate custom helper functions like `__extends` in compiled
* output. Defaults to `false`. */
noEmitHelpers?: boolean;
/** Report errors for fallthrough cases in switch statement. Defaults to
* `false`. */
noFallthroughCasesInSwitch?: boolean;
/** Raise error on expressions and declarations with an implied any type.
* Defaults to `true`. */
noImplicitAny?: boolean;
/** Report an error when not all code paths in function return a value.
* Defaults to `false`. */
noImplicitReturns?: boolean;
/** Raise error on `this` expressions with an implied `any` type. Defaults to
* `true`. */
noImplicitThis?: boolean;
/** Do not emit `"use strict"` directives in module output. Defaults to
* `false`. */
noImplicitUseStrict?: boolean;
/** Do not add triple-slash references or module import targets to the list of
* compiled files. Defaults to `false`. */
noResolve?: boolean;
/** Disable strict checking of generic signatures in function types. Defaults
* to `false`. */
noStrictGenericChecks?: boolean;
/** Report errors on unused locals. Defaults to `false`. */
noUnusedLocals?: boolean;
/** Report errors on unused parameters. Defaults to `false`. */
noUnusedParameters?: boolean;
/** Redirect output structure to the directory. This only impacts
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* `Deno.compile` and only changes the emitted file names. Defaults to
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
* `undefined`. */
outDir?: string;
/** List of path mapping entries for module names to locations relative to the
* `baseUrl`. Defaults to `undefined`. */
paths?: Record<string, string[]>;
/** Do not erase const enum declarations in generated code. Defaults to
* `false`. */
preserveConstEnums?: boolean;
/** Remove all comments except copy-right header comments beginning with
* `/*!`. Defaults to `true`. */
removeComments?: boolean;
/** Include modules imported with `.json` extension. Defaults to `true`. */
resolveJsonModule?: boolean;
/** Specifies the root directory of input files. Only use to control the
* output directory structure with `outDir`. Defaults to `undefined`. */
rootDir?: string;
/** List of _root_ folders whose combined content represent the structure of
* the project at runtime. Defaults to `undefined`. */
rootDirs?: string[];
/** Generates corresponding `.map` file. Defaults to `false`. */
sourceMap?: boolean;
/** Specifies the location where debugger should locate TypeScript files
* instead of source locations. Use this flag if the sources will be located
* at run-time in a different location than that at design-time. The location
* specified will be embedded in the sourceMap to direct the debugger where
* the source files will be located. Defaults to `undefined`. */
sourceRoot?: string;
/** Enable all strict type checking options. Enabling `strict` enables
* `noImplicitAny`, `noImplicitThis`, `alwaysStrict`, `strictBindCallApply`,
* `strictNullChecks`, `strictFunctionTypes` and
* `strictPropertyInitialization`. Defaults to `true`. */
strict?: boolean;
/** Enable stricter checking of the `bind`, `call`, and `apply` methods on
* functions. Defaults to `true`. */
strictBindCallApply?: boolean;
/** Disable bivariant parameter checking for function types. Defaults to
* `true`. */
strictFunctionTypes?: boolean;
/** Ensure non-undefined class properties are initialized in the constructor.
* This option requires `strictNullChecks` be enabled in order to take effect.
* Defaults to `true`. */
strictPropertyInitialization?: boolean;
/** In strict null checking mode, the `null` and `undefined` values are not in
* the domain of every type and are only assignable to themselves and `any`
* (the one exception being that `undefined` is also assignable to `void`). */
strictNullChecks?: boolean;
/** Suppress excess property checks for object literals. Defaults to
* `false`. */
suppressExcessPropertyErrors?: boolean;
/** Suppress `noImplicitAny` errors for indexing objects lacking index
* signatures. */
suppressImplicitAnyIndexErrors?: boolean;
/** Specify ECMAScript target version. Defaults to `esnext`. */
target?:
| "es3"
| "es5"
| "es6"
| "es2015"
| "es2016"
| "es2017"
| "es2018"
| "es2019"
| "es2020"
| "esnext";
feat: Support types compiler option in compiler APIs (#4155) Handles `types` in the compiler APIs to make it easier to supply external type libraries.
2020-02-27 11:27:00 -05:00
/** List of names of type definitions to include. Defaults to `undefined`.
*
* The type definitions are resolved according to the normal Deno resolution
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* irrespective of if sources are provided on the call. Like other Deno
* modules, there is no "magical" resolution. For example:
feat: Support types compiler option in compiler APIs (#4155) Handles `types` in the compiler APIs to make it easier to supply external type libraries.
2020-02-27 11:27:00 -05:00
*
* Deno.compile(
* "./foo.js",
* undefined,
* {
* types: [ "./foo.d.ts", "https://deno.land/x/example/types.d.ts" ]
* }
* );
*/
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
types?: string[];
}
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE**: new API, yet to be vetted.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
* The results of a transpile only command, where the `source` contains the
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* emitted source, and `map` optionally contains the source map. */
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
export interface TranspileOnlyResult {
source: string;
map?: string;
}
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE**: new API, yet to be vetted.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* Takes a set of TypeScript sources and resolves to a map where the key was
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
* the original file name provided in sources and the result contains the
* `source` and optionally the `map` from the transpile operation. This does no
* type checking and validation, it effectively "strips" the types from the
* file.
*
* const results = await Deno.transpileOnly({
* "foo.ts": `const foo: string = "foo";`
* });
*
* @param sources A map where the key is the filename and the value is the text
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* to transpile. The filename is only used in the transpile and
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
* not resolved, for example to fill in the source name in the
* source map.
* @param options An option object of options to send to the compiler. This is
* a subset of ts.CompilerOptions which can be supported by Deno.
* Many of the options related to type checking and emitting
* type declaration files will have no impact on the output.
*/
export function transpileOnly(
sources: Record<string, string>,
options?: CompilerOptions
): Promise<Record<string, TranspileOnlyResult>>;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE**: new API, yet to be vetted.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
doc: API improvements to chown, close, compile and connect (#4463)
2020-03-23 00:03:45 -04:00
* Takes a root module name, and optionally a record set of sources. Resolves
* with a compiled set of modules and possibly diagnostics if the compiler
* encountered any issues. If just a root name is provided, the modules
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
* will be resolved as if the root module had been passed on the command line.
*
* If sources are passed, all modules will be resolved out of this object, where
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* the key is the module name and the value is the content. The extension of
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
* the module name will be used to determine the media type of the module.
*
* const [ maybeDiagnostics1, output1 ] = await Deno.compile("foo.ts");
*
* const [ maybeDiagnostics2, output2 ] = await Deno.compile("/foo.ts", {
* "/foo.ts": `export * from "./bar.ts";`,
* "/bar.ts": `export const bar = "bar";`
* });
*
* @param rootName The root name of the module which will be used as the
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* "starting point". If no `sources` is specified, Deno will
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
* resolve the module externally as if the `rootName` had been
* specified on the command line.
* @param sources An optional key/value map of sources to be used when resolving
* modules, where the key is the module name, and the value is
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* the source content. The extension of the key will determine
* the media type of the file when processing. If supplied,
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
* Deno will not attempt to resolve any modules externally.
* @param options An optional object of options to send to the compiler. This is
* a subset of ts.CompilerOptions which can be supported by Deno.
*/
export function compile(
rootName: string,
sources?: Record<string, string>,
options?: CompilerOptions
Improve support for diagnostics from runtime compiler APIs (#3911) - Exports diagnostic items from `diagnostics.ts` which are missing at runtime. - Returns an array of diagnostics, instead of an object with a property of `items`. This is because of the way Rust deals with certain structures, and shouldn't be exposed in the APIs.
2020-02-07 01:54:05 -05:00
): Promise<[DiagnosticItem[] | undefined, Record<string, string>]>;
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE**: new API, yet to be vetted.
Improve API docs for Deno.bundle and Deno.chdir (#4426)
2020-03-18 19:40:06 -04:00
*
* `bundle()` is part the compiler API. A full description of this functionality
* can be found in the [manual](https://deno.land/std/manual.md#denobundle).
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
* Takes a root module name, and optionally a record set of sources. Resolves
Improve API docs for Deno.bundle and Deno.chdir (#4426)
2020-03-18 19:40:06 -04:00
* with a single JavaScript string (and bundle diagnostics if issues arise with
* the bundling) that is like the output of a `deno bundle` command. If just
* a root name is provided, the modules will be resolved as if the root module
* had been passed on the command line.
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
*
* If sources are passed, all modules will be resolved out of this object, where
* the key is the module name and the value is the content. The extension of the
* module name will be used to determine the media type of the module.
*
chore(docs): A space should be left after the single-line comment (#4811)
2020-04-22 10:21:05 -04:00
* // equivalent to "deno bundle foo.ts" from the command line
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
* const [ maybeDiagnostics1, output1 ] = await Deno.bundle("foo.ts");
*
* const [ maybeDiagnostics2, output2 ] = await Deno.bundle("/foo.ts", {
* "/foo.ts": `export * from "./bar.ts";`,
* "/bar.ts": `export const bar = "bar";`
* });
*
* @param rootName The root name of the module which will be used as the
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* "starting point". If no `sources` is specified, Deno will
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
* resolve the module externally as if the `rootName` had been
* specified on the command line.
* @param sources An optional key/value map of sources to be used when resolving
* modules, where the key is the module name, and the value is
Cleanup comments and internal variables (#4205)
2020-03-02 10:19:42 -05:00
* the source content. The extension of the key will determine
* the media type of the file when processing. If supplied,
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
* Deno will not attempt to resolve any modules externally.
* @param options An optional object of options to send to the compiler. This is
* a subset of ts.CompilerOptions which can be supported by Deno.
*/
export function bundle(
rootName: string,
sources?: Record<string, string>,
options?: CompilerOptions
Improve support for diagnostics from runtime compiler APIs (#3911) - Exports diagnostic items from `diagnostics.ts` which are missing at runtime. - Returns an array of diagnostics, instead of an object with a property of `items`. This is because of the way Rust deals with certain structures, and shouldn't be exposed in the APIs.
2020-02-07 01:54:05 -05:00
): Promise<[DiagnosticItem[] | undefined, string]>;
Runtime Compiler API (#3442) Also restructures the compiler TypeScript files to make them easier to manage and eventually integrate deno_typescript fully.
2020-01-08 09:17:44 -05:00
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** Returns the script arguments to the program. If for example we run a
* program:
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* deno --allow-read https://deno.land/std/examples/cat.ts /etc/passwd
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Then `Deno.args` will contain:
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* [ "/etc/passwd" ]
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*/
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
export const args: string[];
Add Deno.symbols and move internal fields for test (#3693)
2020-01-16 19:42:58 -05:00
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE**: new API, yet to be vetted.
Mark signal APIs as unstable (#3779)
2020-01-24 10:58:18 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Represents the stream of signals, implements both `AsyncIterator` and
* `PromiseLike`. */
feat: add std/signal/mod.ts (#3913)
2020-02-07 01:53:15 -05:00
export class SignalStream
implements AsyncIterableIterator<void>, PromiseLike<void> {
Add signal handlers (#3757)
2020-01-24 08:15:31 -05:00
constructor(signal: typeof Deno.Signal);
then<T, S>(
f: (v: void) => T | Promise<T>,
g?: (v: void) => S | Promise<S>
): Promise<T | S>;
next(): Promise<IteratorResult<void>>;
feat: add std/signal/mod.ts (#3913)
2020-02-07 01:53:15 -05:00
[Symbol.asyncIterator](): AsyncIterableIterator<void>;
Add signal handlers (#3757)
2020-01-24 08:15:31 -05:00
dispose(): void;
}
Mark signal APIs as unstable (#3779)
2020-01-24 10:58:18 -05:00
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE**: new API, yet to be vetted.
Mark signal APIs as unstable (#3779)
2020-01-24 10:58:18 -05:00
*
Add signal handlers (#3757)
2020-01-24 08:15:31 -05:00
* Returns the stream of the given signal number. You can use it as an async
* iterator.
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* for await (const _ of Deno.signal(Deno.Signal.SIGTERM)) {
* console.log("got SIGTERM!");
* }
Add signal handlers (#3757)
2020-01-24 08:15:31 -05:00
*
* You can also use it as a promise. In this case you can only receive the
* first one.
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* await Deno.signal(Deno.Signal.SIGTERM);
* console.log("SIGTERM received!")
Add signal handlers (#3757)
2020-01-24 08:15:31 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* If you want to stop receiving the signals, you can use `.dispose()` method
Add signal handlers (#3757)
2020-01-24 08:15:31 -05:00
* of the signal stream object.
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* const sig = Deno.signal(Deno.Signal.SIGTERM);
* setTimeout(() => { sig.dispose(); }, 5000);
* for await (const _ of sig) {
* console.log("SIGTERM!")
* }
Add signal handlers (#3757)
2020-01-24 08:15:31 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* The above for-await loop exits after 5 seconds when `sig.dispose()` is
doc: Improve API documentation and add examples (#4548)
2020-03-31 23:21:37 -04:00
* called.
*
* NOTE: This functionality is not yet implemented on Windows.
*/
Add signal handlers (#3757)
2020-01-24 08:15:31 -05:00
export function signal(signo: number): SignalStream;
Mark signal APIs as unstable (#3779)
2020-01-24 10:58:18 -05:00
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE**: new API, yet to be vetted. */
Add signal handlers (#3757)
2020-01-24 08:15:31 -05:00
export const signals: {
/** Returns the stream of SIGALRM signals.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
* This method is the shorthand for `Deno.signal(Deno.Signal.SIGALRM)`. */
Add signal handlers (#3757)
2020-01-24 08:15:31 -05:00
alarm: () => SignalStream;
/** Returns the stream of SIGCHLD signals.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
* This method is the shorthand for `Deno.signal(Deno.Signal.SIGCHLD)`. */
Add signal handlers (#3757)
2020-01-24 08:15:31 -05:00
child: () => SignalStream;
/** Returns the stream of SIGHUP signals.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
* This method is the shorthand for `Deno.signal(Deno.Signal.SIGHUP)`. */
Add signal handlers (#3757)
2020-01-24 08:15:31 -05:00
hungup: () => SignalStream;
/** Returns the stream of SIGINT signals.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
* This method is the shorthand for `Deno.signal(Deno.Signal.SIGINT)`. */
Add signal handlers (#3757)
2020-01-24 08:15:31 -05:00
interrupt: () => SignalStream;
/** Returns the stream of SIGIO signals.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
* This method is the shorthand for `Deno.signal(Deno.Signal.SIGIO)`. */
Add signal handlers (#3757)
2020-01-24 08:15:31 -05:00
io: () => SignalStream;
/** Returns the stream of SIGPIPE signals.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
* This method is the shorthand for `Deno.signal(Deno.Signal.SIGPIPE)`. */
Add signal handlers (#3757)
2020-01-24 08:15:31 -05:00
pipe: () => SignalStream;
/** Returns the stream of SIGQUIT signals.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
* This method is the shorthand for `Deno.signal(Deno.Signal.SIGQUIT)`. */
Add signal handlers (#3757)
2020-01-24 08:15:31 -05:00
quit: () => SignalStream;
/** Returns the stream of SIGTERM signals.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
* This method is the shorthand for `Deno.signal(Deno.Signal.SIGTERM)`. */
Add signal handlers (#3757)
2020-01-24 08:15:31 -05:00
terminate: () => SignalStream;
/** Returns the stream of SIGUSR1 signals.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
* This method is the shorthand for `Deno.signal(Deno.Signal.SIGUSR1)`. */
Add signal handlers (#3757)
2020-01-24 08:15:31 -05:00
userDefined1: () => SignalStream;
/** Returns the stream of SIGUSR2 signals.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
* This method is the shorthand for `Deno.signal(Deno.Signal.SIGUSR2)`. */
Add signal handlers (#3757)
2020-01-24 08:15:31 -05:00
userDefined2: () => SignalStream;
/** Returns the stream of SIGWINCH signals.
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
*
* This method is the shorthand for `Deno.signal(Deno.Signal.SIGWINCH)`. */
Add signal handlers (#3757)
2020-01-24 08:15:31 -05:00
windowChange: () => SignalStream;
};
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** **UNSTABLE**: new API. Maybe move `Deno.EOF` here.
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
*
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
* Special Deno related symbols. */
Add Deno.symbols and move internal fields for test (#3693)
2020-01-16 19:42:58 -05:00
export const symbols: {
/** Symbol to access exposed internal Deno API */
readonly internal: unique symbol;
Clean up lib.deno.ns.d.ts JSDoc (#4170)
2020-02-28 11:05:40 -05:00
/** A symbol which can be used as a key for a custom method which will be
* called when `Deno.inspect()` is called, or when the object is logged to
* the console. */
Add Deno.symbols and move internal fields for test (#3693)
2020-01-16 19:42:58 -05:00
readonly customInspect: unique symbol;
Mark various APIs in window.Deno as unstable (#3701)
2020-01-17 19:01:24 -05:00
// TODO(ry) move EOF here?
Add Deno.symbols and move internal fields for test (#3693)
2020-01-16 19:42:58 -05:00
};
Remove ts_library_builder, maintain lib.deno_runtime.d.ts by hand (#2827)
2019-08-30 11:11:33 -04:00
}
Copy permalink