Deno/std
1
0
Fork 0
mirror of https://github.com/denoland/std.git synced 2024-11-22 04:59:05 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs(archive): clarify deprecation notices (#6034)

Browse Source 
* docs(archive): clarify deprecation notices

* tweak
This commit is contained in:
Asher Gomez 2024-09-24 16:33:53 +10:00 committed by GitHub
parent 5d4b49da33
commit 4e4f3f1fe6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
archive/_common.ts
View File

@ -7,7 +7,7 @@ import type { Reader } from "@std/io/types";
* Base interface for {@linkcode TarMeta}. * Base interface for {@linkcode TarMeta}.
* *
* @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead. * @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead.
* `@std/archive` will be removed after 0.225.4. * `@std/archive` will be removed in the future.
* *
* @experimental **UNSTABLE**: New API, yet to be vetted. * @experimental **UNSTABLE**: New API, yet to be vetted.
*/ */
@ -48,7 +48,7 @@ export interface TarInfo {
* Base interface for {@linkcode TarMetaWithLinkName}. * Base interface for {@linkcode TarMetaWithLinkName}.
* *
* @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead. * @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead.
* `@std/archive` will be removed after 0.225.4. * `@std/archive` will be removed in the future.
* *
* @experimental **UNSTABLE**: New API, yet to be vetted. * @experimental **UNSTABLE**: New API, yet to be vetted.
*/ */

2
archive/mod.ts
View File

@ -63,7 +63,7 @@
* ``` * ```
* *
* @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead. * @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead.
* `@std/archive` will be removed after 0.225.4. * `@std/archive` will be removed in the future.
* *
* @experimental **UNSTABLE**: New API, yet to be vetted. * @experimental **UNSTABLE**: New API, yet to be vetted.
* *

8
archive/tar.ts
View File

@ -45,7 +45,7 @@ export type { TarInfo, TarMeta };
* Options for {@linkcode Tar.append}. * Options for {@linkcode Tar.append}.
* *
* @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead. * @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead.
* `@std/archive` will be removed after 0.225.4. * `@std/archive` will be removed in the future.
* *
* @experimental **UNSTABLE**: New API, yet to be vetted. * @experimental **UNSTABLE**: New API, yet to be vetted.
*/ */
@ -126,7 +126,7 @@ function formatHeader(data: TarData): Uint8Array {
* Base interface for {@linkcode TarDataWithSource}. * Base interface for {@linkcode TarDataWithSource}.
* *
* @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead. * @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead.
* `@std/archive` will be removed after 0.225.4. * `@std/archive` will be removed in the future.
* *
* @experimental **UNSTABLE**: New API, yet to be vetted. * @experimental **UNSTABLE**: New API, yet to be vetted.
*/ */
@ -180,7 +180,7 @@ export interface TarData {
* Tar data interface for {@linkcode Tar.data}. * Tar data interface for {@linkcode Tar.data}.
* *
* @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead. * @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead.
* `@std/archive` will be removed after 0.225.4. * `@std/archive` will be removed in the future.
* *
* @experimental **UNSTABLE**: New API, yet to be vetted. * @experimental **UNSTABLE**: New API, yet to be vetted.
*/ */
@ -202,7 +202,7 @@ export interface TarDataWithSource extends TarData {
* have the '.tar' extension. * have the '.tar' extension.
* *
* @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead. * @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead.
* `@std/archive` will be removed after 0.225.4. * `@std/archive` will be removed in the future.
* *
* ### Usage * ### Usage
* The workflow is to create a Tar instance, append files to it, and then write the * The workflow is to create a Tar instance, append files to it, and then write the

10
archive/untar.ts
View File

@ -47,7 +47,7 @@ export type { Reader, Seeker };
* symbolic link values without polluting the world of archive writers. * symbolic link values without polluting the world of archive writers.
* *
* @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead. * @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead.
* `@std/archive` will be removed after 0.225.4. * `@std/archive` will be removed in the future.
* *
* @experimental **UNSTABLE**: New API, yet to be vetted. * @experimental **UNSTABLE**: New API, yet to be vetted.
*/ */
@ -60,7 +60,7 @@ export interface TarMetaWithLinkName extends TarMeta {
* Tar header with raw, unprocessed bytes as values. * Tar header with raw, unprocessed bytes as values.
* *
* @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead. * @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead.
* `@std/archive` will be removed after 0.225.4. * `@std/archive` will be removed in the future.
* *
* @experimental **UNSTABLE**: New API, yet to be vetted. * @experimental **UNSTABLE**: New API, yet to be vetted.
*/ */
@ -103,7 +103,7 @@ function parseHeader(buffer: Uint8Array): TarHeader {
* Tar entry * Tar entry
* *
* @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead. * @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead.
* `@std/archive` will be removed after 0.225.4. * `@std/archive` will be removed in the future.
* *
* @experimental **UNSTABLE**: New API, yet to be vetted. * @experimental **UNSTABLE**: New API, yet to be vetted.
* *
@ -134,7 +134,7 @@ export interface TarEntry extends TarMetaWithLinkName {}
* Contains tar header metadata and a reader to the entry's body. * Contains tar header metadata and a reader to the entry's body.
* *
* @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead. * @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead.
* `@std/archive` will be removed after 0.225.4. * `@std/archive` will be removed in the future.
* *
* @experimental **UNSTABLE**: New API, yet to be vetted. * @experimental **UNSTABLE**: New API, yet to be vetted.
* *
@ -338,7 +338,7 @@ export class TarEntry implements Reader {
* archives typically have the '.tar' extension. * archives typically have the '.tar' extension.
* *
* @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead. * @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead.
* `@std/archive` will be removed after 0.225.4. * `@std/archive` will be removed in the future.
* *
* ### Supported file formats * ### Supported file formats
* Only the ustar file format is supported. This is the most common format. The * Only the ustar file format is supported. This is the most common format. The