Freigeben über


ResourceExplorer class

Klasse, die Standardzugriff auf Inhaltsressourcen ermöglicht.

Konstruktoren

ResourceExplorer(ResourceExplorerOptions)

Initialisiert eine neue Instanz der ResourceExplorer Klasse.

ResourceExplorer(ResourceProvider[])

Initialisiert eine neue Instanz der ResourceExplorer Klasse.

Eigenschaften

changed

Ereignis, das ausgelöst wird, wenn eine Ressource geändert wird.

resourceProviders

Ruft Ressourcenanbieter ab.

resourceTypes

Ruft vom Ressourcen-Explorer verwaltete Ressourcentyp-ID-Erweiterungen ab.

Methoden

addFolder(string, boolean, boolean)

Fügen Sie eine Ordnerressource hinzu.

addFolders(string, string[], boolean)

Fügen Sie Ordnerressourcen hinzu.

addResourceProvider(ResourceProvider)

Fügen Sie einen Ressourcenanbieter zu den Ressourcen hinzu, die vom Ressourcen-Explorer verwaltet werden.

addResourceType(string)

Fügen Sie dem Ressourcentypsatz einen Ressourcentyp hinzu.

buildType<T, C>(string, C)

Buildtyp für bestimmte $kind aus der Konfiguration.

getResource(string)

Ruft ressource nach ID ab.

getResources(string)

Abrufen von Ressourcen einer bestimmten Typerweiterung.

loadType<T>(Resource)

Laden des Typs aus Ressource

loadType<T>(string)

Laden des Typs aus Ressource

refresh()

Laden Sie alle zwischengespeicherten Daten neu.

registerType<T>(string, Newable<T>, CustomDeserializer<T, Record<string, unknown>>)

Registrieren Sie einen deklarativen Typ mit dem Ressourcenladeprogrammsystem.

Details zum Konstruktor

ResourceExplorer(ResourceExplorerOptions)

Initialisiert eine neue Instanz der ResourceExplorer Klasse.

new ResourceExplorer(options?: ResourceExplorerOptions)

Parameter

options
ResourceExplorerOptions

Die Konfigurationsoptionen.

ResourceExplorer(ResourceProvider[])

Initialisiert eine neue Instanz der ResourceExplorer Klasse.

new ResourceExplorer(providers: ResourceProvider[])

Parameter

providers

ResourceProvider[]

Die Liste der ResourceProvider, um die aktuelle Instanz zu initialisieren.

Details zur Eigenschaft

changed

Ereignis, das ausgelöst wird, wenn eine Ressource geändert wird.

any changed

Eigenschaftswert

any

resourceProviders

Ruft Ressourcenanbieter ab.

resourceProviders: ResourceProvider[]

Eigenschaftswert

resourceTypes

Ruft vom Ressourcen-Explorer verwaltete Ressourcentyp-ID-Erweiterungen ab.

resourceTypes: Set<string>

Eigenschaftswert

Set<string>

Details zur Methode

addFolder(string, boolean, boolean)

Fügen Sie eine Ordnerressource hinzu.

function addFolder(folder: string, includeSubFolders?: boolean, monitorChanges?: boolean): ResourceExplorer

Parameter

folder

string

Ordner, der als Ressource eingeschlossen werden soll.

includeSubFolders

boolean

Gibt an, ob Unterordner eingeschlossen werden sollen.

monitorChanges

boolean

Gibt an, ob Änderungen nachverfolgt werden sollen.

Gibt zurück

Ressourcen-Explorer, sodass Sie mehrere Methoden im Ressourcen-Explorer fließend aufrufen können.

addFolders(string, string[], boolean)

Fügen Sie Ordnerressourcen hinzu.

function addFolders(folder: string, ignoreFolders?: string[], monitorChanges?: boolean): ResourceExplorer

Parameter

folder

string

Sammlung von Ordnern, die als Ressourcen eingeschlossen werden sollen.

ignoreFolders

string[]

Imediate Unterordner, die ignoriert werden sollen.

monitorChanges

boolean

Gibt an, ob Änderungen nachverfolgt werden sollen.

Gibt zurück

Ressourcen-Explorer, sodass Sie mehrere Methoden im Ressourcen-Explorer fließend aufrufen können.

addResourceProvider(ResourceProvider)

Fügen Sie einen Ressourcenanbieter zu den Ressourcen hinzu, die vom Ressourcen-Explorer verwaltet werden.

function addResourceProvider(resourceProvider: ResourceProvider): ResourceExplorer

Parameter

resourceProvider
ResourceProvider

Der hinzuzufügende Ressourcenanbieter.

Gibt zurück

Ressourcen-Explorer, sodass Sie mehrere Methoden im Ressourcen-Explorer fließend aufrufen können.

addResourceType(string)

Fügen Sie dem Ressourcentypsatz einen Ressourcentyp hinzu.

function addResourceType(type: string)

Parameter

type

string

Ressourcentyp.

buildType<T, C>(string, C)

Buildtyp für bestimmte $kind aus der Konfiguration.

function buildType<T, C>(kind: string, config: C): T

Parameter

kind

string

$kind.

config

C

Quellkonfigurationsobjekt.

Gibt zurück

T

Instanziiertes Objekt.

getResource(string)

Ruft ressource nach ID ab.

function getResource(id: string): Resource

Parameter

id

string

Ressourcen-ID.

Gibt zurück

Die Ressource oder nicht definiert, wenn sie nicht gefunden wurde.

getResources(string)

Abrufen von Ressourcen einer bestimmten Typerweiterung.

function getResources(fileExtension: string): Resource[]

Parameter

fileExtension

string

Dateierweiterungsfilter.

Gibt zurück

Die Ressourcen.

loadType<T>(Resource)

Laden des Typs aus Ressource

function loadType<T>(resource: Resource): T

Parameter

resource
Resource

Ressourcen-ID, an die eine Bindung erfolgen soll.

Gibt zurück

T

Typ, der aus Ressource erstellt wurde.

loadType<T>(string)

Laden des Typs aus Ressource

function loadType<T>(resourceId: string): T

Parameter

resourceId

string

Ressourcen-ID, an die eine Bindung erfolgen soll.

Gibt zurück

T

Aus Ressource erstellter Typ

refresh()

Laden Sie alle zwischengespeicherten Daten neu.

function refresh()

registerType<T>(string, Newable<T>, CustomDeserializer<T, Record<string, unknown>>)

Registrieren Sie einen deklarativen Typ mit dem Ressourcenladeprogrammsystem.

function registerType<T>(kind: string, type: Newable<T>, loader?: CustomDeserializer<T, Record<string, unknown>>): ResourceExplorer

Parameter

kind

string

Der $kind Name, der diesem Typ zugeordnet werden soll.

type

Newable<T>

Typ des zu erstellenden Objekts.

loader

CustomDeserializer<T, Record<string, unknown>>

Optionaler benutzerdefinierter Deserializer.

Gibt zurück

Ressourcen-Explorer für fluent-Stile für mehrere Anrufe.