Skip to content

Latest commit

 

History

History
126 lines (84 loc) · 4.53 KB

FAQ.md

File metadata and controls

126 lines (84 loc) · 4.53 KB
Raw

Frequently Asked Questions

What is the Deno Standard Library?

The Deno Standard Library is a library of packages that aim to provide a robust, secure, and modern foundation for building JavaScript and TypeScript applications.

Which APIs does the Standard Library support?

The Standard Library aims to compliment the JavaScript, Web and Deno runtime APIs.

Which runtimes are compatible with the Standard Library?

By virtue of the APIs it supports, the Standard Library primarily aims to work with:

  1. Deno (latest stable version and canary)
  2. Deno Deploy
  3. Web browsers (i.e. Google Chrome, Mozilla Firefox, Apple Safari, etc.)

Other runtimes are supported to varying degrees, depending on how much they support the same APIs that the Standard Library targets. These runtimes include:

  1. Node.js
  2. Cloudflare Workers
  3. Bun

Why is the Standard Library versioned differently to the Deno runtime?

Deno is not the only runtime that the Standard Library is designed to work with (see above section). Hence, there's no reason to have Deno and the Standard Library to be versioned the same. Also, having both projects versioned independently allows them to progress asynchronously.

Which versions of Deno is the Standard Library guaranteed to work with?

The Standard Library is designed to work with the latest stable and canary versions of Deno. This is checked-for with all PRs in CI.

How is the Standard Library distributed?

The Standard Library is distributed as a library of packages on JSR, a modern package registry for JavaScript and TypeScript.

To learn more about JSR, see the documentation.

Which version of a given package should I use?

We recommend using the latest version of a given package.

Thanks to JSR, you can constrain dependency versions by defining the SemVer range in the import specifier.

E.g. If the latest major version of a package is 1, it should be imported as follows:

import { bar } from "jsr:@std/foo@^1";

The same goes if the latest major version of a package is 0:

import { bar } from "jsr:@std/foo@^0";

This approach allows for bug fixes and new features, while avoiding breaking changes.

For more information, see JSR's SemVer resolution documentation.

Why would an API be deprecated?

An API is deprecated due to one of the following reasons:

  1. It's been covered by a new JavaScript language or Web Standard API.
  2. It's been moved to a more appropriate location. E.g. To another package.
  3. It's been renamed more appropriate. E.g. To a name that more clearly describes its behavior.
  4. It's been deemed no longer fitting to the Standard Library.

When is a deprecated API removed?

In almost all cases, a deprecated API is removed in the next major version after deprecation. This is to minimize breaking changes for users.

Can I still use a deprecated API?

Yes. You can use a package version that contains the deprecated API in question by pinning the package version.

E.g. Say bar() is deprecated in @std/foo@0 and removed in @std/foo@1. Pin the import specifier to @std/foo@0 to continued use:

import { bar } from "jsr:@std/foo@^0/bar";

This is possible thanks to JSR being immutable. For more information, see JSR's Immutability documentation.

An API I was using is no longer available in the Standard Library. What happened to it?

It's most likely API has been moved, removed or renamed. These changes are always noted in, and most easily found in the release notes. To find how an API's been modified, search for your API in the Find a release search bar.

If you still cannot find the API you're looking for, please open an issue.

How can I contribute to the Standard Library?

Check out the contributing guidelines here.

How is the Standard Library codebase structured?

Check out the architecture guide here.