Class MLFile

Hierarchy

MLFile

Index

Constructors

Properties

#basename #code #dirname #stat #type

Accessors

dirname nDirname nPath path

Methods

_fetch _stat dirExists getCode isExist isFile matches setCode

Constructors

constructor

new MLFile(target: Target): MLFile
Parameters
- target: Target
Returns MLFile
- Defined in @markuplint/file-resolver/src/ml-file/ml-file.ts:21

Properties

`Private` #basename

#basename: string

`Private` #code

#code: null | string

`Private` #dirname

#dirname: string

`Private` #stat

#stat: undefined | null | Stats = undefined

Stats: Exists
null: Not exists
undefined: Doesn't read yet

`Private` #type

#type: "file-base" | "code-base"

Accessors

dirname

get dirname(): string
Returns string
- Defined in @markuplint/file-resolver/src/ml-file/ml-file.ts:40

nDirname

get nDirname(): string
Normalized MLFile.dirname

Returns string
- Defined in @markuplint/file-resolver/src/ml-file/ml-file.ts:47

nPath

get nPath(): string
Normalized MLFile.path

Returns string
- Defined in @markuplint/file-resolver/src/ml-file/ml-file.ts:54

path

get path(): string
Returns string
- Defined in @markuplint/file-resolver/src/ml-file/ml-file.ts:58

Methods

`Private` _fetch

_fetch(): Promise<string>
Returns Promise<string>
- Defined in @markuplint/file-resolver/src/ml-file/ml-file.ts:103

`Private` _stat

_stat(): Promise<null | Stats>
Returns Promise<null | Stats>
- Defined in @markuplint/file-resolver/src/ml-file/ml-file.ts:109

dirExists

dirExists(): Promise<boolean>
Returns Promise<boolean>
- Defined in @markuplint/file-resolver/src/ml-file/ml-file.ts:62

getCode

getCode(): Promise<string>
Returns Promise<string>
- Defined in @markuplint/file-resolver/src/ml-file/ml-file.ts:66

isExist

isExist(): Promise<boolean>
Returns Promise<boolean>
- Defined in @markuplint/file-resolver/src/ml-file/ml-file.ts:76

isFile

isFile(): Promise<boolean>
Returns Promise<boolean>
- Defined in @markuplint/file-resolver/src/ml-file/ml-file.ts:84

matches

matches(globPath: string): boolean
Parameters
- globPath: string
Returns boolean
- Defined in @markuplint/file-resolver/src/ml-file/ml-file.ts:92

setCode

setCode(code: string): void
Parameters
- code: string
Returns void
- Defined in @markuplint/file-resolver/src/ml-file/ml-file.ts:96

Generated using TypeDoc