diff options
Diffstat (limited to 'docs/runtime/unstable.md')
| -rw-r--r-- | docs/runtime/unstable.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/runtime/unstable.md b/docs/runtime/unstable.md new file mode 100644 index 000000000..7fc60b4f8 --- /dev/null +++ b/docs/runtime/unstable.md @@ -0,0 +1,15 @@ +## 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**. |