diff options
| -rw-r--r-- | docs/examples/os_signals.md | 2 | ||||
| -rw-r--r-- | docs/examples/permissions.md | 2 | ||||
| -rw-r--r-- | docs/linking_to_external_code/import_maps.md | 2 | ||||
| -rw-r--r-- | docs/runtime/stability.md | 21 | ||||
| -rw-r--r-- | docs/runtime/unstable.md | 15 | ||||
| -rw-r--r-- | docs/toc.json | 2 | ||||
| -rw-r--r-- | std/version.ts | 7 |
7 files changed, 32 insertions, 19 deletions
diff --git a/docs/examples/os_signals.md b/docs/examples/os_signals.md index 5f66f3340..8c8dea880 100644 --- a/docs/examples/os_signals.md +++ b/docs/examples/os_signals.md @@ -1,7 +1,7 @@ ## Handle OS Signals > This program makes use of an unstable Deno feature. Learn more about -> [unstable features](../../runtime/unstable). +> [unstable features](../runtime/stability.md). [API Reference](https://deno.land/typedoc/index.html#signal) diff --git a/docs/examples/permissions.md b/docs/examples/permissions.md index 7d404d5fc..2237d26df 100644 --- a/docs/examples/permissions.md +++ b/docs/examples/permissions.md @@ -1,7 +1,7 @@ ## Inspecting and revoking permissions > This program makes use of an unstable Deno feature. Learn more about -> [unstable features](../../runtime/unstable). +> [unstable features](../runtime/stability.md). Sometimes a program may want to revoke previously granted permissions. When a program, at a later stage, needs those permissions, it will fail. diff --git a/docs/linking_to_external_code/import_maps.md b/docs/linking_to_external_code/import_maps.md index 567adf158..de5edaa87 100644 --- a/docs/linking_to_external_code/import_maps.md +++ b/docs/linking_to_external_code/import_maps.md @@ -1,7 +1,7 @@ ## Import maps > This is an unstable feature. Learn more about -> [unstable features](../../runtime/unstable). +> [unstable features](../runtime/stability.md). Deno supports [import maps](https://github.com/WICG/import-maps). diff --git a/docs/runtime/stability.md b/docs/runtime/stability.md new file mode 100644 index 000000000..a158638b9 --- /dev/null +++ b/docs/runtime/stability.md @@ -0,0 +1,21 @@ +## Stability + +As of Deno 1.0.0, the `Deno` namespace APIs are stable. That means that we will +strive to make code working under 1.0.0 continue to work in future versions. + +However, not all of Deno's features are ready for production yet. Features which +are not ready because they are still in draft phase are locked behind the +`--unstable` command line flag. Passing this flag does a few things: + +- It enables the use of unstable APIs during runtime. +- It adds the + [`lib.deno.unstable.d.ts`](https://github.com/denoland/deno/blob/master/cli/js/lib.deno.unstable.d.ts) + file to the list of TypeScript definitions that are used for typechecking. + This includes the output of `deno types`. + +You should be aware that unstable APIs have probably **not undergone a security +review**, are likely to have **breaking API changes** in the future and are +**not ready for production**. + +Furthermore Deno's standard modules (https://deno.land/std/) are not yet stable. +We version the standard modules differently from the CLI to reflect this. diff --git a/docs/runtime/unstable.md b/docs/runtime/unstable.md deleted file mode 100644 index 7fc60b4f8..000000000 --- a/docs/runtime/unstable.md +++ /dev/null @@ -1,15 +0,0 @@ -## Unstable - -Not all of Deno's features are ready for production yet. Features which are not -ready because they are still in draft phase are locked behind the `--unstable` -command line flag. Passing this flag does a few things: - -- It enables the use of unstable APIs during runtime. -- It adds the - [`lib.deno.unstable.d.ts`](https://github.com/denoland/deno/blob/master/cli/js/lib.deno.unstable.d.ts) - file to the list of TypeScript definitions that are used for typechecking. - This includes the output of `deno types`. - -You should be aware that unstable APIs have probably **not undergone a security -review**, are likely to have **breaking API changes** in the future and are -**not ready for production**. diff --git a/docs/toc.json b/docs/toc.json index f87b1c0a5..061ba66f6 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -16,9 +16,9 @@ "runtime": { "name": "The Runtime", "children": { + "stability": "Stability", "program_lifecycle": "Program Lifecycle", "compiler_apis": "Compiler APIs", - "unstable": "Unstable APIs", "workers": "Workers" } }, diff --git a/std/version.ts b/std/version.ts new file mode 100644 index 000000000..835b0f38c --- /dev/null +++ b/std/version.ts @@ -0,0 +1,7 @@ +/** Version of the Deno standard modules + * + * Deno std is versioned differently than Deno cli because it is still unstable; + * the cli's API is stable. In the future when std becomes stable, likely we + * will match versions with cli as we have in the past. + */ +export const VERSION = "0.50.0"; |