content-entry-filesystem

Content entries within the file system

Usage no npm install needed!

<script type="module">
  import contentEntryFilesystem from 'https://cdn.skypack.dev/content-entry-filesystem';
</script>

README

npm License minified size downloads GitHub Issues Build Status Styled with prettier Commitizen friendly Known Vulnerabilities Coverage Status

content-entry-filesystem

content entries for the file system

API

Table of Contents

FileSystemEntry

Extends StreamContentEntryMixin(ContentEntry)

A ContentEntry backed by a file.

Parameters

  • name string of the file
  • baseDir string directory the file is located in

Properties

  • name string of the file
  • baseDir string directory the file is located in

filename

Absolute file path.

Returns string

isExistent

Check for presence of the entry.

Returns Promise<boolean>

isEmpty

Check is entry represents an empty file.

Returns Promise<boolean>

readStream

Returns Readable

writeStream

Returns Writable

getReadStream

Parameters

  • options

Meta

  • deprecated: This is deprecated.

getWriteStream

Parameters

  • options

Meta

  • deprecated: This is deprecated.

install

With npm do:

npm install content-entry-filesystem

license

BSD-2-Clause