Class File

TypeScript resource. Basically a file that is located somewhere.

Export

Implements

Implements

Hierarchy

  • File

Implements

Constructors

constructor

Properties

declarations end exports filePath imports resources rootPath start usages

Accessors

identifier isWorkspaceFile nonLocalUsages parsedPath

Constructors

constructor

  • Parameters

    • filePath: string
    • rootPath: string
    • start: number
    • end: number

    Returns File

Properties

declarations

declarations: Declaration[] = []

List of declarations that are contained in this resource.

Memberof

Resource

end

end: number

The ending character of the node in the document.

Memberof

Node

exports

exports: Export[] = []

List of exports contained in this resource.

Memberof

Resource

filePath

filePath: string

imports

imports: Import[] = []

List of imports contained in this resource.

Memberof

Resource

resources

resources: Resource[] = []

List of subresources (like namespaces in a file) of this resource.

Memberof

Resource

Private rootPath

rootPath: string

start

start: number

The starting character of the node in the document.

Memberof

Node

usages

usages: string[] = []

List of used identifiers in this resource. (i.e. actual used string identifiers to calculate missing imports and stuff.)

Memberof

Resource

Accessors

identifier

  • get identifier(): string

  • "Unique" identifier for this resource. Can be the filepath for files or node identifiers for node modules.

    Memberof

    Resource

    Returns string

isWorkspaceFile

  • get isWorkspaceFile(): boolean

  • Determines if a file is a workspace file or an external resource.

    Memberof

    File

    Returns boolean

nonLocalUsages

  • get nonLocalUsages(): string[]

  • Returns an array of usages (a usage is a used symbol name in the resource) that are not covered by its own declarations.

    Memberof

    Resource

    Returns string[]

parsedPath

  • get parsedPath(): ParsedPath

  • Returns the parsed path of a resource.

    Memberof

    File

    Returns ParsedPath

Settings

Member Visibility

Theme

Generated using TypeDoc