Class Writer

Writer is designed to write data into a given path in an asynchronous manner.

Constructors

constructor

Methods

close createWriteStream write

Constructors

constructor

Methods

close

  • close(): Promise<void>

  • Safety

    &mut self in async napi methods should be marked as unsafe

    Close this writer.

    Example

    const writer = await op.writer("path/to/file");
    await writer.write(Buffer.from("hello world"));
    await writer.close();

    Returns Promise<void>

createWriteStream

  • createWriteStream(options?): Writable

  • Create a writable stream from the underlying writer.

    Parameters

    • Optional options: WritableOptions

    Returns Writable

write

  • write(content): Promise<void>

  • Safety

    &mut self in async napi methods should be marked as unsafe

    Write bytes into this writer.

    Example

    const writer = await op.writer("path/to/file");
    await writer.write(Buffer.from("hello world"));
    await writer.close();

    Parameters

    • content: string | Buffer

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Copyright © 2022-2024, The Apache Software Foundation. Apache OpenDAL, OpenDAL, and Apache are either registered trademarks or trademarks of the Apache Software Foundation.