Freigeben über


ResourceExplorer class

Klasse, die Standardzugriff auf Inhaltsressourcen gewährt.

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 den vom Ressourcen-Explorer verwalteten Ressourcen einen Ressourcenanbieter hinzu.

addResourceType(string)

Fügen Sie einen Ressourcentyp zum Ressourcentypsatz hinzu.

buildType<T, C>(string, C)

Buildtyp für die angegebene $kind aus der Konfiguration.

getResource(string)

Ruft die Ressource nach ID ab.

getResources(string)

Ruft Ressourcen einer bestimmten Typerweiterung ab.

loadType<T>(Resource)

Laden des Typs aus einer Ressource

loadType<T>(string)

Laden des Typs aus einer Ressource

refresh()

Laden Sie alle zwischengespeicherten Daten neu.

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

Registrieren Sie einen deklarativen Typ beim 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 von ResourceProvider zum Initialisieren der aktuellen Instanz.

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.

monitorChanges

boolean

Gibt an, ob Änderungen nachverfolgt werden sollen.

Gibt zurück

Ressourcen-Explorer, damit Sie mehrere Methoden im Ressourcen-Explorer nahtlos 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[]

Ich vermittler Unterordner, die ignoriert werden sollen.

monitorChanges

boolean

Gibt an, ob Änderungen nachverfolgt werden sollen.

Gibt zurück

Ressourcen-Explorer, damit Sie mehrere Methoden im Ressourcen-Explorer nahtlos aufrufen können.

addResourceProvider(ResourceProvider)

Fügen Sie den vom Ressourcen-Explorer verwalteten Ressourcen einen Ressourcenanbieter hinzu.

function addResourceProvider(resourceProvider: ResourceProvider): ResourceExplorer

Parameter

resourceProvider
ResourceProvider

Hinzuzufügende Ressourcenanbieter.

Gibt zurück

Ressourcen-Explorer, damit Sie mehrere Methoden im Ressourcen-Explorer nahtlos aufrufen können.

addResourceType(string)

Fügen Sie einen Ressourcentyp zum Ressourcentypsatz hinzu.

function addResourceType(type: string)

Parameter

type

string

Der Ressourcentyp.

buildType<T, C>(string, C)

Buildtyp für die angegebene $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 die Ressource nach ID ab.

function getResource(id: string): Resource

Parameter

id

string

Ressourcen-ID.

Gibt zurück

Die Ressource oder undefiniert, wenn sie nicht gefunden wird.

getResources(string)

Ruft Ressourcen einer bestimmten Typerweiterung ab.

function getResources(fileExtension: string): Resource[]

Parameter

fileExtension

string

Dateierweiterungsfilter.

Gibt zurück

Die Ressourcen.

loadType<T>(Resource)

Laden des Typs aus einer Ressource

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

Parameter

resource
Resource

Ressourcen-ID, an die eine Bindung gebunden werden soll.

Gibt zurück

T

Typ, der aus ressource erstellt wurde.

loadType<T>(string)

Laden des Typs aus einer Ressource

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

Parameter

resourceId

string

Ressourcen-ID, an die eine Bindung gebunden werden soll.

Gibt zurück

T

Aus Ressource erstelltes 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 beim Ressourcenladeprogrammsystem.

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

Parameter

kind

string

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

type

Newable<T>

Typ des zu erstellenden Objekts.

loader

CustomDeserializer<T, Record<string, unknown>>

Optionaler benutzerdefinierter Deserialisierer.

Gibt zurück

Ressourcen-Explorer für fluent-Stil mehrerer Aufrufe.