2018-12-18 23:25:49 +00:00
|
|
|
# Deno Standard Modules
|
2018-11-07 19:28:47 +00:00
|
|
|
|
2021-03-17 08:30:10 +00:00
|
|
|
[![codecov](https://codecov.io/gh/denoland/deno_std/branch/main/graph/badge.svg?token=w6s3ODtULz)](https://codecov.io/gh/denoland/deno_std)
|
|
|
|
|
2019-01-15 17:28:09 +00:00
|
|
|
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.
|
2019-01-03 16:40:09 +00:00
|
|
|
|
2019-01-15 17:28:09 +00:00
|
|
|
Contributions are welcome!
|
2019-01-03 16:40:09 +00:00
|
|
|
|
2021-02-03 20:47:28 +00:00
|
|
|
## 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
|
2022-03-06 11:44:54 +00:00
|
|
|
[this list](https://raw.githubusercontent.com/denoland/dotland/main/versions.json).
|
2021-02-03 20:47:28 +00:00
|
|
|
|
2019-01-15 17:28:09 +00:00
|
|
|
## How to use
|
2019-01-03 16:40:09 +00:00
|
|
|
|
2020-06-28 16:25:20 +00:00
|
|
|
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.
|
2019-01-03 16:40:09 +00:00
|
|
|
|
2020-05-09 12:34:47 +00:00
|
|
|
It is strongly recommended that you link to tagged releases to avoid unintended
|
2020-06-28 16:25:20 +00:00
|
|
|
updates and breaking changes.
|
2020-05-09 12:34:47 +00:00
|
|
|
|
|
|
|
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`.
|
|
|
|
|
2020-07-11 04:52:18 +00:00
|
|
|
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.
|
2018-12-24 15:28:01 +00:00
|
|
|
|
2019-04-13 19:30:56 +00:00
|
|
|
## Documentation
|
|
|
|
|
2020-05-09 12:34:47 +00:00
|
|
|
To browse documentation for modules:
|
|
|
|
|
|
|
|
- Go to https://deno.land/std/.
|
2020-07-11 04:52:18 +00:00
|
|
|
- Click "View Documentation".
|
2022-11-27 19:00:03 +00:00
|
|
|
- Navigate to any module of interest.
|
2019-04-13 19:30:56 +00:00
|
|
|
|
2019-02-12 23:23:49 +00:00
|
|
|
## Contributing
|
2019-01-04 04:13:21 +00:00
|
|
|
|
2023-10-25 04:21:05 +00:00
|
|
|
Check out the contributing guidelines [here](./CONTRIBUTING.md).
|