ResourceExplorer class
Classe que fornece acesso padrão aos recursos de conteúdo.
Construtores
Resource |
Inicializa uma nova instância da classe |
Resource |
Inicializa uma nova instância da classe |
Propriedades
changed | Evento que é acionado quando um recurso é alterado. |
resource |
Obtém provedores de recursos. |
resource |
Obtém extensões de ID do tipo de recurso gerenciadas pelo Gerenciador de Recursos. |
Métodos
add |
Adicionar um recurso de pasta. |
add |
Adicionar recursos de pasta. |
add |
Adicione um provedor de recursos aos recursos gerenciados pelo Gerenciador de Recursos. |
add |
Adicione um tipo de recurso ao conjunto de tipos de recurso. |
build |
Tipo de build para determinado $kind da configuração. |
get |
Obtém o recurso por id. |
get |
Obtenha recursos de uma determinada extensão de tipo. |
load |
Tipo de carga do recurso |
load |
Tipo de carga do recurso |
refresh() | Recarregue todos os dados armazenados em cache. |
register |
Registre um tipo declarativo com o sistema de carregador de recursos. |
Detalhes do construtor
ResourceExplorer(ResourceExplorerOptions)
Inicializa uma nova instância da classe
new ResourceExplorer(options?: ResourceExplorerOptions)
Parâmetros
- options
- ResourceExplorerOptions
As opções de configuração.
ResourceExplorer(ResourceProvider[])
Inicializa uma nova instância da classe
new ResourceExplorer(providers: ResourceProvider[])
Parâmetros
- providers
A lista de ResourceProvider para inicializar a instância atual.
Detalhes da propriedade
changed
Evento que é acionado quando um recurso é alterado.
any changed
Valor da propriedade
any
resourceProviders
Obtém provedores de recursos.
resourceProviders: ResourceProvider[]
Valor da propriedade
resourceTypes
Obtém extensões de ID do tipo de recurso gerenciadas pelo Gerenciador de Recursos.
resourceTypes: Set<string>
Valor da propriedade
Set<string>
Detalhes do método
addFolder(string, boolean, boolean)
Adicionar um recurso de pasta.
function addFolder(folder: string, includeSubFolders?: boolean, monitorChanges?: boolean): ResourceExplorer
Parâmetros
- folder
-
string
Pasta a ser incluída como um recurso.
- includeSubFolders
-
boolean
Se deve incluir subpastas.
- monitorChanges
-
boolean
Se deseja controlar as alterações.
Retornos
Gerenciador de recursos para que você possa chamar fluentemente vários métodos no gerenciador de recursos.
addFolders(string, string[], boolean)
Adicionar recursos de pasta.
function addFolders(folder: string, ignoreFolders?: string[], monitorChanges?: boolean): ResourceExplorer
Parâmetros
- folder
-
string
Coleção de pastas a serem incluídas como recursos.
- ignoreFolders
-
string[]
Imediate subpastas a serem ignoradas.
- monitorChanges
-
boolean
Se deseja controlar as alterações.
Retornos
Gerenciador de recursos para que você possa chamar fluentemente vários métodos no gerenciador de recursos.
addResourceProvider(ResourceProvider)
Adicione um provedor de recursos aos recursos gerenciados pelo Gerenciador de Recursos.
function addResourceProvider(resourceProvider: ResourceProvider): ResourceExplorer
Parâmetros
- resourceProvider
- ResourceProvider
Provedor de recursos a ser adicionado.
Retornos
Gerenciador de recursos para que você possa chamar fluentemente vários métodos no gerenciador de recursos.
addResourceType(string)
Adicione um tipo de recurso ao conjunto de tipos de recurso.
function addResourceType(type: string)
Parâmetros
- type
-
string
Tipo de recurso.
buildType<T, C>(string, C)
Tipo de build para determinado $kind da configuração.
function buildType<T, C>(kind: string, config: C): T
Parâmetros
- kind
-
string
$kind.
- config
-
C
Objeto de configuração de origem.
Retornos
T
Objeto instanciado.
getResource(string)
Obtém o recurso por id.
function getResource(id: string): Resource
Parâmetros
- id
-
string
ID do recurso.
Retornos
O recurso ou indefinido se não for encontrado.
getResources(string)
Obtenha recursos de uma determinada extensão de tipo.
function getResources(fileExtension: string): Resource[]
Parâmetros
- fileExtension
-
string
Filtro de extensão de arquivo.
Retornos
Resource[]
Os recursos.
loadType<T>(Resource)
Tipo de carga do recurso
function loadType<T>(resource: Resource): T
Parâmetros
- resource
- Resource
ID de recurso à qual associar.
Retornos
T
Tipo criado a partir do recurso.
loadType<T>(string)
Tipo de carga do recurso
function loadType<T>(resourceId: string): T
Parâmetros
- resourceId
-
string
ID de recurso à qual associar.
Retornos
T
Tipo criado a partir do recurso
refresh()
Recarregue todos os dados armazenados em cache.
function refresh()
registerType<T>(string, Newable<T>, CustomDeserializer<T, Record<string, unknown>>)
Registre um tipo declarativo com o sistema de carregador de recursos.
function registerType<T>(kind: string, type: Newable<T>, loader?: CustomDeserializer<T, Record<string, unknown>>): ResourceExplorer
Parâmetros
- kind
-
string
O $kind nome a ser mapeado para esse tipo.
- type
-
Newable<T>
Tipo de objeto a ser criado.
- loader
-
CustomDeserializer<T, Record<string, unknown>>
Desserializador personalizado opcional.
Retornos
Gerenciador de recursos para várias chamadas de estilo fluente.