Skip to content

types: export Sink, Source and HeaderArgument #182

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
PE39806 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

types: export Sink, Source and HeaderArgument #182

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
18 changes: 16 additions & 2 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,11 @@ interface Header {

type HeaderArgument = Partial<Header> & Pick<Header, 'name'>

interface Sink extends Writable {}
interface Sink extends Writable {
// `pack.entry()` populates defaults before constructing the sink
header: HeaderArgument & Pick<Header, 'size' | 'type' | 'mode' | 'uid' | 'gid' | 'mtime'>
written: number
}

interface Pack extends Readable {
entry(header: HeaderArgument, callback?: (err?: Error | null) => void): Sink
Expand All @@ -57,4 +61,14 @@ interface Extract<M extends ExtractEvents = ExtractEvents>

declare function extract(opts?: WritableOptions): Extract

export { pack, type Header, type Pack, extract, type Extract, type ExtractEvents }
export {
pack,
type Header,
type HeaderArgument,
type Pack,
type Sink,
extract,
type Extract,
type ExtractEvents,
type Source
}