Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Module

std/README.md

The Deno Standard Library
Latest
File

Deno Standard Library

JSR @std codecov ci

High-quality APIs for Deno and the web. Use fearlessly.

NOTE: The standard library is also available on JSR - check out the @std scope on JSR here.

Get Started

import { copy } from "https://deno.land/std@0.224.0/fs/copy.ts";

await copy("./foo", "./bar");

See here for recommended usage patterns.

Documentation

Check out the documentation here.

  1. Include the version of the library in the import specifier.

    Good:

    import { copy } from "https://deno.land/std@0.224.0/fs/copy.ts";
  2. Only import modules that you require.

    Bad (when using only one function):

    import * as fs from "https://deno.land/std@0.224.0/fs/mod.ts";

    Good (when using only one function):

    import { copy } from "https://deno.land/std@0.224.0/fs/copy.ts";

    Good (when using multiple functions):

    import * as fs from "https://deno.land/std@0.224.0/fs/mod.ts";
  3. Do not import symbols with a name prefixed by an underscore (they’re not intended for public use).

    Bad:

    import { _format } from "https://deno.land/std@0.224.0/path/_common/format.ts";
  4. Do not import modules with a directory or filename prefixed by an underscore (they’re not intended for public use).

    Bad:

    import { createLPS } from "https://deno.land/std@0.224.0/streams/_common.ts";

    Good:

    import { TextLineStream } from "https://deno.land/std@0.224.0/streams/text_line_stream.ts";
  5. Do not import test modules or test data.

    Bad:

    import { test } from "https://deno.land/std@0.224.0/front_matter/test.ts";

Packages

For a package to reach v1 (aka stable) status, it must meet the following requirements:

  1. Approved by four members of the internal team. There must be consensus that the API design is satisfactory and unlikely to change in the future.
  2. 100% documented, passing deno doc --lint checks and adhering to the documentation guidelines.
  3. Maximum possible test coverage
  4. No open issues or pull requests that might lead to breaking changes. For example, issues that suggest new non-breaking features are fine to exist at stabilization.
Package Status Latest version
archive Unstable JSR
assert Settled JSR
async Settled JSR
bytes Settled JSR
cli Unstable JSR
collections Settled JSR
console Deprecated JSR
crypto Settled JSR
csv Settled JSR
data_structures Unstable JSR
datetime Unstable JSR
dotenv Unstable JSR
encoding Settled JSR
expect Unstable JSR
flags Deprecated JSR
fmt Settled JSR
front_matter Settled JSR
fs Settled JSR
html Unstable JSR
http Unstable JSR
ini Unstable JSR
io Unstable JSR
json Settled JSR
jsonc Settled JSR
log Unstable JSR
media_types Settled JSR
msgpack Unstable JSR
net Unstable JSR
path Settled JSR
permissions Deprecated JSR
regexp Unstable JSR
semver Unstable JSR
streams Settled JSR
testing Settled JSR
text Unstable JSR
toml Settled JSR
ulid Unstable JSR
url Unstable JSR
uuid Settled JSR
webgpu Unstable JSR
yaml Settled JSR

Note: Settled status means a package is unlikely to have breaking changes, but has not yet achieved v1 status.

Architecture

Check out the architecture guide here.

Design

Minimal Exports

Files are structured to minimize the number of dependencies they incur and the amount of effort required to manage them, both for the maintainer and the user. In most cases, only a single function or class, alongside its related types, are exported. In other cases, functions that incur negligible dependency overhead will be grouped together in the same file.

Deprecation Policy

We deprecate the APIs in the Standard Library when they get covered by new JavaScript language APIs or new Web Standard APIs. These APIs are usually removed after 3 minor versions.

If you still need to use such APIs after the removal for some reason (for example, the usage in Fresh island), please use the URL pinned to the version where they are still available.

For example, if you want to keep using readableStreamFromIterable, which was deprecated and removed in favor of ReadableStream.from in v0.195.0, please use the import URL pinned to v0.194.0:

import { readableStreamFromIterable } from "https://deno.land/std@0.194.0/streams/readable_stream_from_iterable.ts";

Contributing

Check out the contributing guidelines here.

Releases

The Standard Library is versioned independently of the Deno CLI. This will change once the Standard Library is stabilized. See here for the compatibility of different versions of the Deno Standard Library and the Deno CLI.

A new minor version of the Standard Library is published at the same time as every new version of the Deno CLI (including patch versions).

Badge

Built with the Deno Standard Library

<a href="https://deno.land/std">
  <img
    width="135"
    height="20"
    src="https://raw.githubusercontent.com/denoland/deno_std/main/badge.svg"
    alt="Built with the Deno Standard Library"
  />
</a>
[![Built with the Deno Standard Library](https://raw.githubusercontent.com/denoland/deno_std/main/badge.svg)](https://deno.land/std)