Skip to main content
Home
Browse packagesDocs
Sign In with GitHubSign In with GitLab

@std/archive@0.215.0

latest
Works with
It is unknown whether this package works with Browsers, Deno, Node.js, Cloudflare Workers, Bun
It is unknown whether this package works with Browsers
It is unknown whether this package works with Deno
It is unknown whether this package works with Node.js
It is unknown whether this package works with Cloudflare Workers
It is unknown whether this package works with Bun
•JSR Score47%•
Published2 years ago (0.215.0)
default

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.

Classes

c
Tar()

Overview

  • append(
    filenameInArchive: string,
    source: TarOptions
    ): Promise<void>

    Append a file or reader of arbitrary content to this tar archive. Directories appended to the archive append only the directory itself to the archive, not its contents. To add a directory and its contents, recursively append the directory's contents. Directories and subdirectories will be created automatically in the archive as required.

  • data: TarDataWithSource[]
    No documentation available
  • getReader(): Reader

    Get a Reader instance for this tar archive.

c
Untar(reader: Reader)

Overview

  • block: Uint8Array
    No documentation available
  • extract(): Promise<TarEntry | null>

    Extract the next entry of the tar archive.

  • reader: Reader
    No documentation available

Interfaces

I
TarData
No documentation available
  • checksum: string
    No documentation available
  • fileMode: string
    No documentation available
  • fileName: string
    No documentation available
  • fileNamePrefix: string
    No documentation available
  • fileSize: string
    No documentation available
  • gid: string
    No documentation available
  • group: string
    No documentation available
  • mtime: string
    No documentation available
  • owner: string
    No documentation available
  • type: string
    No documentation available
  • uid: string
    No documentation available
  • ustar: string
    No documentation available
I
TarDataWithSource
No documentation available
I
c
TarEntry
No documentation available
  • consumed(): boolean
    No documentation available
  • discard(): Promise<void>
    No documentation available
  • read(p: Uint8Array): Promise<number | null>
    No documentation available
I
TarInfo
No documentation available
  • fileMode: number
    No documentation available
  • gid: number
    No documentation available
  • group: string
    No documentation available
  • mtime: number
    No documentation available
  • owner: string
    No documentation available
  • type: string
    No documentation available
  • uid: number
    No documentation available
I
TarMeta
No documentation available
  • fileName: string
    No documentation available
  • fileSize: number
    No documentation available
I
TarMetaWithLinkName

Extend TarMeta with the linkName property so that readers can access symbolic link values without polluting the world of archive writers.

  • linkName: string
    No documentation available
I
TarOptions
No documentation available
  • contentSize: number

    Size of the content to be appended. This is only required when passing a reader to the archive.

  • filePath: string

    Filepath of the file to append to the archive

  • reader: Reader

    A Reader of any arbitrary content to append to the archive

Type Aliases

T
TarHeader = [key in UstarFields]: Uint8Array
No documentation available
tar

Classes

c
Tar()

Overview

  • append(
    filenameInArchive: string,
    source: TarOptions
    ): Promise<void>

    Append a file or reader of arbitrary content to this tar archive. Directories appended to the archive append only the directory itself to the archive, not its contents. To add a directory and its contents, recursively append the directory's contents. Directories and subdirectories will be created automatically in the archive as required.

  • data: TarDataWithSource[]
    No documentation available
  • getReader(): Reader

    Get a Reader instance for this tar archive.

Interfaces

I
TarData
No documentation available
  • checksum: string
    No documentation available
  • fileMode: string
    No documentation available
  • fileName: string
    No documentation available
  • fileNamePrefix: string
    No documentation available
  • fileSize: string
    No documentation available
  • gid: string
    No documentation available
  • group: string
    No documentation available
  • mtime: string
    No documentation available
  • owner: string
    No documentation available
  • type: string
    No documentation available
  • uid: string
    No documentation available
  • ustar: string
    No documentation available
I
TarDataWithSource
No documentation available
I
TarInfo
No documentation available
  • fileMode: number
    No documentation available
  • gid: number
    No documentation available
  • group: string
    No documentation available
  • mtime: number
    No documentation available
  • owner: string
    No documentation available
  • type: string
    No documentation available
  • uid: number
    No documentation available
I
TarMeta
No documentation available
  • fileName: string
    No documentation available
  • fileSize: number
    No documentation available
I
TarOptions
No documentation available
  • contentSize: number

    Size of the content to be appended. This is only required when passing a reader to the archive.

  • filePath: string

    Filepath of the file to append to the archive

  • reader: Reader

    A Reader of any arbitrary content to append to the archive

untar

Classes

c
Untar(reader: Reader)

Overview

  • block: Uint8Array
    No documentation available
  • extract(): Promise<TarEntry | null>

    Extract the next entry of the tar archive.

  • reader: Reader
    No documentation available

Interfaces

I
c
TarEntry
No documentation available
  • consumed(): boolean
    No documentation available
  • discard(): Promise<void>
    No documentation available
  • read(p: Uint8Array): Promise<number | null>
    No documentation available
I
TarMetaWithLinkName

Extend TarMeta with the linkName property so that readers can access symbolic link values without polluting the world of archive writers.

  • linkName: string
    No documentation available

Type Aliases

T
TarHeader = [key in UstarFields]: Uint8Array
No documentation available

Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@std/archive

Import symbol

import * as archive from "@std/archive";
or

Import directly with a jsr specifier

import * as archive from "jsr:@std/archive";