diff options
author | Chris Knight <cknight1234@gmail.com> | 2020-05-27 03:12:02 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-05-26 22:12:02 -0400 |
commit | 27708fe87316d11b8d99459db257d381ee049430 (patch) | |
tree | 0cd12b3dc170f71bad5c01212d313d2cc699f69b /docs/runtime/stability.md | |
parent | f7b4523178b01a7e485e98443f03a6973df3e376 (diff) |
doc: various runtime doc updates (#5885)
Diffstat (limited to 'docs/runtime/stability.md')
-rw-r--r-- | docs/runtime/stability.md | 21 |
1 files changed, 16 insertions, 5 deletions
diff --git a/docs/runtime/stability.md b/docs/runtime/stability.md index 7fcc0f0b0..298a788d4 100644 --- a/docs/runtime/stability.md +++ b/docs/runtime/stability.md @@ -5,17 +5,28 @@ 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: +`--unstable` command line flag. + +```shell +deno run --unstable mod_which_uses_unstable_stuff.ts +``` + +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) + [`lib.deno.unstable.d.ts`](https://doc.deno.land/https/raw.githubusercontent.com/denoland/deno/master/cli/js/lib.deno.unstable.d.ts) file to the list of TypeScript definitions that are used for type checking. This includes the output of `deno types`. -You should be aware that unstable APIs have probably **not undergone a security +You should be aware that many unstable APIs have **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. +### Standard modules + +Deno's standard modules (https://deno.land/std/) are not yet stable. We +currently version the standard modules differently from the CLI to reflect this. +Note that unlike the `Deno` namespace, the use of the standard modules do not +require the `--unstable` flag (unless the standard module itself makes use of an +unstable Deno feature). |