Skip to content

Latest commit

 

History

History
115 lines (80 loc) · 3.69 KB

README.md

File metadata and controls

115 lines (80 loc) · 3.69 KB
Raw

Deno Standard Library Extended

JSR @stdext codecov ci

An extension of the Deno Standard Library.

Multiple languages such as Rust, Go and PHP offer a standard library, which allows the reduction of third-party libraries. This project is used to extend the Deno STD, with functions that are not accepted in the main library, but which are provided in the standard library of other languages.

Installation

Add the JSR package.

deno add @stdext/[package]

Example:

deno add @stdext/encoding

Usage

Import the module or sub-module.

import { dump } from "@stdext/encoding/hex";

const buffer = new TextEncoder().encode(
  "The quick brown fox jumps over the lazy dog.",
);
console.log(dump(buffer));
// 00000000  54 68 65 20 71 75 69 63  6b 20 62 72 6f 77 6e 20  |The quick brown |
// 00000010  66 6f 78 20 6a 75 6d 70  73 20 6f 76 65 72 20 74  |fox jumps over t|
// 00000020  68 65 20 6c 61 7a 79 20  64 6f 67 2e              |he lazy dog.|

Packages

  • crypto: The crypto package contains utility for crypto and hashing
  • encoding: The encoding package contains utility for text encoding.
  • http: The http package contains utility for fetching and http servers
  • json: The json package, contains helpers for json parsing, querying (jsonpath) and processing
  • lexer: The lexer package contains general purpose lexers/tokenizers
  • types: The types package, contains general purpose type helpers

Versioning

We follow the semantic versioning scheme. We will share major versions with Deno STD, but minor and patch versions will be separated.

Dependencies

We allow the following dependencies for JS:

We allow no additional third-party dependencies for JS, thus all code must be implemented.

For modules that use Rust to compile to WASM, we allow the usage of third-party crates if necessary, but this will be considered on a case-by-case basis.

WASM

All wasm code is generated from the rust workspace in the _wasm folder.

To generate the wasm code:

deno task build:wasm

This will call the build_wasm.ts script and will place each generated lib in its respective package based on its prefix. See script for more details.

Deprecation Policy

We follow the Deno STD Deprecation Policy.

When functionalities are adopted either by JavaScript language APIs, new Web Standard APIs or Deno STD, we mark the functions as deprecated, and will remove these earliest after 3 minor iterations (sometimes can take longer).

For deprecated functions and modules, and their replacement, see the deprecation document.

Contributing

To contribute, first open an issue to describe the addition. After getting feedback and approval, open a PR linking to the issue.

Code that is copied from other places, must be credited and is only allowed if the license allows for it.

Acknowledgments

This repo is an extension of the Deno STD and is therefore heavily based on it. Code tools and setup are based on work done by the Deno Team.