Help us understand the problem. What is going on with this article?

js/tsでimg要素(HTMLImageElement)をloadしたらPromiseを返す拡張メソッド(モンキーパッチ)を実装する

TL;DR

monkey-patch.ts
interface HTMLImageElement {
  asyncLoad(): Promise<void>
}

// jsなら↓だけでおk
HTMLImageElement.prototype.asyncLoad = function() {
  if (this.complete) return Promise.resolve()

  return new Promise(resolve => {
    this.addEventListener("load", function callback() {
      resolve(this)
      this.removeEventListener("load", callback)
    })
  })
}

if (this.complete) return Promise.resolve()を記述しないと、読み込み済みの場合 Promise が解決されないので注意

概要

全ての img 要素が読み込み終わったら特定のアクションを実行するとか、new Image()したやつを読み込み終わるまで await したりなどでわざわざ関数書くのも面倒なんで、モンキーパッチと呼ばれるテクニックで HTMLImageElement に asyncLoad というメソッドを追加してみました。

Effective JavaScriptにやみくもなモンキーパッチは避けるべきと書いてあるので、業務で使用する場合は上の確認を取ってから実装するように!

使用例

import "./monkey-patch.ts"

/** img要素の全てが読み込まれた場合Promiseが解決される*/
const asyncLoadAllImages = async () => {
  const promises = Array.from(document.querySelectorAll("img"), el => el.asyncLoad())
  await Promise.all(promises)
}

/** 特定パスから画像を読み込まれた場合Promise<HTMLImageElement>が解決される */
const asyncGetImage = async (src: string) => {
  const image = new Image()
  image.src = src
  await image.asyncLoad()
  return image
}

余談

Promise を返却するような非同期関数の命名規則ってどうなっているんだろう。。

基本的に関数名先頭に async を付けてるけど正直コレジャナイ感がすごい。。

あと、「Promise が解決される」って言い方はMDNにそって言ってるけど、これも日本語的にすごく違和感...🤔

Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Comments
No comments
Sign up for free and join this conversation.
If you already have a Qiita account
Why do not you register as a user and use Qiita more conveniently?
You need to log in to use this function. Qiita can be used more conveniently after logging in.
You seem to be reading articles frequently this month. Qiita can be used more conveniently after logging in.
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
ユーザーは見つかりませんでした