1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-12-22 07:14:47 -05:00
denoland-deno/runtime
Bartek Iwańczuk 930ce20870
feat: deprecate window global (#22057)
This commit deprecates `window` global and adds deprecation
notice on each use of `window`.

We decided to proceed with removal of `window` global variable in Deno
2.0. There's a lot of code
in the wild that uses pattern like this:
```
if (typeof window !== "undefined) {
  ...
}
```
to check if the code is being run in browser. However, this check passes
fine in Deno and
most often libraries that do this check try to access some browser API
that is not available
in Deno, or use DOM APIs (which are also not available in Deno).

This situation has occurred multiple times already
and it's unfeasible to expect the whole ecosystem to migrate to new
check (and even if that
happened there's a ton of code that's already shipped and won't change).

The migration is straightfoward - replace all usages of `window` with
`globalThis` or `self`.
When Deno encounters use of `window` global it will now issue a warning,
steering users
towards required changes:

```
Warning
├ Use of deprecated "window" API.
│
├ This API will be removed in Deno 2.0. Make sure to upgrade to a stable API before then.
│
├ Suggestion: Use `globalThis` or `self` instead.
│
├ Suggestion: You can provide `window` in the current scope with: `const window = globalThis`.
│
└ Stack trace:
  └─ at file:///Users/ib/dev/deno/foo.js:7:1
```

Ref https://github.com/denoland/deno/issues/13367.
2024-01-24 14:20:51 +01:00
..
examples chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
js feat: deprecate window global (#22057) 2024-01-24 14:20:51 +01:00
ops feat: Deno.{stdin,stdout,stderr}.isTerminal(), deprecate Deno.isatty() (#22011) 2024-01-24 00:01:56 +01:00
permissions fix(ext/node): add fs.cp, fs.cpSync, promises.cp (#21745) 2024-01-05 18:28:33 +05:30
Cargo.toml fix(runtime): only discard extension sources if a snapshot is provided (#22023) 2024-01-22 12:37:25 +00:00
clippy.toml feat(compile): unstable npm and node specifier support (#19005) 2023-05-10 20:06:59 -04:00
colors.rs feat(cli): improved diagnostics printing (#22049) 2024-01-23 16:37:43 +01:00
errors.rs chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
fmt_errors.rs chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
fs_util.rs chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
inspector_server.rs chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
js.rs refactor: remove snapshotting from deno_runtime (#21794) 2024-01-10 16:30:50 +01:00
lib.rs feat: warn when using --unstable, prefer granular flags (#21452) 2024-01-23 15:33:07 +01:00
README.md fix (doc): Typo in runtime/README.md (#20020) 2023-12-13 17:24:32 +00:00
shared.rs refactor: remove snapshotting from deno_runtime (#21794) 2024-01-10 16:30:50 +01:00
snapshot.rs feat(web): ImageBitmap (#21898) 2024-01-22 12:08:01 +01:00
tokio_util.rs chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
web_worker.rs fix(runtime): only discard extension sources if a snapshot is provided (#22023) 2024-01-22 12:37:25 +00:00
worker.rs fix(runtime): only discard extension sources if a snapshot is provided (#22023) 2024-01-22 12:37:25 +00:00
worker_bootstrap.rs feat: Start warning on each use of a deprecated API (#21939) 2024-01-18 23:30:49 +00:00

deno_runtime crate

crates docs

This is a slim version of the Deno CLI which removes typescript integration and various tooling (like lint and doc). Basically only JavaScript execution with Deno's operating system bindings (ops).

Stability

This crate is built using battle-tested modules that were originally in the deno crate, however the API of this crate is subject to rapid and breaking changes.

MainWorker

The main API of this crate is MainWorker. MainWorker is a structure encapsulating deno_core::JsRuntime with a set of ops used to implement Deno namespace.

When creating a MainWorker implementors must call MainWorker::bootstrap to prepare JS runtime for use.

MainWorker is highly configurable and allows to customize many of the runtime's properties:

  • module loading implementation
  • error formatting
  • support for source maps
  • support for V8 inspector and Chrome Devtools debugger
  • HTTP client user agent, CA certificate
  • random number generator seed

Worker Web API

deno_runtime comes with support for Worker Web API. The Worker API is implemented using WebWorker structure.

When creating a new instance of MainWorker implementors must provide a callback function that is used when creating a new instance of Worker.

All WebWorker instances are descendents of MainWorker which is responsible for setting up communication with child worker. Each WebWorker spawns a new OS thread that is dedicated solely to that worker.