ResourceExplorer class
Classe che consente l'accesso standard alle risorse del contenuto.
Costruttori
| Resource |
Inizializza una nuova istanza della classe |
| Resource |
Inizializza una nuova istanza della classe |
Proprietà
| changed | Evento che viene generato quando viene modificata una risorsa. |
| resource |
Ottiene i provider di risorse. |
| resource |
Ottiene le estensioni ID del tipo di risorsa gestite da Esplora risorse. |
Metodi
| add |
Aggiungere una risorsa di cartella. |
| add |
Aggiungere le risorse della cartella. |
| add |
Aggiungere un provider di risorse alle risorse gestite da Esplora risorse. |
| add |
Aggiungere un tipo di risorsa al set di tipi di risorsa. |
| build |
Tipo di compilazione per i $kind specificati dalla configurazione. |
| get |
Ottiene la risorsa in base all'ID. |
| get |
Ottenere le risorse di un'estensione di tipo specificato. |
| load |
Tipo di caricamento dalla risorsa |
| load |
Tipo di caricamento dalla risorsa |
| refresh() | Ricaricare i dati memorizzati nella cache. |
| register |
Registrare un tipo dichiarativo con il sistema di caricamento delle risorse. |
Dettagli costruttore
ResourceExplorer(ResourceExplorerOptions)
Inizializza una nuova istanza della classe
new ResourceExplorer(options?: ResourceExplorerOptions)
Parametri
- options
- ResourceExplorerOptions
Opzioni di configurazione.
ResourceExplorer(ResourceProvider[])
Inizializza una nuova istanza della classe
new ResourceExplorer(providers: ResourceProvider[])
Parametri
- providers
Elenco di ResourceProvider per inizializzare l'istanza corrente.
Dettagli proprietà
changed
Evento che viene generato quando viene modificata una risorsa.
any changed
Valore della proprietà
any
resourceProviders
Ottiene i provider di risorse.
resourceProviders: ResourceProvider[]
Valore della proprietà
resourceTypes
Ottiene le estensioni ID del tipo di risorsa gestite da Esplora risorse.
resourceTypes: Set<string>
Valore della proprietà
Set<string>
Dettagli metodo
addFolder(string, boolean, boolean)
Aggiungere una risorsa di cartella.
function addFolder(folder: string, includeSubFolders?: boolean, monitorChanges?: boolean): ResourceExplorer
Parametri
- folder
-
string
Cartella da includere come risorsa.
- includeSubFolders
-
boolean
Indica se includere sottocartelle.
- monitorChanges
-
boolean
Indica se tenere traccia delle modifiche.
Restituisce
Esplora risorse in modo che sia possibile chiamare in modo fluente più metodi in Esplora risorse.
addFolders(string, string[], boolean)
Aggiungere le risorse della cartella.
function addFolders(folder: string, ignoreFolders?: string[], monitorChanges?: boolean): ResourceExplorer
Parametri
- folder
-
string
Raccolta di cartelle da includere come risorse.
- ignoreFolders
-
string[]
Correggere le sottocartelle da ignorare.
- monitorChanges
-
boolean
Indica se tenere traccia delle modifiche.
Restituisce
Esplora risorse in modo che sia possibile chiamare in modo fluente più metodi in Esplora risorse.
addResourceProvider(ResourceProvider)
Aggiungere un provider di risorse alle risorse gestite da Esplora risorse.
function addResourceProvider(resourceProvider: ResourceProvider): ResourceExplorer
Parametri
- resourceProvider
- ResourceProvider
Provider di risorse da aggiungere.
Restituisce
Esplora risorse in modo che sia possibile chiamare in modo fluente più metodi in Esplora risorse.
addResourceType(string)
Aggiungere un tipo di risorsa al set di tipi di risorsa.
function addResourceType(type: string)
Parametri
- type
-
string
Tipo di risorsa.
buildType<T, C>(string, C)
Tipo di compilazione per i $kind specificati dalla configurazione.
function buildType<T, C>(kind: string, config: C): T
Parametri
- kind
-
string
$kind.
- config
-
C
Oggetto di configurazione di origine.
Restituisce
T
Oggetto di cui è stata creata un'istanza.
getResource(string)
Ottiene la risorsa in base all'ID.
function getResource(id: string): Resource
Parametri
- id
-
string
ID risorsa.
Restituisce
Risorsa o non definita se non trovata.
getResources(string)
Ottenere le risorse di un'estensione di tipo specificato.
function getResources(fileExtension: string): Resource[]
Parametri
- fileExtension
-
string
Filtro dell'estensione file.
Restituisce
Resource[]
Risorse.
loadType<T>(Resource)
Tipo di caricamento dalla risorsa
function loadType<T>(resource: Resource): T
Parametri
- resource
- Resource
ID risorsa a cui eseguire l'associazione.
Restituisce
T
Tipo creato dalla risorsa.
loadType<T>(string)
Tipo di caricamento dalla risorsa
function loadType<T>(resourceId: string): T
Parametri
- resourceId
-
string
ID risorsa a cui eseguire l'associazione.
Restituisce
T
Tipo creato dalla risorsa
refresh()
Ricaricare i dati memorizzati nella cache.
function refresh()
registerType<T>(string, Newable<T>, CustomDeserializer<T, Record<string, unknown>>)
Registrare un tipo dichiarativo con il sistema di caricamento delle risorse.
function registerType<T>(kind: string, type: Newable<T>, loader?: CustomDeserializer<T, Record<string, unknown>>): ResourceExplorer
Parametri
- kind
-
string
Nome $kind di cui eseguire il mapping a questo tipo.
- type
-
Newable<T>
Tipo di oggetto da creare.
- loader
-
CustomDeserializer<T, Record<string, unknown>>
Deserializzatore personalizzato facoltativo.
Restituisce
Esplora risorse per più chiamate in stile Fluent.