PreviewAPI
Defined in: namespaces.ts:991
Methods
Section titled “Methods”registerProvider()
Section titled “registerProvider()”registerProvider(
options):Promise<void>
Defined in: namespaces.ts:993
Registers a file preview provider. CorePlugin-only in v1.
Parameters
Section titled “Parameters”options
Section titled “options”unknown
Returns
Section titled “Returns”Promise<void>
canPreview()
Section titled “canPreview()”canPreview(
filePath):Promise<boolean>
Defined in: namespaces.ts:995
Returns true if at least one registered provider can preview the given file.
Parameters
Section titled “Parameters”filePath
Section titled “filePath”string
Returns
Section titled “Returns”Promise<boolean>
showPreview()
Section titled “showPreview()”showPreview(
filePath):Promise<void>
Defined in: namespaces.ts:997
Opens the file preview panel for the given file.
Parameters
Section titled “Parameters”filePath
Section titled “filePath”string
Returns
Section titled “Returns”Promise<void>
getRegisteredTypes()
Section titled “getRegisteredTypes()”getRegisteredTypes():
Promise<string[]>
Defined in: namespaces.ts:999
Returns all file extensions that have at least one registered preview provider.
Returns
Section titled “Returns”Promise<string[]>