Type Alias StructuredWriter

type StructuredWriter = {
    get buffer(): Buffer;
    addToStore(
        contents: string | Readable | Buffer<ArrayBufferLike>,
        path: string,
    ): Promise<void>;
    finalize(): Promise<void>;
    getDestinationPath(): string | undefined;
}

Implemented by

Index

Accessors

Methods

addToStore finalize getDestinationPath

Accessors

buffer

get buffer(): Buffer
Returns Buffer
- Defined in src/util/structuredWriter.ts:22

Methods

addToStore

addToStore(
contents: string | Readable | Buffer<ArrayBufferLike>,
path: string,
): Promise<void>
Parameters
- contents: string | Readable | Buffer<ArrayBufferLike>
- path: string
Returns Promise<void>
- Defined in src/util/structuredWriter.ts:19

finalize

finalize(): Promise<void>
Returns Promise<void>
- Defined in src/util/structuredWriter.ts:20

getDestinationPath

getDestinationPath(): string | undefined
Returns string | undefined
- Defined in src/util/structuredWriter.ts:21