|
|
||
|---|---|---|
| _util | ||
| _wasm_crypto | ||
| .github | ||
| archive | ||
| async | ||
| bytes | ||
| collections | ||
| crypto | ||
| datetime | ||
| encoding | ||
| examples | ||
| flags | ||
| fmt | ||
| fs | ||
| hash | ||
| http | ||
| io | ||
| log | ||
| mime | ||
| node | ||
| path | ||
| permissions | ||
| signal | ||
| testing | ||
| textproto | ||
| uuid | ||
| wasi | ||
| ws | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| browser-compat.tsconfig.json | ||
| LICENSE | ||
| README.md | ||
| Releases.md | ||
| strict-ts44.tsconfig.json | ||
| test_import_map.json | ||
| version.ts | ||
Deno Standard Modules
These modules do not have external dependencies and they are reviewed by the Deno core team. The intention is to have a standard set of high quality code that all Deno projects can use fearlessly.
Contributions are welcome!
Releases
Standard library is currently tagged independently of Deno version. This will change once the library is stabilized.
To check compatibility of different version of standard library with Deno CLI see this list.
How to use
These modules will eventually be tagged in accordance with Deno releases but as of today we do not yet consider them stable and so we version the standard modules differently from the Deno runtime to reflect this.
It is strongly recommended that you link to tagged releases to avoid unintended updates and breaking changes.
Don't link to / import any module whose path:
- Has a name or parent with an underscore prefix:
_foo.ts,_util/bar.ts. - Is that of a test module or test data:
test.ts,foo_test.ts,testdata/bar.txt.
Don't import any symbol with an underscore prefix: export function _baz() {}.
These elements are not considered part of the public API, thus no stability is guaranteed for them.
Documentation
To browse documentation for modules:
- Go to https://deno.land/std/.
- Navigate to any module of interest.
- Click "View Documentation".
Contributing
NOTE: This repository was unarchived and synced on Feb, 1st, 2021. If you already had it cloned, we suggest to do a fresh clone to avoid git conflicts.
deno_std is a loose port of Go's standard library. When in doubt, simply port Go's source code, documentation, and tests. There are many times when the nature of JavaScript, TypeScript, or Deno itself justifies diverging from Go, but if possible we want to leverage the energy that went into building Go. We generally welcome direct ports of Go's code.
Please ensure the copyright headers cite the code's origin.
Follow the style guide.
Opening a pull request
Before opening a PR make sure to:
- there are tests that cover the changes.
deno test --unstable --allow-allpasses.deno fmt --checkpasses without changing files.deno lint --unstablepasses.
Give the PR a descriptive title.
Examples of good title:
- fix(http): Fix race condition in server
- docs(fmt): Update docstrings
- feat(log): Handle nested messages
Examples of bad title:
- fix #7123
- update docs
- fix bugs
Ensure there is a related issue and it is referenced in the PR text.
For contributions to the Node compatibility library please check the
std/node contributing guide
About CI checks:
We currently have 9 checks on CI. You need to pass the following 6 checks for your PR to be accepted:
- test with Deno 1.x on Windows
- test with Deno 1.x on Linux
- test with Deno 1.x on macOS
- lint
- wasm crypto check
- CLA
You don't need to pass the following 3 checks (These are informative checks for maintainers):
- test with Deno canary on Windows
- test with Deno canary on Linux
- test with Deno canary on macOS
Typechecking code in Markdown files:
If you want to run deno test --doc x.md you will need to specify the flag
--import-map=test_import_map.json, this import map is in the root of deno_std.
For maintainers:
To release a new version a tag in the form of x.y.z should be added.