@shanzhai/write-file-step

A Shanzhai step which writes to a binary or UTF-8 encoded text file, creating it if it does not exist, or replacing it if it does.

Usage no npm install needed!

<script type="module">
  import shanzhaiWriteFileStep from 'https://cdn.skypack.dev/@shanzhai/write-file-step';
</script>

README

@shanzhai/write-file-step Continuous Integration License FOSSA Status Renovate enabled npm npm type definitions

A Shanzhai step which writes to a binary or UTF-8 encoded text file, creating it if it does not exist, or replacing it if it does.

Usage

If within a trigger's event handler an instance of WriteFileStep similar to the following were to be returned:

new WriteFileStep(
  `A description of the operation being performed`,
  [`A`, `Path`, `To`, `A`, `File`, `To`, `Write`],
  new ConstantInput(`Example File Content`)
);

The file would be created with the given content (which could be a string, for a text file, or a Buffer, for a binary file).

If the file already existed, it would be overwritten.

If the file's parent directory did not exist, an error would be raised.

Dependencies

This package has no runtime dependencies.

Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

License

FOSSA Status