diff options
| author | Ryan Dahl <ry@tinyclouds.org> | 2020-05-09 09:15:26 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-05-09 09:15:26 -0400 |
| commit | d5dd5ae87d7598643a46f27fa4a11b2a85d42be8 (patch) | |
| tree | a85263c25eda5d29669be039e6a83b58ac61a309 /docs/runtime | |
| parent | 5de077ab6558129d57e1212e0896caa5d5318eb1 (diff) | |
std/0.50.0
Add std/version.ts and document unstableness of std.
Diffstat (limited to 'docs/runtime')
| -rw-r--r-- | docs/runtime/stability.md | 21 | ||||
| -rw-r--r-- | docs/runtime/unstable.md | 15 |
2 files changed, 21 insertions, 15 deletions
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**. |