2.1.0 • Published 3 months ago

browser-stream-tar v2.1.0

Weekly downloads
-
License
BSD-2-Clause
Repository
github
Last release
3 months ago

npm Typed with TypeScript License bundlejs downloads GitHub Issues Build Status Styled with prettier Commitizen friendly Known Vulnerabilities Coverage Status

browser-stream-tar

split tar web-stream into a sequence of Files

example

import { files } from "browser-stream-tar";

const response = await fetch("some tar file");
for await (const file of files(response.body)) {
  console.log(file.name);
  // do something with entry.stream()
}

API

Table of Contents

BLOCKSIZE

Field Name Byte Offset Length in Bytes Field Type name 0 100 NUL-terminated if NUL fits mode 100 8 uid 108 8 gid 116 8 size 124 12 mtime 136 12 chksum 148 8 typeflag 156 1 see below linkname 157 100 NUL-terminated if NUL fits magic 257 6 must be TMAGIC (NUL term.) version 263 2 must be TVERSION uname 265 32 NUL-terminated gname 297 32 NUL-terminated devmajor 329 8 devminor 337 8 prefix 345 155 NUL-terminated if NUL fits

Type: number

File

Type: Object

Properties

decodePaxHeader

Decodes a PAX header

Parameters

  • reader ReadableStreamReader where to read from
  • buffer Uint8Array
  • file Object to be filled with values form buffer

Returns Promise[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) buffer positioned after the consumed bytes

decodeHeader

Decodes the next header.

Parameters

Returns Promise<(Uint8Array | undefined)> buffer positioned after the consumed bytes

files

Provide tar entries as Files.

Parameters

  • tar ReadableStream

Returns AsyncIterator<File>

enqueue

--512--|-----512------| | R | O | | DDDDDDDDDDDD---------HHHH | | | A0 A0 A1

buffer

+--------- size --------+ | +- remaining -+- overflow -+ | | | | HDD ... DDDDDDDDDDDDDDDDDD------------HHHHHH [BUFFER .... ] [BUFFER ... ] +----------- skip --------+

decodeString

Convert bytes into string.

Parameters

Returns string

decodeInteger

Convert ASCII octal number into number.

Parameters

Returns number

fill

Read bytes from a reader and append them to a given buffer until a requested length of the buffer is reached.

Parameters

Returns Promise<(Uint8Array | undefined)> filled up buffer

skip

Skip some bytes from a buffer.

Parameters

Returns Promise<(Uint8Array | undefined)> buffer positionend after skipped bytes

streamToUint8Array

Reads web stream content into a Uint8Array.

Parameters

  • stream ReadableStream

Returns Promise[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)

install

With npm do:

npm install browser-stream-tar

license

BSD-2-Clause

2.1.0

3 months ago

2.0.1

3 months ago

1.2.0

10 months ago

1.2.5

8 months ago

1.2.4

10 months ago

1.2.3

10 months ago

1.2.2

10 months ago

1.2.1

10 months ago

2.0.0

6 months ago

1.1.9

1 year ago

1.1.8

1 year ago

1.1.7

1 year ago

1.1.6

1 year ago

1.1.5

1 year ago

1.1.4

1 year ago

1.1.3

1 year ago

1.1.2

1 year ago

1.1.1

1 year ago

1.1.0

1 year ago

1.0.2

1 year ago

1.0.1

1 year ago

1.0.0

1 year ago