Class WorkspaceExtImpl

constructor

• new WorkspaceExtImpl(): WorkspaceExtImpl

  Returns WorkspaceExtImpl

ReadonlyonDidChangeWorkspaceFolders

ReadonlyonDidGrantWorkspaceTrust

name

• get name(): undefined | string

  Returns undefined | string

rootPath

• get rootPath(): undefined | string

  Returns undefined | string

trusted

• get trusted(): boolean

  Returns boolean

workspaceFile

• get workspaceFile(): undefined | Uri

  Returns undefined | Uri

workspaceFolders

• get workspaceFolders(): undefined | WorkspaceFolder[]

  Returns undefined | WorkspaceFolder[]

$disposeCanonicalUriProvider

• $disposeCanonicalUriProvider(scheme: string): void

  Parameters

  • scheme: string

  Returns void

$onTextSearchResult

• $onTextSearchResult(
      searchRequestId: number,
      done: boolean,
      result?: SearchInWorkspaceResult,
  ): void

  Parameters

  • searchRequestId: number
  • done: boolean
  • Optionalresult: SearchInWorkspaceResult

  Returns void

$onWorkspaceFoldersChanged

• $onWorkspaceFoldersChanged(event: WorkspaceRootsChangeEvent): void

  Parameters

  • event: WorkspaceRootsChangeEvent

  Returns void

$onWorkspaceLocationChanged

• $onWorkspaceLocationChanged(stat: undefined | FileStat): void

  Parameters

  • stat: undefined | FileStat

  Returns void

$onWorkspaceTrustChanged

• $onWorkspaceTrustChanged(trust: undefined | boolean): void

  Parameters

  • trust: undefined | boolean

  Returns void

$provideCanonicalUri

• $provideCanonicalUri(
      uri: string,
      targetScheme: string,
      token: CancellationToken,
  ): Promise<undefined | string>

  Parameters

  • uri: string
  • targetScheme: string
  • token: CancellationToken

  Returns Promise<undefined | string>

$provideTextDocumentContent

• $provideTextDocumentContent(
      documentURI: string,
  ): Promise<undefined | null | string>

  Parameters

  • documentURI: string

  Returns Promise<undefined | null | string>

$registerEditSessionIdentityProvider

• $registerEditSessionIdentityProvider(
      scheme: string,
      provider: EditSessionIdentityProvider,
  ): Disposable

  Parameters

  • scheme: string
  • provider: EditSessionIdentityProvider

  Returns Disposable

  Stubbed

decode

• decode(
      content: Uint8Array,
      args?: { encoding?: string; uri?: Uri },
  ): Promise<string>

  Parameters

  • content: Uint8Array
  • Optionalargs: { encoding?: string; uri?: Uri }

  Returns Promise<string>

encode

• encode(
      content: string,
      args?: { encoding?: string; uri?: Uri },
  ): Promise<Uint8Array>

  Parameters

  • content: string
  • Optionalargs: { encoding?: string; uri?: Uri }

  Returns Promise<Uint8Array>

findFiles

• findFiles(
      include: GlobPattern,
      exclude?: null | GlobPattern,
      maxResults?: number,
      token?: CancellationToken,
  ): PromiseLike<URI[]>

  Parameters

  • include: GlobPattern
  • Optionalexclude: null | GlobPattern
  • OptionalmaxResults: number
  • token: CancellationToken = CancellationToken.None

  Returns PromiseLike<URI[]>

findTextInFiles

• findTextInFiles(
      query: TextSearchQuery,
      optionsOrCallback:
          | FindTextInFilesOptions
          | ((result: TextSearchResult) => void),
      callbackOrToken?: CancellationToken | ((result: TextSearchResult) => void),
      token?: CancellationToken,
  ): Promise<TextSearchComplete>

  Parameters

  • query: TextSearchQuery
  • optionsOrCallback: FindTextInFilesOptions | ((result: TextSearchResult) => void)
  • OptionalcallbackOrToken: CancellationToken | ((result: TextSearchResult) => void)
  • Optionaltoken: CancellationToken

  Returns Promise<TextSearchComplete>

getCanonicalUri

• getCanonicalUri(
      uri: Uri,
      options: CanonicalUriRequestOptions,
      token: CancellationToken,
  ): Promise<undefined | Uri>

  Parameters

  • uri: Uri
  • options: CanonicalUriRequestOptions
  • token: CancellationToken

  Returns Promise<undefined | Uri>

getRelativePath

• getRelativePath(
      pathOrUri: string | Uri,
      includeWorkspace?: boolean,
  ): undefined | string

  Parameters

  • pathOrUri: string | Uri
  • OptionalincludeWorkspace: boolean

  Returns undefined | string

getWorkspaceFolder

• getWorkspaceFolder(
      uri: Uri,
      resolveParent?: boolean,
  ): undefined | WorkspaceFolder

  Parameters

  • uri: Uri
  • OptionalresolveParent: boolean

  Returns undefined | WorkspaceFolder

initialize

• initialize(): void

  Returns void

pickWorkspaceFolder

• pickWorkspaceFolder(
      options?: WorkspaceFolderPickOptions,
  ): PromiseLike<undefined | WorkspaceFolder>

  Parameters

  • Optionaloptions: WorkspaceFolderPickOptions

  Returns PromiseLike<undefined | WorkspaceFolder>

registerCanonicalUriProvider

• registerCanonicalUriProvider(
      scheme: string,
      provider: CanonicalUriProvider,
  ): Disposable

  Parameters

  • scheme: string
  • provider: CanonicalUriProvider

  Returns Disposable

registerTextDocumentContentProvider

• registerTextDocumentContentProvider(
      scheme: string,
      provider: TextDocumentContentProvider,
  ): Disposable

  Parameters

  • scheme: string
  • provider: TextDocumentContentProvider

  Returns Disposable

requestWorkspaceTrust

• requestWorkspaceTrust(
      options?: WorkspaceTrustRequestOptions,
  ): Promise<undefined | boolean>

  Parameters

  • Optionaloptions: WorkspaceTrustRequestOptions

  Returns Promise<undefined | boolean>

resolveProxy

• resolveProxy(url: string): Promise<undefined | string>

  Parameters

  • url: string

  Returns Promise<undefined | string>

updateWorkspaceFolders

• updateWorkspaceFolders(
      start: number,
      deleteCount: number,
      ...workspaceFoldersToAdd: { name?: string; uri: Uri }[],
  ): boolean

  Parameters

  • start: number
  • deleteCount: number
  • ...workspaceFoldersToAdd: { name?: string; uri: Uri }[]

  Returns boolean