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

deprecation(archive/unstable): deprecate @std/archive (#5988)

Browse Source 
* deprecation(archive/unstable): deprecate `@std/archive`

* update
This commit is contained in:
Asher Gomez 2024-09-17 14:38:50 +10:00 committed by GitHub
parent 65d67ce980
commit e5c67a006c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 36 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
archive/_common.ts
View File

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

3
archive/mod.ts
View File

@ -62,6 +62,9 @@
* writer.close();
* ```
*
* @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead.
* `@std/archive` will be removed in the future.
*
* @experimental **UNSTABLE**: New API, yet to be vetted.
*
* @module

12
archive/tar.ts
View File

@ -44,6 +44,9 @@ export type { TarInfo, TarMeta };
/**
* Options for {@linkcode Tar.append}.
*
* @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead.
* `@std/archive` will be removed in the future.
*
* @experimental **UNSTABLE**: New API, yet to be vetted.
*/
export interface TarOptions extends TarInfo {
@ -122,6 +125,9 @@ function formatHeader(data: TarData): Uint8Array {
/**
* Base interface for {@linkcode TarDataWithSource}.
*
* @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead.
* `@std/archive` will be removed in the future.
*
* @experimental **UNSTABLE**: New API, yet to be vetted.
*/
export interface TarData {
@ -173,6 +179,9 @@ export interface TarData {
/**
* Tar data interface for {@linkcode Tar.data}.
*
* @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead.
* `@std/archive` will be removed in the future.
*
* @experimental **UNSTABLE**: New API, yet to be vetted.
*/
export interface TarDataWithSource extends TarData {
@ -192,6 +201,9 @@ export interface TarDataWithSource extends TarData {
* single file (called an archive, or sometimes a tarball). These archives typically
* have the '.tar' extension.
*
* @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead.
* `@std/archive` will be removed in the future.
*
* ### Usage
* The workflow is to create a Tar instance, append files to it, and then write the
* tar archive to the filesystem (or other output stream). See the worked example

15
archive/untar.ts
View File

@ -46,6 +46,9 @@ export type { Reader, Seeker };
* Extend TarMeta with the `linkName` property so that readers can access
* symbolic link values without polluting the world of archive writers.
*
* @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead.
* `@std/archive` will be removed in the future.
*
* @experimental **UNSTABLE**: New API, yet to be vetted.
*/
export interface TarMetaWithLinkName extends TarMeta {
@ -56,6 +59,9 @@ export interface TarMetaWithLinkName extends TarMeta {
/**
* Tar header with raw, unprocessed bytes as values.
*
* @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead.
* `@std/archive` will be removed in the future.
*
* @experimental **UNSTABLE**: New API, yet to be vetted.
*/
export type TarHeader = {
@ -96,6 +102,9 @@ function parseHeader(buffer: Uint8Array): TarHeader {
/**
* Tar entry
*
* @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead.
* `@std/archive` will be removed in the future.
*
* @experimental **UNSTABLE**: New API, yet to be vetted.
*
* @example Usage
@ -124,6 +133,9 @@ export interface TarEntry extends TarMetaWithLinkName {}
/**
* Contains tar header metadata and a reader to the entry's body.
*
* @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead.
* `@std/archive` will be removed in the future.
*
* @experimental **UNSTABLE**: New API, yet to be vetted.
*
* @example Usage
@ -325,6 +337,9 @@ export class TarEntry implements Reader {
* files in a single file (called an archive, or sometimes a tarball). These
* archives typically have the '.tar' extension.
*
* @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead.
* `@std/archive` will be removed in the future.
*
* ### Supported file formats
* Only the ustar file format is supported. This is the most common format. The
* pax file format may also be read, but additional features, such as longer