@nextcloud/dialogs
    Preparing search index...

    Interface FileSystemWritableFileStream

    The FileSystemWritableFileStream interface of the File System API is a WritableStream object with additional convenience methods, which operates on a single file on disk. The interface is accessed through the FileSystemFileHandle.createWritable() method. Available only in secure contexts.

    MDN Reference

    interface FileSystemWritableFileStream {
        locked: boolean;
        abort(reason?: any): Promise<void>;
        close(): Promise<void>;
        getWriter(): WritableStreamDefaultWriter<any>;
        seek(position: number): Promise<void>;
        truncate(size: number): Promise<void>;
        write(data: FileSystemWriteChunkType): Promise<void>;
    }

    Hierarchy

    • WritableStream
      • FileSystemWritableFileStream
    Index

    Properties

    locked: boolean

    The locked read-only property of the WritableStream interface returns a boolean indicating whether the WritableStream is locked to a writer.

    MDN Reference

    Methods

    • The abort() method of the WritableStream interface aborts the stream, signaling that the producer can no longer successfully write to the stream and it is to be immediately moved to an error state, with any queued writes discarded.

      MDN Reference

      Parameters

      • Optionalreason: any

      Returns Promise<void>

    • The close() method of the WritableStream interface closes the associated stream. All chunks written before this method is called are sent before the returned promise is fulfilled.

      MDN Reference

      Returns Promise<void>

    • The getWriter() method of the WritableStream interface returns a new instance of WritableStreamDefaultWriter and locks the stream to that instance. While the stream is locked, no other writer can be acquired until this one is released.

      MDN Reference

      Returns WritableStreamDefaultWriter<any>

    • The seek() method of the FileSystemWritableFileStream interface updates the current file cursor offset to the position (in bytes) specified when calling the method.

      MDN Reference

      Parameters

      • position: number

      Returns Promise<void>

    • The truncate() method of the FileSystemWritableFileStream interface resizes the file associated with the stream to the specified size in bytes.

      MDN Reference

      Parameters

      • size: number

      Returns Promise<void>

    • The write() method of the FileSystemWritableFileStream interface writes content into the file the method is called on, at the current file cursor offset.

      MDN Reference

      Parameters

      Returns Promise<void>