Options
All
  • Public
  • Public/Protected
  • All
Menu

Class File

表示一个文件。

Hierarchy

  • File

Index

Constructors

constructor

  • new File(path?: string, base?: string): File
  • 初始化新的文件。

    Parameters

    • Optional path: string

      文件的初始路径。

    • Optional base: string

      文件的基路径。

    Returns File

Properties

base

base: string

当前文件的目标基路径。

buildMode

buildMode: BuildMode = buildMode

当前文件的生成模式。

deps

deps: string[]

当前文件的依赖项。

errorCount

errorCount: number = 0

获取当前文件累积的错误数。

Optional initialPath

initialPath: string

获取当前文件的初始物理路径。如果当前文件是动态创建的则返回 undefined。

Optional name

name: string

当前文件的目标名称。名称是相对于基路径的相对路径,路径以 / 为分隔符。

refs

refs: string[]

当前文件的引用项。

Optional sourceMapData

sourceMapData: SourceMapData

当前文件的源映射数据。

warningCount

warningCount: number = 0

获取当前文件累积的警告数。

Accessors

buffer

  • get buffer(): Buffer
  • set buffer(value: Buffer): void

content

  • get content(): string
  • set content(value: string): void

data

  • get data(): string | Buffer
  • set data(value: string | Buffer): void

destBuffer

  • get destBuffer(): Buffer

destContent

  • get destContent(): string

destDir

  • get destDir(): string

destExt

  • get destExt(): string

destPath

  • get destPath(): string

dir

  • get dir(): string
  • set dir(value: string): void

encoding

  • get encoding(): string
  • set encoding(value: string): void

exists

  • get exists(): boolean

ext

  • get ext(): string
  • set ext(value: string): void

loaded

  • get loaded(): boolean

modified

  • get modified(): boolean

overwrite

  • get overwrite(): boolean
  • set overwrite(value: boolean): void

path

  • get path(): string
  • set path(value: string): void
  • 当前文件的绝对路径。如果未设置保存路径则返回 undefined。

    Returns string

  • 当前文件的绝对路径。如果未设置保存路径则返回 undefined。

    Parameters

    • value: string

    Returns void

sourceMap

  • get sourceMap(): boolean
  • set sourceMap(value: boolean): void

sourceMapBuilder

sourceMapDir

  • get sourceMapDir(): string
  • set sourceMapDir(value: string): void

sourceMapEmit

  • get sourceMapEmit(): boolean
  • set sourceMapEmit(value: boolean): void

sourceMapIncludeFile

  • get sourceMapIncludeFile(): boolean
  • set sourceMapIncludeFile(value: boolean): void

sourceMapIncludeNames

  • get sourceMapIncludeNames(): boolean
  • set sourceMapIncludeNames(value: boolean): void

sourceMapIncludeSourcesContent

  • get sourceMapIncludeSourcesContent(): boolean
  • set sourceMapIncludeSourcesContent(value: boolean): void

sourceMapInline

  • get sourceMapInline(): boolean
  • set sourceMapInline(value: boolean): void
  • 是否内联源映射到源文件。

    desc

    仅当 sourceMapEmit 为 true 时有效。

    Returns boolean

  • 是否内联源映射到源文件。

    Parameters

    • value: boolean

    Returns void

sourceMapObject

sourceMapPath

  • get sourceMapPath(): string
  • set sourceMapPath(value: string): void

sourceMapRoot

  • get sourceMapRoot(): string
  • set sourceMapRoot(value: string): void

sourceMapString

  • get sourceMapString(): string
  • set sourceMapString(value: string): void

sourceMapUrl

  • get sourceMapUrl(): string
  • set sourceMapUrl(value: string): void
  • 在源文件引用源映射的地址。

    desc

    仅当 sourceMapEmit 为 true 时有效。

    Returns string

  • 在源文件引用源映射的地址。

    Parameters

    • value: string

    Returns void

srcBuffer

  • get srcBuffer(): Buffer

srcContent

  • get srcContent(): string

srcDir

  • get srcDir(): string

srcExt

  • get srcExt(): string

srcPath

  • get srcPath(): string

stats

  • get stats(): Stats

Methods

applySourceMap

  • 合并指定的源映射。如果当前文件已经存在源映射则进行合并。

    Parameters

    Returns void

clone

createStream

createWriter

delete

  • delete(deleteDir?: boolean, callback?: function): void
  • 删除当前源文件。

    Parameters

    • Default value deleteDir: boolean = true

      是否删除空的父文件夹。

    • Optional callback: function

      异步操作完成后的回调函数。

        • (error: ErrnoException | null, file: File): void
        • Parameters

          • error: ErrnoException | null
          • file: File

          Returns void

    Returns void

dep

  • dep(path: string | string[], source?: LogEntry): void
  • 添加当前文件的依赖项。

    Parameters

    • path: string | string[]

      相关的路径。

    • Optional source: LogEntry

      当前依赖的来源。

    Returns void

error

  • error(data: string | Error | FileLogEntry, args?: object): void
  • 记录生成当前文件时出现的错误。

    Parameters

    • data: string | Error | FileLogEntry

      要记录的日志数据。

    • Optional args: object

      格式化参数。日志信息中 {x} 会被替换为 args.x 的值。

      • [key: string]: any

    Returns void

getSourceMap

indexToLocation

  • indexToLocation(index: number): Location
  • 计算指定索引对应的行列号。

    Parameters

    • index: number

      要检查的索引。

    Returns Location

    返回对应的行列号。

Protected inspect

  • inspect(): string

load

  • load(callback?: function): void
  • 载入当前文件内容。

    Parameters

    • Optional callback: function

      异步操作完成后的回调函数。

        • (error: ErrnoException | null, file: File): void
        • Parameters

          • error: ErrnoException | null
          • file: File

          Returns void

    Returns void

locationToIndex

  • locationToIndex(location: Location): number
  • 计算指定行列号对应的索引。

    Parameters

    • location: Location

      要检查的行列号。

    Returns number

    返回对应的索引。

log

  • 记录一条和当前文件相关的日志。

    Parameters

    • data: string | Error | FileLogEntry

      要记录的日志数据。

    • Optional args: object

      格式化参数。日志信息中 {x} 会被替换为 args.x 的值。

      • [key: string]: any
    • Default value level: LogLevel = LogLevel.log

      要记录的日志等级。

    Returns void

ref

  • ref(path: string | string[], source?: LogEntry): void
  • 添加当前文件的引用项。

    Parameters

    • path: string | string[]

      相关的路径。

    • Optional source: LogEntry

      当前引用的来源。

    Returns void

relative

  • relative(url: string | File): string
  • 获取在当前文件内引用指定地址或文件所使用的相对地址。

    Parameters

    • url: string | File

      要解析的地址或文件。

    Returns string

    返回解析好的相对地址。

resolve

  • resolve(url: string): string
  • 解析当前文件内的地址所表示的实际地址。

    Parameters

    • url: string

      要解析的地址。如 ../a.js?a=1

    Returns string

    返回解析好的绝对地址。

save

  • save(dir?: string, callback?: function): void
  • 保存当前文件到指定路径。

    Parameters

    • Optional dir: string

      要保存的目标文件夹路径。如果为空则保存到当前文件夹。

    • Optional callback: function

      异步操作完成后的回调函数。

        • (error: ErrnoException | null, file: File): void
        • Parameters

          • error: ErrnoException | null
          • file: File

          Returns void

    Returns void

test

  • 测试当前文件名是否匹配指定的匹配器。

    Parameters

    • matcher: Pattern

      要测试通配符、正则表达式、函数或以上的匹配器组成的数组。

    Returns boolean

    如果匹配则返回 true,否则返回 false。

toString

  • toString(): string

verbose

  • verbose(data: string | Error | FileLogEntry, args?: object): void
  • 记录生成当前文件时的详细信息。

    Parameters

    • data: string | Error | FileLogEntry

      要记录的日志数据。

    • Optional args: object

      格式化参数。日志信息中 {x} 会被替换为 args.x 的值。

      • [key: string]: any

    Returns void

warning

  • warning(data: string | Error | FileLogEntry, args?: object): void
  • 记录生成当前文件时出现的警告。

    Parameters

    • data: string | Error | FileLogEntry

      要记录的日志数据。

    • Optional args: object

      格式化参数。日志信息中 {x} 会被替换为 args.x 的值。

      • [key: string]: any

    Returns void

Generated using TypeDoc