Options
All
  • Public
  • Public/Protected
  • All
Menu

Definition for the Item object that contains information of files used in this module

property

name - The filename of the file

property

path - The path of the file

property

title - The title of the file (no extension)

property

fullname - The fullname of the file (path & name)

property

[extension] - The extension of the file in lowercase

property

[isDirectory] - Always false in files

property

[data] - The content of the file in a base64 string by default

property

[stats] - The stats (information) of the file

property

[error] - If something goes wrong the error comes here

property

[deep] - The depth of current content

Hierarchy

Index

Properties

Optional custom

custom?: any

Custom key to add custom properties

Optional data

data?: string

The content of the file in a base64 string by default

Optional deep

deep?: number

The depth of current content

Optional error

error?: any

If something goes wrong the error comes here

Optional extension

extension?: string

The extension of the file with dot in lowercase

fullname

fullname: string

The fullname of the file (path & name & extension)

fullnameb

fullnameb: Buffer

The fullname of the file (path & name & extension buffer version)

Optional isDirectory

isDirectory?: boolean

True for directory, false for files

name

name: string

The filename of the file

nameb

nameb: Buffer

The filename of the file (buffer version)

path

path: string

The path of the file

pathb

pathb: Buffer

The path of the file (buffer version)

Optional stats

stats?: Stats

The stats (information) of the file

title

title: string

The title of the file (no extension)

Generated using TypeDoc