Crumbtrail
    Preparing search index...

    Interface IZStreamWrite

    An object that can write to a stream.

    interface IZStreamWrite {
        write(path: PathLike, options?: IZStreamWriteOptions): Promise<number>;
    }

    Implemented by

    Index

    Methods

    Methods

    • Writes to a given path.

      Parameters

      • path: PathLike

        The path to write to. If this points to a hierarchy, then all hierarchy nodes should be created.

      • Optionaloptions: IZStreamWriteOptions

        The options for the write.

      Returns Promise<number>

      The total number of bytes written, or 0 if buffer is falsy. If this is writing or creating directories, then 0 should be returned.

      If the path cannot be written to.