summaryrefslogtreecommitdiff
path: root/cli/dts/lib.deno.unstable.d.ts
diff options
context:
space:
mode:
authorDavid Sherret <dsherret@users.noreply.github.com>2021-09-02 18:28:12 -0400
committerGitHub <noreply@github.com>2021-09-02 18:28:12 -0400
commit987716798fb3bddc9abc7e12c25a043447be5280 (patch)
treeacb14305d38d8ae78877e59e6faa66a66506eed3 /cli/dts/lib.deno.unstable.d.ts
parent1bf7b90ca8ad8e2bf62e455c24d5498c9ee74a46 (diff)
feat(fmt): add basic JS doc formatting (#11902)
Diffstat (limited to 'cli/dts/lib.deno.unstable.d.ts')
-rw-r--r--cli/dts/lib.deno.unstable.d.ts254
1 files changed, 126 insertions, 128 deletions
diff --git a/cli/dts/lib.deno.unstable.d.ts b/cli/dts/lib.deno.unstable.d.ts
index 3ee628a8b..d991196cb 100644
--- a/cli/dts/lib.deno.unstable.d.ts
+++ b/cli/dts/lib.deno.unstable.d.ts
@@ -64,7 +64,6 @@ declare namespace Deno {
* ```
*
* Requires `allow-env` permission.
- *
*/
export function osRelease(): string;
@@ -80,7 +79,6 @@ declare namespace Deno {
* ```
*
* Requires `allow-env` permission.
- *
*/
export function systemMemoryInfo(): SystemMemoryInfo;
@@ -958,137 +956,137 @@ declare namespace Deno {
* Set this to "none" to revoke all permissions.
*
* Defaults to "inherit".
- */
+ */
permissions?: "inherit" | "none" | {
/** Specifies if the `net` permission should be requested or revoked.
- * If set to `"inherit"`, the current `env` permission will be inherited.
- * If set to `true`, the global `net` permission will be requested.
- * If set to `false`, the global `net` permission will be revoked.
- *
- * Defaults to "inherit".
- */
+ * If set to `"inherit"`, the current `env` permission will be inherited.
+ * If set to `true`, the global `net` permission will be requested.
+ * If set to `false`, the global `net` permission will be revoked.
+ *
+ * Defaults to "inherit".
+ */
env?: "inherit" | boolean | string[];
/** Specifies if the `hrtime` permission should be requested or revoked.
- * If set to `"inherit"`, the current `hrtime` permission will be inherited.
- * If set to `true`, the global `hrtime` permission will be requested.
- * If set to `false`, the global `hrtime` permission will be revoked.
- *
- * Defaults to "inherit".
- */
+ * If set to `"inherit"`, the current `hrtime` permission will be inherited.
+ * If set to `true`, the global `hrtime` permission will be requested.
+ * If set to `false`, the global `hrtime` permission will be revoked.
+ *
+ * Defaults to "inherit".
+ */
hrtime?: "inherit" | boolean;
/** Specifies if the `net` permission should be requested or revoked.
- * if set to `"inherit"`, the current `net` permission will be inherited.
- * if set to `true`, the global `net` permission will be requested.
- * if set to `false`, the global `net` permission will be revoked.
- * if set to `string[]`, the `net` permission will be requested with the
- * specified host strings with the format `"<host>[:<port>]`.
- *
- * Defaults to "inherit".
- *
- * Examples:
- *
- * ```ts
- * import { assertEquals } from "https://deno.land/std/testing/asserts.ts";
- *
- * Deno.test({
- * name: "inherit",
- * permissions: {
- * net: "inherit",
- * },
- * async fn() {
- * const status = await Deno.permissions.query({ name: "net" })
- * assertEquals(status.state, "granted");
- * },
- * });
- * ```
- *
- * ```ts
- * import { assertEquals } from "https://deno.land/std/testing/asserts.ts";
- *
- * Deno.test({
- * name: "true",
- * permissions: {
- * net: true,
- * },
- * async fn() {
- * const status = await Deno.permissions.query({ name: "net" });
- * assertEquals(status.state, "granted");
- * },
- * });
- * ```
- *
- * ```ts
- * import { assertEquals } from "https://deno.land/std/testing/asserts.ts";
- *
- * Deno.test({
- * name: "false",
- * permissions: {
- * net: false,
- * },
- * async fn() {
- * const status = await Deno.permissions.query({ name: "net" });
- * assertEquals(status.state, "denied");
- * },
- * });
- * ```
- *
- * ```ts
- * import { assertEquals } from "https://deno.land/std/testing/asserts.ts";
- *
- * Deno.test({
- * name: "localhost:8080",
- * permissions: {
- * net: ["localhost:8080"],
- * },
- * async fn() {
- * const status = await Deno.permissions.query({ name: "net", host: "localhost:8080" });
- * assertEquals(status.state, "granted");
- * },
- * });
- * ```
- */
+ * if set to `"inherit"`, the current `net` permission will be inherited.
+ * if set to `true`, the global `net` permission will be requested.
+ * if set to `false`, the global `net` permission will be revoked.
+ * if set to `string[]`, the `net` permission will be requested with the
+ * specified host strings with the format `"<host>[:<port>]`.
+ *
+ * Defaults to "inherit".
+ *
+ * Examples:
+ *
+ * ```ts
+ * import { assertEquals } from "https://deno.land/std/testing/asserts.ts";
+ *
+ * Deno.test({
+ * name: "inherit",
+ * permissions: {
+ * net: "inherit",
+ * },
+ * async fn() {
+ * const status = await Deno.permissions.query({ name: "net" })
+ * assertEquals(status.state, "granted");
+ * },
+ * });
+ * ```
+ *
+ * ```ts
+ * import { assertEquals } from "https://deno.land/std/testing/asserts.ts";
+ *
+ * Deno.test({
+ * name: "true",
+ * permissions: {
+ * net: true,
+ * },
+ * async fn() {
+ * const status = await Deno.permissions.query({ name: "net" });
+ * assertEquals(status.state, "granted");
+ * },
+ * });
+ * ```
+ *
+ * ```ts
+ * import { assertEquals } from "https://deno.land/std/testing/asserts.ts";
+ *
+ * Deno.test({
+ * name: "false",
+ * permissions: {
+ * net: false,
+ * },
+ * async fn() {
+ * const status = await Deno.permissions.query({ name: "net" });
+ * assertEquals(status.state, "denied");
+ * },
+ * });
+ * ```
+ *
+ * ```ts
+ * import { assertEquals } from "https://deno.land/std/testing/asserts.ts";
+ *
+ * Deno.test({
+ * name: "localhost:8080",
+ * permissions: {
+ * net: ["localhost:8080"],
+ * },
+ * async fn() {
+ * const status = await Deno.permissions.query({ name: "net", host: "localhost:8080" });
+ * assertEquals(status.state, "granted");
+ * },
+ * });
+ * ```
+ */
net?: "inherit" | boolean | string[];
/** Specifies if the `ffi` permission should be requested or revoked.
- * If set to `"inherit"`, the current `ffi` permission will be inherited.
- * If set to `true`, the global `ffi` permission will be requested.
- * If set to `false`, the global `ffi` permission will be revoked.
- *
- * Defaults to "inherit".
- */
+ * If set to `"inherit"`, the current `ffi` permission will be inherited.
+ * If set to `true`, the global `ffi` permission will be requested.
+ * If set to `false`, the global `ffi` permission will be revoked.
+ *
+ * Defaults to "inherit".
+ */
ffi?: "inherit" | boolean;
/** Specifies if the `read` permission should be requested or revoked.
- * If set to `"inherit"`, the current `read` permission will be inherited.
- * If set to `true`, the global `read` permission will be requested.
- * If set to `false`, the global `read` permission will be revoked.
- * If set to `Array<string | URL>`, the `read` permission will be requested with the
- * specified file paths.
- *
- * Defaults to "inherit".
- */
+ * If set to `"inherit"`, the current `read` permission will be inherited.
+ * If set to `true`, the global `read` permission will be requested.
+ * If set to `false`, the global `read` permission will be revoked.
+ * If set to `Array<string | URL>`, the `read` permission will be requested with the
+ * specified file paths.
+ *
+ * Defaults to "inherit".
+ */
read?: "inherit" | boolean | Array<string | URL>;
/** Specifies if the `run` permission should be requested or revoked.
- * If set to `"inherit"`, the current `run` permission will be inherited.
- * If set to `true`, the global `run` permission will be requested.
- * If set to `false`, the global `run` permission will be revoked.
- *
- * Defaults to "inherit".
- */
+ * If set to `"inherit"`, the current `run` permission will be inherited.
+ * If set to `true`, the global `run` permission will be requested.
+ * If set to `false`, the global `run` permission will be revoked.
+ *
+ * Defaults to "inherit".
+ */
run?: "inherit" | boolean | Array<string | URL>;
/** Specifies if the `write` permission should be requested or revoked.
- * If set to `"inherit"`, the current `write` permission will be inherited.
- * If set to `true`, the global `write` permission will be requested.
- * If set to `false`, the global `write` permission will be revoked.
- * If set to `Array<string | URL>`, the `write` permission will be requested with the
- * specified file paths.
- *
- * Defaults to "inherit".
- */
+ * If set to `"inherit"`, the current `write` permission will be inherited.
+ * If set to `true`, the global `write` permission will be requested.
+ * If set to `false`, the global `write` permission will be revoked.
+ * If set to `Array<string | URL>`, the `write` permission will be requested with the
+ * specified file paths.
+ *
+ * Defaults to "inherit".
+ */
write?: "inherit" | boolean | Array<string | URL>;
};
}
@@ -1335,27 +1333,27 @@ declare namespace Deno {
}
/** **UNSTABLE** New API, yet to be vetted.
- *
- * Create a TLS connection with an attached client certificate.
- *
- * ```ts
- * const conn = await Deno.connectTls({
- * hostname: "deno.land",
- * port: 443,
- * certChain: "---- BEGIN CERTIFICATE ----\n ...",
- * privateKey: "---- BEGIN PRIVATE KEY ----\n ...",
- * });
- * ```
- *
- * Requires `allow-net` permission.
- */
+ *
+ * Create a TLS connection with an attached client certificate.
+ *
+ * ```ts
+ * const conn = await Deno.connectTls({
+ * hostname: "deno.land",
+ * port: 443,
+ * certChain: "---- BEGIN CERTIFICATE ----\n ...",
+ * privateKey: "---- BEGIN PRIVATE KEY ----\n ...",
+ * });
+ * ```
+ *
+ * Requires `allow-net` permission.
+ */
export function connectTls(
options: ConnectTlsOptions & ConnectTlsClientCertOptions,
): Promise<Conn>;
export interface StartTlsOptions {
/** A literal IP address or host name that can be resolved to an IP address.
- * If not specified, defaults to `127.0.0.1`. */
+ * If not specified, defaults to `127.0.0.1`. */
hostname?: string;
/** Server certificate file. */
certFile?: string;