file-output

Manage reading, writing, and updating files.

• file-output
  • ~FileOutput
    • new FileOutput(outputPath, options)
    • .update(builder) ⇒ Promise
    • .read() ⇒ Promise
    • .readStream() ⇒ ReadStream | PassThrough
    • .destroy(unlinkFile) ⇒ Promise

file-output~FileOutput

FileOutput class

Kind: inner class of file-output

• ~FileOutput
  • new FileOutput(outputPath, options)
  • .update(builder) ⇒ Promise
  • .read() ⇒ Promise
  • .readStream() ⇒ ReadStream | PassThrough
  • .destroy(unlinkFile) ⇒ Promise

new FileOutput(outputPath, options)

| Param | Type | Default | Description | | --- | --- | --- | --- | | outputPath | string | | Path to the file being written to and read from. | | options | object | | Options about the current file. | | options.fileDoesNotExist | boolean | false | Set to true for better performance when calling the destroy method if you know for sure the file doesn't exist. | | options.readExisting | boolean | true | Whether or not it's okay to read previous content of file. |

fileOutput.update(builder) ⇒ Promise

Asynchronously write to file.

Any of these methods are acceptable:

• Directly call with a string or Uint8Array or readable stream
• Function which returns a string or Uint8Array or readable stream
• Function which returns a promise resolving a string or Uint8Array
• Calling callback given to function
• Writing or piping to callback

Kind: instance method of FileOutput
Fulfil: void

| Param | Description | | --- | --- | | builder | Either a string, Uint8Array, promise, or function. See description. |

fileOutput.read() ⇒ Promise

Get a string promise of file contents.

Kind: instance method of FileOutput
Fulfil: string The contents of the file in utf8.

fileOutput.readStream() ⇒ ReadStream | PassThrough

Get a readable stream of file contents.

Kind: instance method of FileOutput

fileOutput.destroy(unlinkFile) ⇒ Promise

Cancel update and unlink the file if it exists.

Kind: instance method of FileOutput
Fulfil: void

| Param | Default | Description | | --- | --- | --- | | unlinkFile | true | Whether or not to unlink file if it exists. |