docs: add module level docs (#2190)

This commit is contained in:
like-nanhai 2022-05-04 18:34:37 +08:00 committed by GitHub
parent b88fb9cd91
commit c75454c44b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
16 changed files with 66 additions and 11 deletions

View File

@ -1,5 +1,7 @@
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.
// This module is browser compatible.
/** This module is browser compatible.
* @module
*/
export * from "./aggregate_groups.ts";
export * from "./associate_by.ts";

View File

@ -8,6 +8,7 @@ import {
/**
* A copy of the global WebCrypto interface, with methods bound so they're
* safe to re-export.
* @module
*/
const webCrypto = ((crypto) => ({
getRandomValues: crypto.getRandomValues?.bind(crypto),

View File

@ -1,5 +1,8 @@
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.
// This module is browser compatible.
/**
* This module is browser compatible.
* @module
*/
import { DateTimeFormatter } from "./formatter.ts";

View File

@ -1,4 +1,8 @@
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.
/**
* Dotenv config
* @module
*/
import { difference, removeEmptyValues } from "./util.ts";

View File

@ -1,6 +1,9 @@
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.
// This module is browser compatible.
/**
* This module is browser compatible.
*
* @module
*/
import { assert } from "../_util/assert.ts";
/** The value returned from `parse`. */

View File

@ -1,6 +1,8 @@
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.
// This module is browser compatible.
/**
* This module is browser compatible.
* @module
*/
import { Hash } from "./_wasm/hash.ts";
import type { Hasher } from "./hasher.ts";

View File

@ -1,4 +1,8 @@
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.
/**
* Http
* @module
*/
export * from "./cookie.ts";
export * from "./http_status.ts";
export * from "./server.ts";

View File

@ -1,4 +1,8 @@
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.
/**
* IO
* @module
*/
export * from "./buffer.ts";
export * from "./readers.ts";
export * from "./streams.ts";

View File

@ -1,4 +1,8 @@
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.
/**
* log
* @module
*/
import { Logger } from "./logger.ts";
import type { GenericFunction } from "./logger.ts";
import {

View File

@ -1,2 +1,6 @@
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.
/**
* Mime
* @module
*/
export * from "./multipart.ts";

View File

@ -1,7 +1,11 @@
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.
// Copyright the Browserify authors. MIT License.
// Ported mostly from https://github.com/browserify/path-browserify/
// This module is browser compatible.
/**
* Ported mostly from https://github.com/browserify/path-browserify/
* This module is browser compatible.
* @module
*/
import { isWindows } from "../_util/os.ts";
import * as _win32 from "./win32.ts";

View File

@ -1,4 +1,8 @@
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.
/**
* Permission
* @module
*/
const { PermissionDenied } = Deno.errors;

View File

@ -1,4 +1,9 @@
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.
/**
* Signal
*
* @module
*/
import { MuxAsyncIterator } from "../async/mux_async_iterator.ts";
import { deferred } from "../async/deferred.ts";

View File

@ -1,5 +1,9 @@
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.
/**
* Streams
*
* @module
*/
export * from "./buffer.ts";
export * from "./conversion.ts";
export * from "./delimiter.ts";

View File

@ -1,8 +1,11 @@
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.
// Based on https://github.com/golang/go/tree/master/src/net/textproto
// Copyright 2009 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
/**
* Use of this source code is governed by a BSD-style
* license that can be found in the LICENSE file.
* @module
*/
import type { BufReader, ReadLineResult } from "../io/buffer.ts";
import { concat } from "../bytes/mod.ts";

View File

@ -3,6 +3,10 @@
// Based on https://github.com/kelektiv/node-uuid -> https://www.ietf.org/rfc/rfc4122.txt
// Supporting Support for RFC4122 version 1, 4, and 5 UUIDs
/**
* UUID
* @module
*/
import * as v1 from "./v1.ts";
import * as v4 from "./v4.ts";