URLResource¶

HTTPサーバなどで配信されるリソースを表現します。ベースとなるリソースがサブリソースを持つようなリソースを想定したクラスです。

例としてhtmlの場合について説明します。 htmlファイルは画像やcssなど様々なサブリソースを持つことができます。 htmlファイルをベースとなるリソースと呼び、それ以外のファイルをサブリソースと呼びます。サブリソースはベースとなるリソースからの相対パスで表現されることや、絶対パスで表現されることがあります。また、htmlファイルには、別のhtmlファイルへのリンクが記述されることがあり、別のhtmlファイルはさらに画像やcssなどのファイルを持ちます。このクラスは上記のような状況を表現することができます。 - load はベースとなるリソースの内容を読み込みます。 - loadSubResource は、ベースとなるリソースからの相対パスを指定してサブリソースの内容を読み込みます（絶対パスを指定すると指定したURLへ直接アクセスします）。 - resolveResource は、別のhtmlファイルへのリンクをたどるような状況を表現する場合に利用します。相対パスや絶対パスを指定すると、新たな Resource を得ることができます。

下記に使用例を示します。

// https://.../test.html を起点とするリソースを定義します。
const resource = new URLResource("https://.../test.html");
// test.html の内容を読み込みます。

const html = await resource.load({ type: Resource.ResourceType.TEXT });
// test.html と同一パスにある画像を読み込みます。

const image = await resource.loadSubResource("image.png",
  { type: Resource.ResourceType.IMAGE });

// test.html からの相対パス(sub) にある 別のhtml(other.html) を起点とするリソースを定義します。
const otherResource = resource.resolveResource("sub/other.html");

// other.htmlの内容を読み込みます。
const otherHtml = await otherResource.load({ type: Resource.ResourceType.TEXT });

// other.htmlと同一パスにあるの画像を読み込みます。
const otherImage = await otherResource.loadSubResource("image.png",
  { type: Resource.ResourceType.IMAGE });

Extends¶

Resource

Constructors¶

new URLResource()¶

new URLResource(url, options): URLResource

Parameters¶

Parameter	Type	Description
`url`	`string`
`options`	`Option`

Returns¶

URLResource

Overrides¶

Resource.constructor

Accessors¶

url¶

get url(): string

リソースのurl

Returns¶

string

Methods¶

cancel()¶

cancel(): void

リソースの読み込みをキャンセルします。

Returns¶

void

Overrides¶

Resource.cancel

load()¶

load(options): Promise<any>

このリソースを読み込みます。

Parameters¶

Parameter	Type	Description
`options`	`Option`

Returns¶

Promise<any>

Overrides¶

Resource.load

loadAsBinary()¶

loadAsBinary(options): Promise<ArrayBuffer>

バイナリリソースを読み込みます。

Parameters¶

Parameter	Type
`options`	`Option`

Returns¶

Promise<ArrayBuffer>

Inherited from¶

Resource.loadAsBinary

loadAsImage()¶

loadAsImage(options): Promise<HTMLImageElement>

イメージリソースを読み込みます。

Parameters¶

Parameter	Type
`options`	`Option`

Returns¶

Promise<HTMLImageElement>

Inherited from¶

Resource.loadAsImage

loadAsJson()¶

loadAsJson(options): Promise<object>

Jsonリソースを読み込みます。

Parameters¶

Parameter	Type
`options`	`Option`

Returns¶

Promise<object>

Inherited from¶

Resource.loadAsJson

loadAsText()¶

loadAsText(options): Promise<string>

テキストリソースを読み込みます。

Parameters¶

Parameter	Type
`options`	`Option`

Returns¶

Promise<string>

Inherited from¶

Resource.loadAsText

loadSubResource()¶

loadSubResource(subUrl, options): Promise<any>

サブリソースを読み込みます。

Parameters¶

Parameter	Type	Description
`subUrl`	`string`	URL
`options`	`Option`

Returns¶

Promise<any>

options.type に応じた型で返却されます。

Overrides¶

Resource.loadSubResource

loadSubResourceAsBinary()¶

loadSubResourceAsBinary(url, options): Promise<ArrayBuffer>

バイナリリソースを読み込みます。

Parameters¶

Parameter	Type
`url`	`string`
`options`	`Option`

Returns¶

Promise<ArrayBuffer>

Inherited from¶

Resource.loadSubResourceAsBinary

loadSubResourceAsImage()¶

loadSubResourceAsImage(url, options): Promise<HTMLImageElement>

イメージリソースを読み込みます。

Parameters¶

Parameter	Type
`url`	`string`
`options`	`Option`

Returns¶

Promise<HTMLImageElement>

Inherited from¶

Resource.loadSubResourceAsImage

loadSubResourceAsJson()¶

loadSubResourceAsJson(url, options): Promise<object>

Jsonリソースを読み込みます。

Parameters¶

Parameter	Type
`url`	`string`
`options`	`Option`

Returns¶

Promise<object>

Inherited from¶

Resource.loadSubResourceAsJson

loadSubResourceAsText()¶

loadSubResourceAsText(url, options): Promise<string>

テキストリソースを読み込みます。

Parameters¶

Parameter	Type
`url`	`string`
`options`	`Option`

Returns¶

Promise<string>

Inherited from¶

Resource.loadSubResourceAsText

loadSubResourceSupported()¶

loadSubResourceSupported(): boolean

このクラスでのデフォルト実装では、trueを返却します。

Returns¶

boolean

Overrides¶

Resource.loadSubResourceSupported

resolveResource()¶

resolveResource(sub_url): Resource

関連リソースを読み込みます。

Parameters¶

Parameter	Type	Description
`sub_url`	`string`

Returns¶

Resource

Overrides¶

Resource.resolveResource

resolveResourceSupported()¶

resolveResourceSupported(): boolean

関連リソースをサポートするかを返します。

Returns¶

boolean

Overrides¶

Resource.resolveResourceSupported

toString()¶

toString(): string

リソースのテキスト表現

Returns¶

string

Overrides¶

Resource.toString