Class File

Hierarchy

File<Import | Require, Export>
- File

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new File(__namedParameters: object): File

Overrides File.constructor
- Defined in es/File.ts:22
Parameters
- __namedParameters: object
  - options: options
Returns File

Properties

Protected extension

extension: string

Protected options

options: ICompilerOptions

Protected root

root: Path

source

source: Path

Accessors

destination

get destination(): Path

Inherited from File.destination
- Defined in File.ts:68
Returns Path

isMapped

get isMapped(): Promise<boolean>

Inherited from File.isMapped
- Defined in File.ts:51
Returns Promise<boolean>

Methods

exports

exports(): AsyncIterableIterator<Export>

Overrides File.exports
- Defined in es/File.ts:78
Returns AsyncIterableIterator<Export>

imports

imports(): AsyncIterableIterator<Import | Require>

Overrides File.imports
- Defined in es/File.ts:60
Returns AsyncIterableIterator<Import | Require>

map

map(options: ICompilerOptions): AsyncIterableIterator<Import | Require | Export>

Inherited from File.map
- Defined in File.ts:87
Parameters
- options: ICompilerOptions
Returns AsyncIterableIterator<Import | Require | Export>

toString

toString(): string

Inherited from File.toString
- Defined in File.ts:102
Returns string

write

write(path?: PathLike | number, options?: object | string | null): Promise<void>

Overrides File.write
- Defined in es/File.ts:85
Parameters
- Optional path: PathLike | number
- Optional options: object | string | null
Returns Promise<void>