content-entry-filesystem

Content entries within the file system

API

Table of Contents

• FileSystemEntry
  • Parameters
  • baseDir
  • filename
  • isExistent
  • isEmpty
  • mode
  • size
  • atime
  • ctime
  • mtime
  • uid
  • gid
  • writeStream
  • toJSON

FileSystemEntry

Extends StreamContentEntry

A ContentEntry backed by a file.

Parameters

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

baseDir

Type: string

filename

Absolute file path.

Returns string

isExistent

Check for presence of the entry.

Returns (Promise<boolean> | boolean)

isEmpty

Check is entry represents an empty file.

Returns (Promise<boolean> | boolean)

mode

Returns (number | Promise<number>)

size

Returns (Promise<number> | number)

atime

Returns Promise<Date>

ctime

Returns Promise<Date>

mtime

Returns Promise<Date>

uid

Returns Promise<number>

gid

Returns Promise<number>

writeStream

Returns WritableStream

toJSON

Returns Object

install

With npm do:

```shell

npm install content-entry-filesystem ```

license

BSD-2-Clause