ResourceExplorer class

Класс, предоставляющий стандартный доступ к ресурсам содержимого.

Конструкторы

ResourceExplorer(ResourceExplorerOptions)

Инициализирует новый экземпляр класса ResourceExplorer.

ResourceExplorer(ResourceProvider[])

Инициализирует новый экземпляр класса ResourceExplorer.

Свойства

changed

Событие, которое возникает при изменении ресурса.

resourceProviders

Возвращает поставщиков ресурсов.

resourceTypes

Возвращает расширения идентификаторов типов ресурсов, управляемые обозревателем ресурсов.

Методы

addFolder(string, boolean, boolean)

Добавьте ресурс папки.

addFolders(string, string[], boolean)

Добавление ресурсов папок.

addResourceProvider(ResourceProvider)

Добавьте поставщика ресурсов в ресурсы, управляемые обозревателем ресурсов.

addResourceType(string)

Добавьте тип ресурса в набор типов ресурсов.

buildType<T, C>(string, C)

Тип сборки для заданного $kind из конфигурации.

getResource(string)

Возвращает ресурс по идентификатору.

getResources(string)

Получение ресурсов заданного расширения типа.

loadType<T>(Resource)

Тип загрузки из ресурса

loadType<T>(string)

Тип загрузки из ресурса

refresh()

Перезагрузите все кэшированные данные.

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

Зарегистрируйте декларативный тип в системе загрузчика ресурсов.

Сведения о конструкторе

ResourceExplorer(ResourceExplorerOptions)

Инициализирует новый экземпляр класса ResourceExplorer.

new ResourceExplorer(options?: ResourceExplorerOptions)

Параметры

options
ResourceExplorerOptions

Параметры конфигурации.

ResourceExplorer(ResourceProvider[])

Инициализирует новый экземпляр класса ResourceExplorer.

new ResourceExplorer(providers: ResourceProvider[])

Параметры

providers

ResourceProvider[]

Список ResourceProvider для инициализации текущего экземпляра.

Сведения о свойстве

changed

Событие, которое возникает при изменении ресурса.

any changed

Значение свойства

any

resourceProviders

Возвращает поставщиков ресурсов.

resourceProviders: ResourceProvider[]

Значение свойства

resourceTypes

Возвращает расширения идентификаторов типов ресурсов, управляемые обозревателем ресурсов.

resourceTypes: Set<string>

Значение свойства

Set<string>

Сведения о методе

addFolder(string, boolean, boolean)

Добавьте ресурс папки.

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

Параметры

folder

string

Папка, включаемая в качестве ресурса.

includeSubFolders

boolean

Следует ли включать вложенные папки.

monitorChanges

boolean

Следует ли отслеживать изменения.

Возвращаемое значение

Обозреватель ресурсов позволяет легко вызывать несколько методов в обозревателе ресурсов.

addFolders(string, string[], boolean)

Добавление ресурсов папок.

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

Параметры

folder

string

Коллекция папок для включения в качестве ресурсов.

ignoreFolders

string[]

Пропускать вложенные папки Imediate.

monitorChanges

boolean

Следует ли отслеживать изменения.

Возвращаемое значение

Обозреватель ресурсов позволяет легко вызывать несколько методов в обозревателе ресурсов.

addResourceProvider(ResourceProvider)

Добавьте поставщика ресурсов в ресурсы, управляемые обозревателем ресурсов.

function addResourceProvider(resourceProvider: ResourceProvider): ResourceExplorer

Параметры

resourceProvider
ResourceProvider

Добавляемый поставщик ресурсов.

Возвращаемое значение

Обозреватель ресурсов позволяет легко вызывать несколько методов в обозревателе ресурсов.

addResourceType(string)

Добавьте тип ресурса в набор типов ресурсов.

function addResourceType(type: string)

Параметры

type

string

Тип ресурса.

buildType<T, C>(string, C)

Тип сборки для заданного $kind из конфигурации.

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

Параметры

kind

string

$kind.

config

C

Объект конфигурации источника.

Возвращаемое значение

T

Экземпляр объекта.

getResource(string)

Возвращает ресурс по идентификатору.

function getResource(id: string): Resource

Параметры

id

string

Идентификатор ресурса.

Возвращаемое значение

Ресурс или не определен, если он не найден.

getResources(string)

Получение ресурсов заданного расширения типа.

function getResources(fileExtension: string): Resource[]

Параметры

fileExtension

string

Фильтр расширения файла.

Возвращаемое значение

Ресурсы.

loadType<T>(Resource)

Тип загрузки из ресурса

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

Параметры

resource
Resource

Идентификатор ресурса для привязки.

Возвращаемое значение

T

Тип, созданный из ресурса.

loadType<T>(string)

Тип загрузки из ресурса

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

Параметры

resourceId

string

Идентификатор ресурса для привязки.

Возвращаемое значение

T

Тип, созданный из ресурса

refresh()

Перезагрузите все кэшированные данные.

function refresh()

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

Зарегистрируйте декларативный тип в системе загрузчика ресурсов.

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

Параметры

kind

string

Имя $kind для сопоставления с этим типом.

type

Newable<T>

Тип создаваемого объекта.

loader

CustomDeserializer<T, Record<string, unknown>>

Необязательный настраиваемый десериализатор.

Возвращаемое значение

Обозреватель ресурсов для беглого стиля нескольких вызовов.