Interface FileMode

A FileMode represents a file's mode and permission bits. The bits have the same definition on all systems, so that information about files can be moved from one system to another portably. Not all bits apply to all systems. The only required bit is [ModeDir] for directories.

Hierarchy

fs.FileMode
- FileMode

Index

Methods

isDir isRegular perm string type

Methods

isDir

isDir(): boolean
IsDir reports whether m describes a directory. That is, it tests for the [ModeDir] bit being set in m.

Returns boolean
Inherited from FileMode.isDir
- Defined in types.d.ts:14940

isRegular

isRegular(): boolean
IsRegular reports whether m describes a regular file. That is, it tests that no mode type bits are set.

Returns boolean
Inherited from FileMode.isRegular
- Defined in types.d.ts:14947

perm

perm(): fs.FileMode
Perm returns the Unix permission bits in m (m & [ModePerm]).

Returns fs.FileMode
Inherited from FileMode.perm
- Defined in types.d.ts:14953

string

string(): string
Returns string
Inherited from FileMode.string
- Defined in types.d.ts:14933

type

type(): fs.FileMode
Type returns type bits in m (m & [ModeType]).

Returns fs.FileMode
Inherited from FileMode.type
- Defined in types.d.ts:14959

Generated using TypeDoc