IFileTreeHandle | react-aspen

Hierarchy

IFileTreeHandle

Index

Methods

closeDirectory

closeDirectory(path: string): void
closeDirectory(directory: Directory): void

- Defined in components/types.ts:80
Parameters
- path: string
Returns void
- Defined in components/types.ts:81
Parameters
- directory: Directory
Returns void

ensureVisible

ensureVisible(path: string, align: Align): Promise<void>
ensureVisible(fileEntry: FileEntry, align: Align): Promise<void>
ensureVisible(directory: Directory, align: Align): Promise<void>

- Defined in components/types.ts:108
Parameters
- path: string
- Optional align: Align
Returns Promise<void>
- Defined in components/types.ts:109
Parameters
- fileEntry: FileEntry
- Optional align: Align
Returns Promise<void>
- Defined in components/types.ts:110
Parameters
- directory: Directory
- Optional align: Align
Returns Promise<void>

getFileHandle

getFileHandle(path: string, expandTree: boolean): Promise<FileEntry | Directory>

- Defined in components/types.ts:118
Parameters
- path: string
- Optional expandTree: boolean
Returns Promise<FileEntry | Directory>

getModel

getModel(): TreeModel

- Defined in components/types.ts:123
Returns TreeModel

onDidChangeModel

onDidChangeModel(callback: function): IDisposable

- Defined in components/types.ts:126
Parameters
- callback: function
  - - (prevModel: TreeModel, newModel: TreeModel): void
    - Parameters
      - prevModel: TreeModel
      - newModel: TreeModel
      Returns void
Returns IDisposable

onDidUpdate

onDidUpdate(callback: function): IDisposable

- Defined in components/types.ts:129
Parameters
- callback: function
  - - (): void
    - Returns void
Returns IDisposable

onceDidChangeModel

onceDidChangeModel(callback: function): IDisposable

- Defined in components/types.ts:127
Parameters
- callback: function
  - - (prevModel: TreeModel, newModel: TreeModel): void
    - Parameters
      - prevModel: TreeModel
      - newModel: TreeModel
      Returns void
Returns IDisposable

onceDidUpdate

onceDidUpdate(callback: function): IDisposable

- Defined in components/types.ts:130
Parameters
- callback: function
  - - (): void
    - Returns void
Returns IDisposable

openDirectory

openDirectory(path: string): Promise<void>
openDirectory(directory: Directory): Promise<void>

- Defined in components/types.ts:74
Parameters
- path: string
Returns Promise<void>
- Defined in components/types.ts:75
Parameters
- directory: Directory
Returns Promise<void>

peekABoo

peekABoo(path: string, timeout: number): Promise<IDisposable>
peekABoo(fileEntry: FileEntry, timeout: number): Promise<IDisposable>
peekABoo(directory: Directory, timeout: number): Promise<IDisposable>
peekABoo(path: string, align: Align): Promise<IDisposable>
peekABoo(fileEntry: FileEntry, align: Align): Promise<IDisposable>
peekABoo(directory: Directory, align: Align): Promise<IDisposable>
peekABoo(path: string, timeout: number, align: Align): Promise<IDisposable>
peekABoo(fileEntry: FileEntry, timeout: number, align: Align): Promise<IDisposable>
peekABoo(directory: Directory, timeout: number, align: Align): Promise<IDisposable>

- Defined in components/types.ts:88
Parameters
- path: string
- Optional timeout: number
Returns Promise<IDisposable>
- Defined in components/types.ts:89
Parameters
- fileEntry: FileEntry
- Optional timeout: number
Returns Promise<IDisposable>
- Defined in components/types.ts:90
Parameters
- directory: Directory
- Optional timeout: number
Returns Promise<IDisposable>
- Defined in components/types.ts:92
Parameters
- path: string
- Optional align: Align
Returns Promise<IDisposable>
- Defined in components/types.ts:93
Parameters
- fileEntry: FileEntry
- Optional align: Align
Returns Promise<IDisposable>
- Defined in components/types.ts:94
Parameters
- directory: Directory
- Optional align: Align
Returns Promise<IDisposable>
- Defined in components/types.ts:96
Parameters
- path: string
- timeout: number
- Optional align: Align
Returns Promise<IDisposable>
- Defined in components/types.ts:97
Parameters
- fileEntry: FileEntry
- timeout: number
- Optional align: Align
Returns Promise<IDisposable>
- Defined in components/types.ts:98
Parameters
- directory: Directory
- timeout: number
- Optional align: Align
Returns Promise<IDisposable>

promptNewDirectory

promptNewDirectory(at: string): Promise<NewFilePromptHandle>
promptNewDirectory(at: Directory): Promise<NewFilePromptHandle>

- Defined in components/types.ts:57
Parameters
- at: string
Returns Promise<NewFilePromptHandle>
- Defined in components/types.ts:58
Parameters
- at: Directory
Returns Promise<NewFilePromptHandle>

promptNewFile

promptNewFile(at: string): Promise<NewFilePromptHandle>
promptNewFile(at: Directory): Promise<NewFilePromptHandle>

- Defined in components/types.ts:49
Parameters
- at: string
Returns Promise<NewFilePromptHandle>
- Defined in components/types.ts:50
Parameters
- at: Directory
Returns Promise<NewFilePromptHandle>

promptRename

promptRename(path: string): Promise<RenamePromptHandle>
promptRename(directory: Directory): Promise<RenamePromptHandle>
promptRename(fileEntry: FileEntry): Promise<RenamePromptHandle>

- Defined in components/types.ts:65
Parameters
- path: string
Returns Promise<RenamePromptHandle>
- Defined in components/types.ts:66
Parameters
- directory: Directory
Returns Promise<RenamePromptHandle>
- Defined in components/types.ts:67
Parameters
- fileEntry: FileEntry
Returns Promise<RenamePromptHandle>

Generated using TypeDoc

Hierarchy

Index

Methods

Methods

closeDirectory

Parameters

path: string

Returns void

Parameters

directory: Directory

Returns void

ensureVisible

Parameters

path: string

Optional align: Align

Returns Promise<void>

Parameters

fileEntry: FileEntry

Optional align: Align

Returns Promise<void>

Parameters

directory: Directory

Optional align: Align

Returns Promise<void>

getFileHandle

Parameters

path: string

Optional expandTree: boolean

Returns Promise<FileEntry | Directory>

getModel

Returns TreeModel

onDidChangeModel

Parameters

callback: function

Parameters

prevModel: TreeModel

newModel: TreeModel

Returns void

Returns IDisposable

onDidUpdate

Parameters

callback: function

Returns void

Returns IDisposable

onceDidChangeModel

Parameters

callback: function

Parameters

prevModel: TreeModel

newModel: TreeModel

Returns void

Returns IDisposable

onceDidUpdate

Parameters

callback: function

Returns void

Returns IDisposable

openDirectory

Parameters

path: string

Returns Promise<void>

Parameters

directory: Directory

Returns Promise<void>

peekABoo

Parameters

path: string

Optional timeout: number

Returns Promise<IDisposable>

Parameters

fileEntry: FileEntry

Optional timeout: number

Returns Promise<IDisposable>

Parameters

directory: Directory

Optional timeout: number

Returns Promise<IDisposable>

Parameters

path: string

Optional align: Align