Skip to content

feat: Add type declearations. #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
saul-jb wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: Add type declearations. #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions build/dev/untar.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
export interface ProgressivePromise<T, P> extends Promise<T> {
progress (cb: (arg: P) => void): this
}

export interface TarFile {
name: string
mode: string
uid: number
gid: number
size: number
mtime: number
checksum: number
type: string
linkname: string
ustarFormat: string
version?: string
uname?: string
gname?: string
devmajor?: number
devminor?: number
namePrefix?: string
buffer: ArrayBuffer
blob (): Blob
getBlobUrl (): URL
readAsString (): string
readAsJSON (): any
}

export default function untar(arrayBuffer: ArrayBuffer): ProgressivePromise<TarFile[], TarFile>
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"version": "2.0.0",
"description": "untar files in the browser",
"main": "build/dist/untar",
"types": "build/dev/untar.d.ts",
"directories": {
"test": "test"
},
Expand Down