chore(std): rebuild package

lowlighter · Sep 1, 2024 · a0945fb · a0945fb
1 parent 0f5b76d
commit a0945fb
Show file tree

Hide file tree

Showing 327 changed files with 2,177 additions and 1,886 deletions.
diff --git a/std/archive/mod.ts b/std/archive/mod.ts
@@ -1,9 +1,9 @@
 /**
  * Tar is a utility for collecting multiple files (or any arbitrary data) into one
  * archive file, while untar is the inverse utility to extract the files from an
- * archive.  Files are not compressed, only collected into the archive.
+ * archive. Files are not compressed, only collected into the archive.
  *
- * ```ts
+ * ```ts no-eval
  * import { Tar } from "@std/archive/tar";
  * import { Buffer } from "@std/io/buffer";
  * import { copy } from "@std/io/copy";
@@ -31,73 +31,55 @@
  * writer.close();
  * ```
  *
- * > [!WARNING]
- * > **UNSTABLE**: New API, yet to be vetted.
- *
  * @experimental
  * @module
  */
-import type { TarInfo as _interface_TarInfo } from "jsr:@std/[email protected].0"
+import type { TarInfo as _interface_TarInfo } from "jsr:@std/[email protected].1"
 /**
  * Base interface for {@linkcode TarMeta}.
  *
- * > [!WARNING]
- * > **UNSTABLE**: New API, yet to be vetted.
- *
  * @experimental
  */
 interface TarInfo extends _interface_TarInfo {}
 export type { TarInfo }
 
-import type { TarMeta as _interface_TarMeta } from "jsr:@std/[email protected].0"
+import type { TarMeta as _interface_TarMeta } from "jsr:@std/[email protected].1"
 /**
  * Base interface for {@linkcode TarMetaWithLinkName}.
  *
- * > [!WARNING]
- * > **UNSTABLE**: New API, yet to be vetted.
- *
  * @experimental
  */
 interface TarMeta extends _interface_TarMeta {}
 export type { TarMeta }
 
-import type { TarOptions as _interface_TarOptions } from "jsr:@std/[email protected].0"
+import type { TarOptions as _interface_TarOptions } from "jsr:@std/[email protected].1"
 /**
  * Options for {@linkcode Tar.append}.
  *
- * > [!WARNING]
- * > **UNSTABLE**: New API, yet to be vetted.
- *
  * @experimental
  */
 interface TarOptions extends _interface_TarOptions {}
 export type { TarOptions }
 
-import type { TarData as _interface_TarData } from "jsr:@std/[email protected].0"
+import type { TarData as _interface_TarData } from "jsr:@std/[email protected].1"
 /**
  * Base interface for {@linkcode TarDataWithSource}.
  *
- * > [!WARNING]
- * > **UNSTABLE**: New API, yet to be vetted.
- *
  * @experimental
  */
 interface TarData extends _interface_TarData {}
 export type { TarData }
 
-import type { TarDataWithSource as _interface_TarDataWithSource } from "jsr:@std/[email protected].0"
+import type { TarDataWithSource as _interface_TarDataWithSource } from "jsr:@std/[email protected].1"
 /**
  * Tar data interface for {@linkcode Tar.data}.
  *
- * > [!WARNING]
- * > **UNSTABLE**: New API, yet to be vetted.
- *
  * @experimental
  */
 interface TarDataWithSource extends _interface_TarDataWithSource {}
 export type { TarDataWithSource }
 
-import { Tar as _class_Tar } from "jsr:@std/[email protected].0"
+import { Tar as _class_Tar } from "jsr:@std/[email protected].1"
 /**
  * ### Overview
  * A class to create a tar archive.  Tar archives allow for storing multiple files in a
@@ -124,7 +106,8 @@ import { Tar as _class_Tar } from "jsr:@std/[email protected]"
  * * Filenames (including path) cannot contain non-ASCII characters
  * * Sparse files are not supported
  *
- * @example ```ts
+ * @example Usage
+ * ```ts no-eval
  * import { Tar } from "@std/archive/tar";
  * import { Buffer } from "@std/io/buffer";
  * import { copy } from "@std/io/copy";
@@ -152,52 +135,67 @@ import { Tar as _class_Tar } from "jsr:@std/[email protected]"
  * writer.close();
  * ```
  *
- * > [!WARNING]
- * > **UNSTABLE**: New API, yet to be vetted.
- *
  * @experimental
  */
 class Tar extends _class_Tar {}
 export { Tar }
 
-import type { TarMetaWithLinkName as _interface_TarMetaWithLinkName } from "jsr:@std/[email protected]"
+import type { Reader as _interface_Reader } from "jsr:@std/[email protected]"
+/**
+ * An abstract interface which when implemented provides an interface to read bytes into an array buffer asynchronously.
+ */
+interface Reader extends _interface_Reader {}
+export type { Reader }
+
+import type { TarMetaWithLinkName as _interface_TarMetaWithLinkName } from "jsr:@std/[email protected]"
 /**
  * Extend TarMeta with the `linkName` property so that readers can access
  * symbolic link values without polluting the world of archive writers.
  *
- * > [!WARNING]
- * > **UNSTABLE**: New API, yet to be vetted.
- *
  * @experimental
  */
 interface TarMetaWithLinkName extends _interface_TarMetaWithLinkName {}
 export type { TarMetaWithLinkName }
 
-import type { TarHeader as _typeAlias_TarHeader } from "jsr:@std/[email protected].0"
+import type { TarHeader as _typeAlias_TarHeader } from "jsr:@std/[email protected].1"
 /**
  * Tar header with raw, unprocessed bytes as values.
  *
- * > [!WARNING]
- * > **UNSTABLE**: New API, yet to be vetted.
- *
  * @experimental
  */
 type TarHeader = _typeAlias_TarHeader
 export type { TarHeader }
 
-import { TarEntry as _class_TarEntry } from "jsr:@std/[email protected].0"
+import { TarEntry as _class_TarEntry } from "jsr:@std/[email protected].1"
 /**
  * Contains tar header metadata and a reader to the entry's body.
  *
- * > [!WARNING]
- * > **UNSTABLE**: New API, yet to be vetted.
- *
  * @experimental
+ * @example Usage
+ * ```ts no-assert
+ * import { TarEntry } from "@std/archive/untar";
+ * import { Buffer } from "@std/io/buffer";
+ *
+ * const content = new TextEncoder().encode("hello tar world!");
+ * const reader = new Buffer(content);
+ * const tarMeta = {
+ *   fileName: "archive/",
+ *   fileSize: 0,
+ *   fileMode: 509,
+ *   mtime: 1591800767,
+ *   uid: 1001,
+ *   gid: 1001,
+ *   owner: "deno",
+ *   group: "deno",
+ *   type: "directory",
+ * };
+ * const tarEntry: TarEntry = new TarEntry(tarMeta, reader);
+ * ```
  */
 class TarEntry extends _class_TarEntry {}
 export { TarEntry }
 
-import { Untar as _class_Untar } from "jsr:@std/[email protected].0"
+import { Untar as _class_Untar } from "jsr:@std/[email protected].1"
 /**
  * ### Overview
  * A class to extract from a tar archive.  Tar archives allow for storing multiple
@@ -219,7 +217,8 @@ import { Untar as _class_Untar } from "jsr:@std/[email protected]"
  * This utility does not support decompression which must be done before extracting
  * the files.
  *
- * @example ```ts
+ * @example Usage
+ * ```ts no-eval
  * import { Untar } from "@std/archive/untar";
  * import { ensureFile } from "@std/fs/ensure-file";
  * import { ensureDir } from "@std/fs/ensure-dir";
@@ -243,9 +242,6 @@ import { Untar as _class_Untar } from "jsr:@std/[email protected]"
  * }
  * ```
  *
- * > [!WARNING]
- * > **UNSTABLE**: New API, yet to be vetted.
- *
  * @experimental
  */
 class Untar extends _class_Untar {}

diff --git a/std/archive/tar.ts b/std/archive/tar.ts
@@ -1,64 +1,49 @@
-import type { TarInfo as _interface_TarInfo } from "jsr:@std/[email protected].0/tar"
+import type { TarInfo as _interface_TarInfo } from "jsr:@std/[email protected].1/tar"
 /**
  * Base interface for {@linkcode TarMeta}.
  *
- * > [!WARNING]
- * > **UNSTABLE**: New API, yet to be vetted.
- *
  * @experimental
  */
 interface TarInfo extends _interface_TarInfo {}
 export type { TarInfo }
 
-import type { TarMeta as _interface_TarMeta } from "jsr:@std/[email protected].0/tar"
+import type { TarMeta as _interface_TarMeta } from "jsr:@std/[email protected].1/tar"
 /**
  * Base interface for {@linkcode TarMetaWithLinkName}.
  *
- * > [!WARNING]
- * > **UNSTABLE**: New API, yet to be vetted.
- *
  * @experimental
  */
 interface TarMeta extends _interface_TarMeta {}
 export type { TarMeta }
 
-import type { TarOptions as _interface_TarOptions } from "jsr:@std/[email protected].0/tar"
+import type { TarOptions as _interface_TarOptions } from "jsr:@std/[email protected].1/tar"
 /**
  * Options for {@linkcode Tar.append}.
  *
- * > [!WARNING]
- * > **UNSTABLE**: New API, yet to be vetted.
- *
  * @experimental
  */
 interface TarOptions extends _interface_TarOptions {}
 export type { TarOptions }
 
-import type { TarData as _interface_TarData } from "jsr:@std/[email protected].0/tar"
+import type { TarData as _interface_TarData } from "jsr:@std/[email protected].1/tar"
 /**
  * Base interface for {@linkcode TarDataWithSource}.
  *
- * > [!WARNING]
- * > **UNSTABLE**: New API, yet to be vetted.
- *
  * @experimental
  */
 interface TarData extends _interface_TarData {}
 export type { TarData }
 
-import type { TarDataWithSource as _interface_TarDataWithSource } from "jsr:@std/[email protected].0/tar"
+import type { TarDataWithSource as _interface_TarDataWithSource } from "jsr:@std/[email protected].1/tar"
 /**
  * Tar data interface for {@linkcode Tar.data}.
  *
- * > [!WARNING]
- * > **UNSTABLE**: New API, yet to be vetted.
- *
  * @experimental
  */
 interface TarDataWithSource extends _interface_TarDataWithSource {}
 export type { TarDataWithSource }
 
-import { Tar as _class_Tar } from "jsr:@std/[email protected].0/tar"
+import { Tar as _class_Tar } from "jsr:@std/[email protected].1/tar"
 /**
  * ### Overview
  * A class to create a tar archive.  Tar archives allow for storing multiple files in a
@@ -85,7 +70,8 @@ import { Tar as _class_Tar } from "jsr:@std/[email protected]/tar"
  * * Filenames (including path) cannot contain non-ASCII characters
  * * Sparse files are not supported
  *
- * @example ```ts
+ * @example Usage
+ * ```ts no-eval
  * import { Tar } from "@std/archive/tar";
  * import { Buffer } from "@std/io/buffer";
  * import { copy } from "@std/io/copy";
@@ -113,9 +99,6 @@ import { Tar as _class_Tar } from "jsr:@std/[email protected]/tar"
  * writer.close();
  * ```
  *
- * > [!WARNING]
- * > **UNSTABLE**: New API, yet to be vetted.
- *
  * @experimental
  */
 class Tar extends _class_Tar {}

diff --git a/std/archive/untar.ts b/std/archive/untar.ts
@@ -1,41 +1,59 @@
-import type { TarMetaWithLinkName as _interface_TarMetaWithLinkName } from "jsr:@std/[email protected]/untar"
+import type { Reader as _interface_Reader } from "jsr:@std/[email protected]/untar"
+/**
+ * An abstract interface which when implemented provides an interface to read bytes into an array buffer asynchronously.
+ */
+interface Reader extends _interface_Reader {}
+export type { Reader }
+
+import type { TarMetaWithLinkName as _interface_TarMetaWithLinkName } from "jsr:@std/[email protected]/untar"
 /**
  * Extend TarMeta with the `linkName` property so that readers can access
  * symbolic link values without polluting the world of archive writers.
  *
- * > [!WARNING]
- * > **UNSTABLE**: New API, yet to be vetted.
- *
  * @experimental
  */
 interface TarMetaWithLinkName extends _interface_TarMetaWithLinkName {}
 export type { TarMetaWithLinkName }
 
-import type { TarHeader as _typeAlias_TarHeader } from "jsr:@std/[email protected].0/untar"
+import type { TarHeader as _typeAlias_TarHeader } from "jsr:@std/[email protected].1/untar"
 /**
  * Tar header with raw, unprocessed bytes as values.
  *
- * > [!WARNING]
- * > **UNSTABLE**: New API, yet to be vetted.
- *
  * @experimental
  */
 type TarHeader = _typeAlias_TarHeader
 export type { TarHeader }
 
-import { TarEntry as _class_TarEntry } from "jsr:@std/[email protected].0/untar"
+import { TarEntry as _class_TarEntry } from "jsr:@std/[email protected].1/untar"
 /**
  * Contains tar header metadata and a reader to the entry's body.
  *
- * > [!WARNING]
- * > **UNSTABLE**: New API, yet to be vetted.
- *
  * @experimental
+ * @example Usage
+ * ```ts no-assert
+ * import { TarEntry } from "@std/archive/untar";
+ * import { Buffer } from "@std/io/buffer";
+ *
+ * const content = new TextEncoder().encode("hello tar world!");
+ * const reader = new Buffer(content);
+ * const tarMeta = {
+ *   fileName: "archive/",
+ *   fileSize: 0,
+ *   fileMode: 509,
+ *   mtime: 1591800767,
+ *   uid: 1001,
+ *   gid: 1001,
+ *   owner: "deno",
+ *   group: "deno",
+ *   type: "directory",
+ * };
+ * const tarEntry: TarEntry = new TarEntry(tarMeta, reader);
+ * ```
  */
 class TarEntry extends _class_TarEntry {}
 export { TarEntry }
 
-import { Untar as _class_Untar } from "jsr:@std/[email protected].0/untar"
+import { Untar as _class_Untar } from "jsr:@std/[email protected].1/untar"
 /**
  * ### Overview
  * A class to extract from a tar archive.  Tar archives allow for storing multiple
@@ -57,7 +75,8 @@ import { Untar as _class_Untar } from "jsr:@std/[email protected]/untar"
  * This utility does not support decompression which must be done before extracting
  * the files.
  *
- * @example ```ts
+ * @example Usage
+ * ```ts no-eval
  * import { Untar } from "@std/archive/untar";
  * import { ensureFile } from "@std/fs/ensure-file";
  * import { ensureDir } from "@std/fs/ensure-dir";
@@ -81,9 +100,6 @@ import { Untar as _class_Untar } from "jsr:@std/[email protected]/untar"
  * }
  * ```
  *
- * > [!WARNING]
- * > **UNSTABLE**: New API, yet to be vetted.
- *
  * @experimental
  */
 class Untar extends _class_Untar {}

diff --git a/std/assert/almost_equals.ts b/std/assert/almost_equals.ts
@@ -1,4 +1,4 @@
-import { assertAlmostEquals as _function_assertAlmostEquals } from "jsr:@std/[email protected].2/almost-equals"
+import { assertAlmostEquals as _function_assertAlmostEquals } from "jsr:@std/[email protected].3/almost-equals"
 /**
  * Make an assertion that `actual` and `expected` are almost equal numbers
  * through a given tolerance. It can be used to take into account IEEE-754