ResourceExplorer class
Classe qui donne un accès standard aux ressources de contenu.
Constructeurs
Resource |
Initialise une nouvelle instance de la classe ResourceExplorer. |
Resource |
Initialise une nouvelle instance de la classe ResourceExplorer. |
Propriétés
changed | Événement qui se déclenche lorsqu’une ressource est modifiée. |
resource |
Obtient les fournisseurs de ressources. |
resource |
Obtient les extensions d’ID de type de ressource gérées par l’Explorateur de ressources. |
Méthodes
add |
Ajoutez une ressource de dossier. |
add |
Ajoutez des ressources de dossier. |
add |
Ajoutez un fournisseur de ressources aux ressources gérées par l’Explorateur de ressources. |
add |
Ajoutez un type de ressource au jeu de types de ressources. |
build |
Type de build pour les $kind donnés à partir de la configuration. |
get |
Obtient la ressource par ID. |
get |
Obtenir les ressources d’une extension de type donnée. |
load |
Type de chargement à partir de la ressource |
load |
Type de chargement à partir de la ressource |
refresh() | Rechargez toutes les données mises en cache. |
register |
Inscrivez un type déclaratif auprès du système du chargeur de ressources. |
Détails du constructeur
ResourceExplorer(ResourceExplorerOptions)
Initialise une nouvelle instance de la classe ResourceExplorer.
new ResourceExplorer(options?: ResourceExplorerOptions)
Paramètres
- options
- ResourceExplorerOptions
Options de configuration.
ResourceExplorer(ResourceProvider[])
Initialise une nouvelle instance de la classe ResourceExplorer.
new ResourceExplorer(providers: ResourceProvider[])
Paramètres
- providers
La liste des ResourceProvider pour initialiser l’instance actuelle.
Détails de la propriété
changed
Événement qui se déclenche lorsqu’une ressource est modifiée.
any changed
Valeur de propriété
any
resourceProviders
Obtient les fournisseurs de ressources.
resourceProviders: ResourceProvider[]
Valeur de propriété
resourceTypes
Obtient les extensions d’ID de type de ressource gérées par l’Explorateur de ressources.
resourceTypes: Set<string>
Valeur de propriété
Set<string>
Détails de la méthode
addFolder(string, boolean, boolean)
Ajoutez une ressource de dossier.
function addFolder(folder: string, includeSubFolders?: boolean, monitorChanges?: boolean): ResourceExplorer
Paramètres
- folder
-
string
Dossier à inclure en tant que ressource.
- includeSubFolders
-
boolean
Indique s’il faut inclure des sous-dossiers.
- monitorChanges
-
boolean
Indique s’il faut suivre les modifications.
Retours
Explorateur de ressources afin que vous puissiez appeler couramment plusieurs méthodes sur l’Explorateur de ressources.
addFolders(string, string[], boolean)
Ajoutez des ressources de dossier.
function addFolders(folder: string, ignoreFolders?: string[], monitorChanges?: boolean): ResourceExplorer
Paramètres
- folder
-
string
Collection de dossiers à inclure en tant que ressources.
- ignoreFolders
-
string[]
Sous-dossiers Imediate à ignorer.
- monitorChanges
-
boolean
Indique s’il faut suivre les modifications.
Retours
Explorateur de ressources afin que vous puissiez appeler couramment plusieurs méthodes sur l’Explorateur de ressources.
addResourceProvider(ResourceProvider)
Ajoutez un fournisseur de ressources aux ressources gérées par l’Explorateur de ressources.
function addResourceProvider(resourceProvider: ResourceProvider): ResourceExplorer
Paramètres
- resourceProvider
- ResourceProvider
Fournisseur de ressources à ajouter.
Retours
Explorateur de ressources afin que vous puissiez appeler couramment plusieurs méthodes sur l’Explorateur de ressources.
addResourceType(string)
Ajoutez un type de ressource au jeu de types de ressources.
function addResourceType(type: string)
Paramètres
- type
-
string
Type de ressource.
buildType<T, C>(string, C)
Type de build pour les $kind donnés à partir de la configuration.
function buildType<T, C>(kind: string, config: C): T
Paramètres
- kind
-
string
$kind.
- config
-
C
Objet de configuration source.
Retours
T
Objet instancié.
getResource(string)
Obtient la ressource par ID.
function getResource(id: string): Resource
Paramètres
- id
-
string
ID de ressource.
Retours
Ressource, ou non définie si elle est introuvable.
getResources(string)
Obtenir les ressources d’une extension de type donnée.
function getResources(fileExtension: string): Resource[]
Paramètres
- fileExtension
-
string
Filtre d’extension de fichier.
Retours
Resource[]
Ressources.
loadType<T>(Resource)
Type de chargement à partir de la ressource
function loadType<T>(resource: Resource): T
Paramètres
- resource
- Resource
ID de ressource à lier.
Retours
T
Type créé à partir de la ressource.
loadType<T>(string)
Type de chargement à partir de la ressource
function loadType<T>(resourceId: string): T
Paramètres
- resourceId
-
string
ID de ressource à lier.
Retours
T
Type créé à partir de la ressource
refresh()
Rechargez toutes les données mises en cache.
function refresh()
registerType<T>(string, Newable<T>, CustomDeserializer<T, Record<string, unknown>>)
Inscrivez un type déclaratif auprès du système du chargeur de ressources.
function registerType<T>(kind: string, type: Newable<T>, loader?: CustomDeserializer<T, Record<string, unknown>>): ResourceExplorer
Paramètres
- kind
-
string
Nom $kind à mapper à ce type.
- type
-
Newable<T>
Type d’objet à créer.
- loader
-
CustomDeserializer<T, Record<string, unknown>>
Désérialiseur personnalisé facultatif.
Retours
Explorateur de ressources pour le style Fluent plusieurs appels.