Class Resource

资源实例, 负责模块资源的加载以及样式的启用/禁用

Param: 资源地址

Hierarchy (view full)

Constructors

constructor

Properties

afterApplyScript afterInit? appendedAsyncStyleElements? appliedScript initScriptElement? initTimeout metadata? rejectScript resolveScript resolvedUrlMap scriptElements scriptLoading? server status strategy styleElements styleLoading? styleMounted type url urlAdapter? asyncFilesMap initTimeout

Methods

applyScript applyStyle destroy init isESM preload prepareInit removeStyle resetStyleStatus resolveUrl setStatus setStyleStatus addHook clearHooks defineType removeHook runHook runHookSync setResourceData

Constructors

constructor

Properties

afterApplyScript

afterApplyScript: Promise<HTMLScriptElement[]>

应用脚本后的 Promise。

Optional afterInit

afterInit?: Promise<void>

初始化后的 Promise。

Optional appendedAsyncStyleElements

appendedAsyncStyleElements?: NodeListOf<Element>

Private appliedScript

appliedScript: boolean = false

Optional initScriptElement

initScriptElement?: HTMLScriptElement

initTimeout

initTimeout: number

初始化超时时间，单位毫秒。

Optional metadata

metadata?: ResourceMetadata

资源元数据。

Private rejectScript

rejectScript: ((error) => void)

Type declaration

    • (error): void

    • Parameters

      • error: Error

      Returns void

Private resolveScript

resolveScript: ((elements) => void)

Type declaration

    • (elements): void

    • Parameters

      • elements: HTMLScriptElement[]

      Returns void

Private resolvedUrlMap

resolvedUrlMap: Record<string, string> = {}

scriptElements

scriptElements: HTMLScriptElement[] = []

Private Optional scriptLoading

scriptLoading?: Promise<HTMLScriptElement[]>

server

server: string

status

status: ResourceStatus = ResourceStatus.Init

资源状态，默认为初始化状态。

strategy

strategy: ResourceLoadStrategy

资源加载策略，默认使用标签方式加载。

styleElements

styleElements: (HTMLLinkElement | HTMLStyleElement)[] = []

Private Optional styleLoading

styleLoading?: Promise<(HTMLLinkElement | HTMLStyleElement)[]>

styleMounted

styleMounted: boolean = false

标记样式是否已经挂载。

type

type: string

入口资源类型。

url

url: string = ''

资源实例索引, 也是资源的元数据的 URL 地址。

Optional urlAdapter

urlAdapter?: ((sourceUrl, resource) => string)

URL 适配器函数，可以根据资源和源 URL 自定义最终的 URL 地址。

Type declaration

    • (sourceUrl, resource): string

    • URL 适配器函数，可以根据资源和源 URL 自定义最终的 URL 地址。

      Parameters

      Returns string

Static Private asyncFilesMap

asyncFilesMap: {
    [key: string]: Resource | undefined;
} = {}

Type declaration

Static initTimeout

initTimeout: number = 10000

初始化超时的静态默认值，单位毫秒。

Methods

applyScript

  • applyScript(elementModifier?): Promise<HTMLScriptElement[]>

  • 加载模块的脚本资源

    Parameters

    Returns Promise<HTMLScriptElement[]>

applyStyle

  • applyStyle(elementModifier?): Promise<(HTMLLinkElement | HTMLStyleElement)[]>

  • 加载/启用模块的样式资源

    Parameters

    Returns Promise<(HTMLLinkElement | HTMLStyleElement)[]>

destroy

init

  • init(forceInit?): Promise<void>

  • 加载资源清单数据, 默认(forceInit = false)不重复执行

    Parameters

    • forceInit: boolean = false

    Returns Promise<void>

isESM

  • isESM(url): boolean

  • 判断制定 url 是否为 esm 模块

    Parameters

    • url: string

    Returns boolean

preload

  • preload(elementModifier?): void

  • 预加载资源

    Parameters

    Returns void

Private prepareInit

removeStyle

resetStyleStatus

  • resetStyleStatus(): void

  • 重置样式状态

    Returns void

resolveUrl

  • resolveUrl(url): string

  • 加载资源时转换资源地址

    Parameters

    • url: string

    Returns string

setStatus

  • setStatus(status): void

  • 设置Resource实例的状态, 同时触发Resource实例关联的所有JModule实例的状态改变

    Parameters

    Returns void

    Fires

    window#resource.[moduleKey].statusChange

setStyleStatus

  • setStyleStatus(status): void

  • 禁用/启用样式

    Parameters

    • status: "enabled" | "disabled"

    Returns void

Static addHook

Static clearHooks

Static defineType

  • defineType(type, typeHandler): void

  • 扩展入口资源类型

    Parameters

    • type: string
    • typeHandler: ((resource, defaultUrl) => Promise<string>)
        • (resource, defaultUrl): Promise<string>

        • Parameters

          Returns Promise<string>

    Returns void

Static removeHook

Static runHook

  • runHook(hookName, ...inputArgs): Promise<any[]>

  • 异步执行指定 hook

    Parameters

    • hookName: string
    • Rest ...inputArgs: any[]

    Returns Promise<any[]>

Static runHookSync

  • runHookSync(hookName, ...inputArgs): any[]

  • 同步执行指定 hook

    Parameters

    • hookName: string
    • Rest ...inputArgs: any[]

    Returns any[]

Static setResourceData

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc