ResourceExplorer class
提供对内容资源的标准访问权限的类。
构造函数
Resource |
初始化 ResourceExplorer 类的新实例。 |
Resource |
初始化 ResourceExplorer 类的新实例。 |
属性
changed | 更改资源时触发的事件。 |
resource |
获取资源提供程序。 |
resource |
获取由资源资源管理器管理的资源类型 ID 扩展。 |
方法
add |
添加文件夹资源。 |
add |
添加文件夹资源。 |
add |
将资源提供程序添加到资源资源管理器管理的资源。 |
add |
将资源类型添加到资源类型集。 |
build |
配置中给定$kind的生成类型。 |
get |
按 ID 获取资源。 |
get |
获取给定类型扩展的资源。 |
load |
从资源加载类型 |
load |
从资源加载类型 |
refresh() | 重新加载任何缓存的数据。 |
register |
向资源加载程序系统注册声明性类型。 |
构造函数详细信息
ResourceExplorer(ResourceExplorerOptions)
初始化 ResourceExplorer 类的新实例。
new ResourceExplorer(options?: ResourceExplorerOptions)
参数
- options
- ResourceExplorerOptions
配置选项。
ResourceExplorer(ResourceProvider[])
初始化 ResourceExplorer 类的新实例。
new ResourceExplorer(providers: ResourceProvider[])
参数
- providers
要初始化当前实例的 ResourceProvider 列表。
属性详细信息
changed
更改资源时触发的事件。
any changed
属性值
any
resourceProviders
resourceTypes
获取由资源资源管理器管理的资源类型 ID 扩展。
resourceTypes: Set<string>
属性值
Set<string>
方法详细信息
addFolder(string, boolean, boolean)
添加文件夹资源。
function addFolder(folder: string, includeSubFolders?: boolean, monitorChanges?: boolean): ResourceExplorer
参数
- folder
-
string
要作为资源包含的文件夹。
- includeSubFolders
-
boolean
是否包含子文件夹。
- monitorChanges
-
boolean
是否跟踪更改。
返回
资源资源管理器,以便可以在资源资源管理器上流畅地调用多个方法。
addFolders(string, string[], boolean)
添加文件夹资源。
function addFolders(folder: string, ignoreFolders?: string[], monitorChanges?: boolean): ResourceExplorer
参数
- folder
-
string
要作为资源包含的文件夹的集合。
- ignoreFolders
-
string[]
要忽略的 Imediate 子文件夹。
- monitorChanges
-
boolean
是否跟踪更改。
返回
资源资源管理器,以便可以在资源资源管理器上流畅地调用多个方法。
addResourceProvider(ResourceProvider)
将资源提供程序添加到资源资源管理器管理的资源。
function addResourceProvider(resourceProvider: ResourceProvider): ResourceExplorer
参数
- resourceProvider
- ResourceProvider
要添加的资源提供程序。
返回
资源资源管理器,以便可以在资源资源管理器上流畅地调用多个方法。
addResourceType(string)
将资源类型添加到资源类型集。
function addResourceType(type: string)
参数
- type
-
string
资源类型。
buildType<T, C>(string, C)
配置中给定$kind的生成类型。
function buildType<T, C>(kind: string, config: C): T
参数
- kind
-
string
$kind。
- config
-
C
源配置对象。
返回
T
实例化对象。
getResource(string)
按 ID 获取资源。
function getResource(id: string): Resource
参数
- id
-
string
资源 ID。
返回
如果未找到资源,则为未定义。
getResources(string)
获取给定类型扩展的资源。
function getResources(fileExtension: string): Resource[]
参数
- fileExtension
-
string
文件扩展名筛选器。
返回
Resource[]
资源。
loadType<T>(Resource)
loadType<T>(string)
从资源加载类型
function loadType<T>(resourceId: string): T
参数
- resourceId
-
string
要绑定到的资源 ID。
返回
T
从资源创建的类型
refresh()
重新加载任何缓存的数据。
function refresh()
registerType<T>(string, Newable<T>, CustomDeserializer<T, Record<string, unknown>>)
向资源加载程序系统注册声明性类型。
function registerType<T>(kind: string, type: Newable<T>, loader?: CustomDeserializer<T, Record<string, unknown>>): ResourceExplorer
参数
- kind
-
string
要映射到此类型的$kind名称。
- type
-
Newable<T>
要创建的对象的类型。
- loader
-
CustomDeserializer<T, Record<string, unknown>>
可选的自定义反序列化程序。
返回
用于 Fluent 样式多个调用的资源资源管理器。