ResourceListForClient

Hierarchy

• ResourceList<IDetailedResourceItemForClient>
  • ResourceListForClient

Index

Constructors

• constructor

Properties

• filesById
• filesByLabel
• groupsById
• groupsByLabel
• items
• itemsById
• itemsByLabel
• rawResourceList
• resourceFiles
• resourceGroups

Methods

• add
• getResourceById
• getResourceByLabel
• getResourceByQuery
• getResourceByResourceDescription
• getResourceByUrlMap
• remove

Constructors

constructor

• new ResourceListForClient(rawResourceList: IResourceItemForClient[], trustedUploaders: string[], core: EpisodeCore<IDefaultAdditionalEnvVariable>, enableGlobalCache?: boolean): ResourceListForClient

• Overrides ResourceList.constructor

  ResourceListForClient will handle resource query related tasks, such as query file by label or ID, query file by URL set and file description.

  This class will also handle resource fallback from different CDN and resource convert related task.

  ---

  Parameters

  • rawResourceList: IResourceItemForClient[]

    Resource list generated by Studio.

  • trustedUploaders: string[]

  • core: EpisodeCore<IDefaultAdditionalEnvVariable>

    Core instance.

  • enableGlobalCache: boolean = true

    Cache resource URL that don’t have a episode across core instances to boost preload performance.

  Returns ResourceListForClient

Properties

readonlyfilesById

filesById: Map<string, IResourceFile | IResourceFileForClient> = ...

Inherited from ResourceList.filesById

readonlyfilesByLabel

filesByLabel: Map<string, IResourceFile | IResourceFileForClient> = ...

Inherited from ResourceList.filesByLabel

readonlygroupsById

groupsById: Map<string, IResourceGroup | IResourceGroupForClient> = ...

Inherited from ResourceList.groupsById

readonlygroupsByLabel

groupsByLabel: Map<string, IResourceGroup | IResourceGroupForClient> = ...

Inherited from ResourceList.groupsByLabel

readonlyitems

items: Set<IDetailedResourceItemForClient> = ...

Inherited from ResourceList.items

readonlyitemsById

itemsById: Map<string, IDetailedResourceItemForClient> = ...

Inherited from ResourceList.itemsById

readonlyitemsByLabel

itemsByLabel: Map<string, IDetailedResourceItemForClient> = ...

Inherited from ResourceList.itemsByLabel

publicreadonlyrawResourceList

rawResourceList: IResourceItemForClient[]

readonlyresourceFiles

resourceFiles: Set<IResourceFile | IResourceFileForClient> = ...

Inherited from ResourceList.resourceFiles

readonlyresourceGroups

resourceGroups: Set<IResourceGroup | IResourceGroupForClient> = ...

Inherited from ResourceList.resourceGroups

Methods

add

• add(x: T, sync?: boolean): void

• Inherited from ResourceList.add

  Parameters

  • x: T

  • sync: boolean = true

  Returns void

getResourceById

• getResourceById<Result, PostProcess>(id: string, envConfig?: Record<string, string>, weights?: Record<string, number>, postProcess?: PostProcess, resourceType?: group | file, useSlowQueue?: boolean, taskId?: string): Promise<PostProcess extends Metadata ? IDetailedResourceItemForClient : Result>

• Get resource by resource ID.

  ---

  Type parameters

  • Result = string
  • PostProcess: PostProcessCallback<Result, IResourceFileForClient> | PostProcessMagicWords = Url

  Parameters

  • id: string

    The ID for the resource.

  • envConfig: Record<string, string> = null

    Environment variable, this value will be used if the resource is a group, smart-resource will pick one file from the group by the configuration.

  • optionalweights: Record<string, number>

    Weight of each configuration.

  • optionalpostProcess: PostProcess

    Post process function, will convert the resource URL to whatever you want. If the callback is not provided, this method will return a URL, otherwise it will return the result of the callback.

  • optionalresourceType: group | file

    The resource is a group or file, if not provided, a guessing strategy will be used.

  • useSlowQueue: boolean = false

  • taskId: string = ...

    Task ID for debug purpose, will only be shown in the debug log.

  Returns Promise<PostProcess extends Metadata ? IDetailedResourceItemForClient : Result>

  A promise that resolves to the resource URL or post processed resource.

getResourceByLabel

• getResourceByLabel<Result, PostProcess>(label: string, envConfig?: Record<string, string>, weights?: Record<string, number>, postProcess?: PostProcess, resourceType?: group | file, useSlowQueue?: boolean, taskId?: string): Promise<PostProcess extends Metadata ? IDetailedResourceItemForClient : Result>

• Get resource by resource label.

  ---

  Type parameters

  • Result = string
  • PostProcess: PostProcessMagicWords | PostProcessCallback<Result, IResourceFileForClient> = Url

  Parameters

  • label: string

    The label for the resource.

  • envConfig: Record<string, string> = null

    Environment variable, this value will be used if the resource is a group, smart-resource will pick one file from the group by the configuration.

  • optionalweights: Record<string, number>

    Weight of each configuration.

  • optionalpostProcess: PostProcess

    Post process function, will convert the resource URL to whatever you want. If the callback is not provided, this method will return a URL, otherwise it will return the result of the callback.

  • optionalresourceType: group | file

    The resource is a group or file, if not provided, a guessing strategy will be used.

  • useSlowQueue: boolean = false

  • taskId: string = ...

    Task ID for debug purpose, will only be shown in the debug log.

  Returns Promise<PostProcess extends Metadata ? IDetailedResourceItemForClient : Result>

  A promise that resolves to the resource URL or post processed resource.

getResourceByQuery

• getResourceByQuery<Result, PostProcess>(query: string, queryType: id | label, envConfig?: Record<string, string>, weights?: Record<string, number>, postProcess?: PostProcess, resourceType?: group | file, useSlowQueue?: boolean, taskId?: string): Promise<PostProcess extends Metadata ? IDetailedResourceItemForClient : Result>

• Get resource by resource query.

  ---

  Type parameters

  • Result = string
  • PostProcess: PostProcessMagicWords | PostProcessCallback<Result, IResourceFileForClient> = Url

  Parameters

  • query: string

  • queryType: id | label

  • envConfig: Record<string, string> = null

    Environment variable, this value will be used if the resource is a group, smart-resource will pick one file from the group by the configuration.

  • optionalweights: Record<string, number>

    Weight of each configuration.

  • optionalpostProcess: PostProcess

    Post process function, will convert the resource URL to whatever you want. If the callback is not provided, this method will return a URL, otherwise it will return the result of the callback.

  • optionalresourceType: group | file

    The resource is a group or file, if not provided, a guessing strategy will be used.

  • useSlowQueue: boolean = false

  • taskId: string = ...

    Task ID for debug purpose, will only be shown in the debug log.

  Returns Promise<PostProcess extends Metadata ? IDetailedResourceItemForClient : Result>

  A promise that resolves to the resource URL or post processed resource.

getResourceByResourceDescription

• getResourceByResourceDescription<Result, PostProcess>(resource: IDetailedResourceItemForClient, envConfig?: Record<string, string>, weights?: Record<string, number>, postProcess?: PostProcess, useSlowQueue?: boolean, taskId?: string): Promise<PostProcess extends Metadata ? IDetailedResourceItemForClient : Result>

• Get resource by a resource description.

  ---

  Type parameters

  • Result = string
  • PostProcess: PostProcessMagicWords | PostProcessCallback<Result, IResourceFileForClient> = Url

  Parameters

  • resource: IDetailedResourceItemForClient

    The resource description generated by Studio.

  • envConfig: Record<string, string> = null

    Environment variable, this value will be used if the resource is a group, smart-resource will pick one file from the group by the configuration.

  • optionalweights: Record<string, number>

    Weight of each configuration.

  • optionalpostProcess: PostProcess

    Post process function, will convert the resource URL to whatever you want. If the callback is not provided, this method will return a URL, otherwise it will return the result of the callback.

  • useSlowQueue: boolean = false

  • taskId: string = 'client-query'

    Task ID for debug purpose, will only be shown in the debug log.

  Returns Promise<PostProcess extends Metadata ? IDetailedResourceItemForClient : Result>

  A promise that resolves to the resource URL or post processed resource.

getResourceByUrlMap

• getResourceByUrlMap<Result, PostProcess, AdditionalData>(urlMap: Record<string, string>, postProcess?: PostProcess, additionalData?: AdditionalData, taskId?: string, addToGlobalCache?: boolean, useSlowQueue?: boolean): Promise<Result>

• Get resource by a URL map.

  ---

  Type parameters

  • Result = string
  • PostProcess: PostProcessMagicWords | PostProcessCallback<Result, AdditionalData> = Url
  • AdditionalData = undefined

  Parameters

  • urlMap: Record<string, string>

    The key is the ID of the CDN or data source, the value is a URL.

  • optionalpostProcess: PostProcess

    Post process function, will convert the resource URL to whatever you want. If the callback is not provided, this method will return a URL, otherwise it will return the result of the callback.

  • optionaladditionalData: AdditionalData

  • taskId: string = 'client-side-selector-url-map'

    Task ID for debug purpose, will only be shown in the debug log.

  • addToGlobalCache: boolean = false

  • useSlowQueue: boolean = false

  Returns Promise<Result>

  A promise that resolves to the resource URL or post processed resource.

remove

• remove(x: T): void

• Inherited from ResourceList.remove

  Parameters

  • x: T

  Returns void