content-entry

content-entry

content entries for content containers (aka files)

API

Table of Contents

• CollectionEntryMixin
  • Parameters
• BaseEntry
  • Parameters
  • Properties
  • getTypes
  • unixMode
  • isEmpty
  • isDeleted
• BufferContentEntryMixin
  • Parameters
  • Properties
• BufferContentEntry
  • Parameters
• ContentEntry
  • equalsContent
    • Parameters
• DeletedContentEntry
  • isDeleted
• EmptyContentEntry
  • getBuffer
  • getReadStream
• ReadableStreamContentEntry
  • Parameters
  • Properties
• StreamContentEntryMixin
  • Parameters
• StringContentEntryMixin
  • Parameters
  • Properties
• StringContentEntry
  • Parameters
  • Properties

CollectionEntryMixin

Brings directory attributes to entries.

Parameters

• superclass

BaseEntry

Representation of one file or directory entry. All names are absolute (no leading '/') the group seperator is '/'.

Parameters

• name string name inside of the container

Properties

• name string name inside of the container

getTypes

Returns Array<string> UTI types

unixMode

Default unix mode for files

Returns number 0644

isEmpty

Returns boolean true if there is no content

isDeleted

Returns any true if we represent a deleted entry

BufferContentEntryMixin

Content entries where a Buffer is the primary data representation.

Parameters

• superclass

Properties

• buffer Buffer

BufferContentEntry

Extends BufferContentEntryMixin(ContentEntry)

Parameters

• name string
• buffer Buffer

ContentEntry

Extends BaseEntry

General content access entries.

equalsContent

Compare content against other entry.

Parameters

• other Entry

Returns boolean true if other has the same content (bitwise)

DeletedContentEntry

Extends EmptyContentEntry

Represents a deleted entry.

isDeleted

We are always deleted.

Returns boolean true

EmptyContentEntry

Extends ContentEntry

Represents a entry without content (content length = 0).

getBuffer

Returns Buffer zero length buffer

getReadStream

Returns Readable zero length stream.

ReadableStreamContentEntry

Extends StreamContentEntryMixin(ContentEntry)

Content entries where a readable stream is the primary data representation.

Parameters

• name string
• readStream ReadableStream

Properties

• name string
• readStream ReadableStream

StreamContentEntryMixin

Content entries where a stream is the primary data representation.

Parameters

• superclass

StringContentEntryMixin

Content entries where a string is the primary data representation.

Parameters

• superclass

Properties

• string string

StringContentEntry

Extends StringContentEntryMixin(ContentEntry)

Content entries where a string is the primary data representation.

Parameters

• name string
• value string

Properties

• name string
• string string

install

With npm do:

npm install content-entry

license

BSD-2-Clause