import { Tarball } from '@obsidize/tar-browserify'; // TypeScript
// const { Tarball } = require('@obsidize/tar-browserify'); // NodeJS (Required for RunKit)

// Example 1 - Create a tarball in-memory.
//
// The Tarball class implements several shorthand methods for
// injecting content like so:
const createdTarballBuffer = new Tarball()
	.addTextFile('Test File.txt', 'This is a test file')
	.addBinaryFile('Some binary data.bin', new Uint8Array(10))
	.addDirectory('MyFolder')
	.addTextFile('MyFolder/a nested file.txt', 'this is under MyFolder')
	.toUint8Array();

// Example 2 - Decode a tarball from some Uint8Array source.
//
// Here we use the tarball we just created for demonstration purposes, 
// but this could just as easily be a blob from a server, or a local file;
// as long as the content is a Uint8Array that implements the tar format correctly.
const entries = Tarball.extract(createdTarballBuffer);
const [mainFile] = entries;

console.log(mainFile.fileName); // 'Test File.txt'
console.log(mainFile.content); // Uint8Array object
console.log(mainFile.getContentAsText()); // 'This is a test file'

import {Tarball, AsyncUint8Array} from '@obsidize/tar-browserify';

// Generalized wrapper for loading data in chunks.
// The caller must wrap whatever external storage they are using with this.
const asyncBuffer: AsyncUint8Array = {
	
	// fetch tarball file length from storage
	byteLength: async () => ... /* Promise<number> */
	
	// read tarball data from storage
	// allows us to read the file in chunks rather than all at once
	read: async (offset: number, length: number) => ... /* Promise<Uint8Array> */
};

// Option 1 - extractAsync()
// Preferred for files with few entries
const entriesFromBigFile = await Tarball.extractAsync(asyncBuffer);

// IMPORTANT - async entries do not load file content by default to conserve memory.
// The caller must read file contents from an async entry like so:
const [firstEntry] = entriesFromBigFile;
const firstEntryContent = await firstEntry.readContentFrom(asyncBuffer);

// Option 2 - streamAsync()
// Preferred for files with many entries
await Tarball.streamAsync(asyncBuffer, async (entry, _entryIndex, buffer) => {
	if (entry.isFile()) {
		const content = await entry.readContentFrom(buffer);
		console.log(`got file data from ${entry.fileName} (${content.byteLength} bytes)`);
		// TODO: do some stuff with the content
	}
});